Skip to content

Commit

Permalink
Merge branch 'dev' into f/add-code-reading-instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
@creatorrr
creatorrr authored Oct 2, 2024
2 parents 4bb3e8c + 46ed8fa commit f12e9e7
Show file tree
Hide file tree
Showing 5 changed files with 287 additions and 111 deletions.
29 changes: 28 additions & 1 deletion README-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,30 @@
<a href="https://choosealicense.com/licenses/apache/"><img src="https://img.shields.io/github/license/julep-ai/julep" alt="GitHub 许可证"></a>
</p>

*****

## 🌟 诚邀贡献者！

我们很高兴欢迎新的贡献者加入 Julep 项目！我们创建了几个"适合新手的问题"来帮助您入门。以下是您可以贡献的方式：

1. 查看我们的 [CONTRIBUTING.md](CONTRIBUTING.md) 文件，了解如何贡献的指南。
2. 浏览我们的[适合新手的问题](https://github.com/julep-ai/julep/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)，找到一个您感兴趣的任务。
3. 如果您有任何问题或需要帮助，请随时在我们的 [Discord](https://discord.com/invite/JTSBGRZrzj) 频道上联系我们。

您的贡献，无论大小，对我们都很宝贵。让我们一起创造令人惊叹的东西吧！🚀

### 🎉 DevFest.AI 2024年10月

激动人心的消息！我们将在整个2024年10月参与 DevFest.AI 活动！🗓️

- 在此活动期间为 Julep 做出贡献，有机会赢得超棒的 Julep 周边和礼品！🎁
- 加入来自世界各地的开发者，为 AI 仓库做出贡献并参与精彩的活动。
- 非常感谢 DevFest.AI 组织这个fantastic的活动！

> [!TIP]
> 准备好加入这场盛会了吗？**[发推文开始参与](https://twitter.com/intent/tweet?text=Pumped%20to%20be%20participating%20in%20%40devfestai%20with%20%40julep_ai%20building%20%23ai%20%23agents%20%23workflows%20Let's%20gooo!%20https%3A%2F%2Fgit.new%2Fjulep)**，让我们开始编码吧！🖥️
![Julep DevFest.AI](https://media.giphy.com/media/YjyUeyotft6epaMHtU/giphy.gif)

*****

Expand All @@ -50,6 +74,9 @@
请继续关注我们即将发布的稳定版本的更多更新！📢


*****

## 简介

Julep 是一个开源平台，用于创建具有可定制工作流的持久 AI 代理。它提供了开发、管理和部署 AI 驱动应用程序的工具，注重灵活性和易用性。
Expand Down Expand Up @@ -634,4 +661,4 @@ results = client.documents.search(

## 致谢

我们要感谢所有贡献者和开源社区为他们宝贵的资源和贡献。
我们要感谢所有贡献者和开源社区为他们宝贵的资源和贡献。
124 changes: 26 additions & 98 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,104 +7,6 @@
The **Quick Start Guide Focused README** is the most promising for optimizing the time to first workflow. It allows developers to get hands-on experience quickly, which is essential for engagement and understanding.
* * *
**Outline for the README:**
1. **Title and Badges**
* Julep Logo or Title
* Build status, npm version, license badges
2. **Introduction**
* _Briefly explain what Julep is and its purpose._
* Emphasize how it simplifies building persistent AI agents with workflows.
3. **Features**
* _Highlight key features with a focus on "tasks" (AI workflows)._
* Mention support for persistent sessions, tool integration, and document management.
4. **Installation**
* _Provide npm installation command:_
bash
Copy code
`npm install julep`
5. **Quick Start Guide**
* **Step 1: Import Julep**
* _Show how to import Julep into a project._
javascript
Copy code
`const Julep = require('julep');`
* **Step 2: Initialize the Agent**
* _Guide on creating a new agent with basic settings._
javascript
Copy code
`const agent = new Julep.Agent({  name: 'MyAgent',  model: 'gpt-4-turbo', });`
* **Step 3: Chat with the Agent**
* _Provide a simple example of a chat with the agent._
javascript
Copy code
`const response = await client.sessions.chat({  session_id: session.id,  message: 'Hello, how are you?' });`
* **Step 4: Define a Task (Workflow)**
* _Provide a simple example of a task definition._
javascript
Copy code
`const task = {  name: 'GreetingTask',  main: [    {      prompt: 'Say hello to the user.',    },  ], }; agent.addTask(task);`
* **Step 5: Execute the Task**
* _Show how to run the task and handle the output._
javascript
Copy code
`agent.executeTask('GreetingTask').then((output) => {  console.log(output); });`
6. **Understanding Tasks**
* _Explain what tasks are and how they function within Julep._
* Describe different types of workflow steps.
* Prompt, Tool Call, Evaluate, etc.
* _Note:_ Link to detailed documentation for each step type.
7. **Advanced Features**
* _Briefly mention other capabilities:_
* Adding tools to agents.
* Managing sessions and users.
* Document integration and search.
8. **API Reference**
* _Link to full API documentation._
* Mention key endpoints for agents, tasks, and executions.
9. **Examples and Tutorials**
* _Provide links to example projects or further tutorials._
* Encourage users to explore and build upon provided examples.
10. **Contributing**
* _Instructions for contributing to the project._
* Link to contribution guidelines and code of conduct.
11. **Support and Community**
* _Information on how to get help._
* Links to community forums, chat groups, or issue trackers.
12. **License**
* _State the project's license._
* Provide a link to the LICENSE file.
13. **Acknowledgements**
* _Credit to contributors and used resources._
* * *
**Notes:**
* **Code Examples:** Ensure all code snippets are easy to understand and copy-paste ready.
Expand Down Expand Up @@ -144,6 +46,31 @@ The **Quick Start Guide Focused README** is the most promising for optimizing th

*****

## 🌟 Call for Contributors!

We're excited to welcome new contributors to the Julep project! We've created several "good first issues" to help you get started. Here's how you can contribute:

1. Check out our [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute.
2. Browse our [good first issues](https://github.com/julep-ai/julep/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to find a task that interests you.
3. If you have any questions or need help, don't hesitate to reach out on our [Discord](https://discord.com/invite/JTSBGRZrzj) channel.

Your contributions, big or small, are valuable to us. Let's build something amazing together! 🚀

### 🎉 DevFest.AI October 2024

Exciting news! We're participating in DevFest.AI throughout October 2024! 🗓️

- Contribute to Julep during this event and get a chance to win awesome Julep merch and swag! 🎁
- Join developers from around the world in contributing to AI repositories and participating in amazing events.
- A big thank you to DevFest.AI for organizing this fantastic initiative!

> [!TIP]
> Ready to join the fun? **[Tweet to start participating](https://twitter.com/intent/tweet?text=Pumped%20to%20be%20participating%20in%20%40devfestai%20with%20%40julep_ai%20building%20%23ai%20%23agents%20%23workflows%20Let's%20gooo!%20https%3A%2F%2Fgit.new%2Fjulep)** and let's get coding! 🖥️
![Julep DevFest.AI](https://media.giphy.com/media/YjyUeyotft6epaMHtU/giphy.gif)

*****

## 🎉🚀 **Exciting News: Julep 1.0 Alpha Release!** 🚀🎉

We're thrilled to announce the **alpha** release of <u>Julep 1.0</u>! 🥳
Expand All @@ -165,6 +92,7 @@ We're thrilled to announce the **alpha** release of <u>Julep 1.0</u>! 🥳
Stay tuned for more updates as we approach our stable release! 📢

*****

## Introduction

Expand Down
26 changes: 16 additions & 10 deletions agents-api/agents_api/autogen/Tasks.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ class CaseThen(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
| ReturnStep
| SleepStep
| ErrorWorkflowStep
| YieldStep
| WaitForInputStep
)
"""
Expand All @@ -63,10 +63,10 @@ class CaseThenUpdateItem(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
| ReturnStep
| SleepStep
| ErrorWorkflowStep
| YieldStep
| WaitForInputStep
)
"""
Expand Down Expand Up @@ -130,10 +130,10 @@ class CreateTaskRequest(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
| ReturnStep
| SleepStep
| ErrorWorkflowStep
| YieldStep
| WaitForInputStep
| IfElseWorkflowStep
| SwitchStep
Expand Down Expand Up @@ -227,6 +227,7 @@ class ForeachDo(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
)
"""
The steps to run for each iteration
Expand All @@ -251,6 +252,7 @@ class ForeachDoUpdateItem(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
)
"""
The steps to run for each iteration
Expand Down Expand Up @@ -324,10 +326,10 @@ class IfElseWorkflowStep(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
| ReturnStep
| SleepStep
| ErrorWorkflowStep
| YieldStep
| WaitForInputStep
)
"""
Expand All @@ -342,10 +344,10 @@ class IfElseWorkflowStep(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
| ReturnStep
| SleepStep
| ErrorWorkflowStep
| YieldStep
| WaitForInputStep
| None,
Field(None, alias="else"),
Expand Down Expand Up @@ -376,10 +378,10 @@ class IfElseWorkflowStepUpdateItem(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
| ReturnStep
| SleepStep
| ErrorWorkflowStep
| YieldStep
| WaitForInputStep
)
"""
Expand All @@ -394,10 +396,10 @@ class IfElseWorkflowStepUpdateItem(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
| ReturnStep
| SleepStep
| ErrorWorkflowStep
| YieldStep
| WaitForInputStep
| None,
Field(None, alias="else"),
Expand Down Expand Up @@ -462,6 +464,7 @@ class Main(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
)
"""
The steps to run for each iteration
Expand Down Expand Up @@ -503,6 +506,7 @@ class MainModel(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
)
"""
The steps to run for each iteration
Expand Down Expand Up @@ -543,6 +547,7 @@ class ParallelStep(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
],
Field(max_length=100),
]
Expand All @@ -569,6 +574,7 @@ class ParallelStepUpdateItem(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
],
Field(max_length=100),
]
Expand Down Expand Up @@ -596,10 +602,10 @@ class PatchTaskRequest(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
| ReturnStep
| SleepStep
| ErrorWorkflowStep
| YieldStep
| WaitForInputStep
| IfElseWorkflowStepUpdateItem
| SwitchStepUpdateItem
Expand Down Expand Up @@ -874,10 +880,10 @@ class Task(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
| ReturnStep
| SleepStep
| ErrorWorkflowStep
| YieldStep
| WaitForInputStep
| IfElseWorkflowStep
| SwitchStep
Expand Down Expand Up @@ -1009,10 +1015,10 @@ class UpdateTaskRequest(BaseModel):
| LogStep
| EmbedStep
| SearchStep
| YieldStep
| ReturnStep
| SleepStep
| ErrorWorkflowStep
| YieldStep
| WaitForInputStep
| IfElseWorkflowStep
| SwitchStep
Expand Down
Loading

0 comments on commit f12e9e7

Please sign in to comment.