Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: soft-link docs/README.md to README #619

Merged
merged 4 commits into from
Oct 8, 2024
Merged

doc: soft-link docs/README.md to README #619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7482213
doc: soft-link docs/README.md to README
creatorrr Oct 8, 2024
25187bd
fix: soft-links dont work on gitbook
creatorrr Oct 8, 2024
53de797
fix: soft-links dont work on gitbook
creatorrr Oct 8, 2024
00cba9f
fix: soft-links dont work on gitbook
creatorrr Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<sup>English | [中文翻译](/README-CN.md) | [日本語翻訳](/README-JP.md)</sup>
<sup>English | [中文翻译](https://github.com/julep-ai/julep/blob/dev/README-CN.md) | [日本語翻訳](https://github.com/julep-ai/julep/blob/dev/README-JP.md)</sup>

<div align="center">
<img src="https://socialify.git.ci/julep-ai/julep/image?description=1&descriptionEditable=API%20for%20AI%20agents%20and%20multi-step%20tasks&forks=1&name=1&owner=1&pattern=Solid&stargazers=1&font=Source%20Code%20Pro&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fjulep-ai%2Fjulep%2Fdev%2F.github%2Fjulep-logo.svg&theme=Auto" alt="julep" width="640" height="320" />
Expand Down Expand Up @@ -57,7 +57,7 @@ Exciting news! We're participating in DevFest.AI throughout October 2024! 🗓

> [!NOTE]
> Get your API key [here](https://dashboard-dev.julep.ai).
>
>
> While we are in beta, you can also reach out on [Discord](https://discord.com/invite/JTSBGRZrzj) to get rate limits lifted on your API key.

![Julep DevFest.AI](https://media.giphy.com/media/YjyUeyotft6epaMHtU/giphy.gif)
Expand Down Expand Up @@ -113,9 +113,9 @@ Exciting news! We're participating in DevFest.AI throughout October 2024! 🗓

Julep is a platform for creating AI agents that remember past interactions and can perform complex tasks. It offers long-term memory and manages multi-step processes.

Julep enables the creation of multi-step tasks incorporating decision-making, loops, parallel processing, and integration with numerous external tools and APIs.
Julep enables the creation of multi-step tasks incorporating decision-making, loops, parallel processing, and integration with numerous external tools and APIs.

While many AI applications are limited to simple, linear chains of prompts and API calls with minimal branching, Julep is built to handle more complex scenarios.
While many AI applications are limited to simple, linear chains of prompts and API calls with minimal branching, Julep is built to handle more complex scenarios.

It supports:
- Intricate, multi-step processes
Expand Down Expand Up @@ -201,7 +201,7 @@ main:
- prompt:
- role: system
content: >
You are a research summarizer. Create a comprehensive summary of the following research results on the topic {{inputs[0].topic}}.
You are a research summarizer. Create a comprehensive summary of the following research results on the topic {{inputs[0].topic}}.
The summary should be well-structured, informative, and highlight key findings and insights:
{{_.results}}
unwrap: true
Expand All @@ -217,7 +217,7 @@ main:

> [!TIP]
> Julep is really useful when you want to build AI agents that can maintain context and state over long-term interactions. It's great for designing complex, multi-step workflows and integrating various tools and APIs directly into your agent's processes.
>
>
> In this example, Julep will automatically manage parallel executions, retry failed steps, resend API requests, and keep the tasks running reliably until completion.

## Key Features
Expand Down Expand Up @@ -283,13 +283,13 @@ pip install julep

> [!NOTE]
> Get your API key [here](https://dashboard-dev.julep.ai).
>
>
> While we are in beta, you can also reach out on [Discord](https://discord.com/invite/JTSBGRZrzj) to get rate limits lifted on your API key.

> [!TIP]
> 💻 Are you a _show me the code!™_ kind of person? We have created a ton of cookbooks for you to get started with. **Check out the [cookbooks](/cookbooks)** to browse through examples.
>
> 💡 There's also lots of ideas that you can build on top of Julep. **Check out the [list of ideas](/cookbooks/IDEAS.md)** to get some inspiration.
> 💻 Are you a _show me the code!™_ kind of person? We have created a ton of cookbooks for you to get started with. **Check out the [cookbooks](https://github.com/julep-ai/julep/tree/dev/cookbooks)** to browse through examples.
>
> 💡 There's also lots of ideas that you can build on top of Julep. **Check out the [list of ideas](https://github.com/julep-ai/julep/tree/dev/cookbooks/IDEAS.md)** to get some inspiration.

## Python Quick Start 🐍

Expand Down Expand Up @@ -413,7 +413,7 @@ while (message := input("Enter a message: ")) != "quit":
)

print(response)
```
```

> [!TIP]
> You can find the full python example [here](example.py).
Expand Down Expand Up @@ -581,7 +581,7 @@ Julep is made up of the following components:
### Mental Model

<div align="center">
<img src="https://github.com/user-attachments/assets/38420b5d-9342-4c8d-bae9-b47c28ae45af" height="360" />
<img src="https://github.com/user-attachments/assets/38420b5d-9342-4c8d-bae9-b47c28ae45af" height="360" />
</div>

Think of Julep as a platform that combines both client-side and server-side components to help you build advanced AI agents. Here's how to visualize it:
Expand Down Expand Up @@ -620,7 +620,7 @@ graph TD

classDef client fill:#9ff,stroke:#333,stroke-width:1px;
class User client;

classDef core fill:#f9f,stroke:#333,stroke-width:2px;
class Agent,Tasks,Session core;
```
Expand All @@ -633,7 +633,7 @@ graph TD
- **Documents**: Text or data objects associated with agents or users, vectorized and stored for semantic search and retrieval.
- **Executions**: Instances of tasks that have been initiated with specific inputs, with their own lifecycle and state machine.

For a more detailed explanation of these concepts and their interactions, please refer to our [Concepts Documentation](/docs/julep-concepts.md).
For a more detailed explanation of these concepts and their interactions, please refer to our [Concepts Documentation](https://github.com/julep-ai/julep/blob/dev/docs/julep-concepts.md).

## Understanding Tasks

Expand Down Expand Up @@ -945,4 +945,4 @@ Explore our comprehensive API documentation to learn more about agents, tasks, a

- [Agents API](https://api.julep.ai/api/docs#tag/agents)
- [Tasks API](https://api.julep.ai/api/docs#tag/tasks)
- [Executions API](https://api.julep.ai/api/docs#tag/executions)
- [Executions API](https://api.julep.ai/api/docs#tag/executions)
Loading
Loading