Skip to content

Commit 550d27c

Browse files
committed
readme update
1 parent 6398539 commit 550d27c

File tree

1 file changed

+5
-169
lines changed

1 file changed

+5
-169
lines changed

Diff for: README.md

+5-169
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Your contributions, big or small, are valuable to us. Let's build something amaz
7676
- [Integrations](#integrations)
7777
- [Other Features](#other-features)
7878
- [Adding Tools to Agents](#adding-tools-to-agents)
79+
- [Managing Sessions and Users](#managing-sessions-and-users)
7980
- [Document Integration and Search](#document-integration-and-search)
8081
- [Reference](#reference)
8182
- [SDK Reference](#sdk-reference)
@@ -85,15 +86,6 @@ Your contributions, big or small, are valuable to us. Let's build something amaz
8586
- [Different Use Cases](#different-use-cases)
8687
- [Different Form Factor](#different-form-factor)
8788
- [In Summary](#in-summary)
88-
- [Document Integration and Search](#document-integration-and-search-1)
89-
- [Reference](#reference-1)
90-
- [SDK Reference](#sdk-reference-1)
91-
- [API Reference](#api-reference-1)
92-
- [Local Quickstart](#local-quickstart-1)
93-
- [What's the difference between Julep and LangChain etc?](#whats-the-difference-between-julep-and-langchain-etc-1)
94-
- [Different Use Cases](#different-use-cases-1)
95-
- [Different Form Factor](#different-form-factor-1)
96-
- [In Summary](#in-summary-1)
9789

9890
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
9991

@@ -1408,9 +1400,6 @@ output:
14081400
<td>
14091401

14101402
```yaml
1411-
setup:
1412-
# No specific setup parameters are required for Wikipedia
1413-
14141403
arguments:
14151404
query: string # The search query string
14161405
load_max_docs: integer # (Optional) Maximum number of documents to load. Default is 2.
@@ -1420,6 +1409,7 @@ output:
14201409
```
14211410

14221411
</td>
1412+
14231413
<td>
14241414

14251415
**Example cookbook**: [cookbooks/03-trip-planning-assistant.ipynb](https://github.com/julep-ai/julep/blob/dev/cookbooks/03-trip-planning-assistant.ipynb)
@@ -1443,6 +1433,7 @@ output:
14431433
```
14441434

14451435
</td>
1436+
14461437
</tr>
14471438

14481439
<tr>
@@ -1542,6 +1533,7 @@ output:
15421533
</tr>
15431534

15441535
</table>
1536+
15451537
For more details, refer to our [Integrations Documentation](#integrations).
15461538

15471539
<div align="center">
@@ -1551,10 +1543,6 @@ For more details, refer to our [Integrations Documentation](#integrations).
15511543
<a href="#-table-of-contents">
15521544
<img src="https://img.shields.io/badge/Table%20of%20Contents-000000?style=for-the-badge&logo=github&logoColor=white" alt="Table of Contents">
15531545
</a>
1554-
</a>&nbsp;|&nbsp;
1555-
<a href="#-table-of-contents">
1556-
<img src="https://img.shields.io/badge/Table%20of%20Contents-000000?style=for-the-badge&logo=github&logoColor=white" alt="Table of Contents">
1557-
</a>
15581546
</div>
15591547

15601548
## Other Features
@@ -1576,158 +1564,6 @@ client.agents.tools.create(
15761564
"setup": {"api_key": "your_brave_api_key"},
15771565
},
15781566
)
1579-
1580-
Julep offers a range of advanced features to enhance your AI workflows:
1581-
### Managing Sessions and Users
1582-
### Adding Tools to Agents
1583-
Julep provides robust session management for persistent interactions:
1584-
Extend your agent's capabilities by integrating external tools and APIs:
1585-
```python
1586-
session = client.sessions.create(
1587-
agent_id=agent.id,
1588-
user_id=user.id,
1589-
context_overflow="adaptive"
1590-
)
1591-
```python
1592-
# Continue conversation in the same session
1593-
response = client.sessions.chat(
1594-
session_id=session.id,
1595-
messages=[
1596-
{
1597-
"role": "user",
1598-
"content": "Follow up on the previous conversation."
1599-
}
1600-
]
1601-
)
1602-
```
1603-
1604-
### Document Integration and Search
1605-
1606-
Easily manage and search through documents for your agents:
1607-
1608-
```python
1609-
# Upload a document
1610-
document = client.agents.docs.create(
1611-
title="AI advancements",
1612-
content="AI is changing the world...",
1613-
metadata={"category": "research_paper"}
1614-
)
1615-
1616-
# Search documents
1617-
results = client.agents.docs.search(
1618-
text="AI advancements",
1619-
metadata_filter={"category": "research_paper"}
1620-
)
1621-
```
1622-
agent_id=agent.id,
1623-
name="web_search",
1624-
description="Search the web for information.",
1625-
integration={
1626-
</a>&nbsp;|&nbsp;
1627-
<a href="#-table-of-contents">
1628-
<img src="https://img.shields.io/badge/Table%20of%20Contents-000000?style=for-the-badge&logo=github&logoColor=white" alt="Table of Contents">
1629-
</a>
1630-
</div>
1631-
1632-
## Reference
1633-
1634-
### SDK Reference
1635-
1636-
- **Node.js** [SDK Reference](https://github.com/julep-ai/node-sdk/blob/main/api.md) | [NPM Package](https://www.npmjs.com/package/@julep/sdk)
1637-
- **Python** [SDK Reference](https://github.com/julep-ai/python-sdk/blob/main/api.md) | [PyPI Package](https://pypi.org/project/julep/)
1638-
1639-
### API Reference
1640-
1641-
Explore our API documentation to learn more about agents, tasks, and executions:
1642-
1643-
- [Agents API](https://dev.julep.ai/api/docs#tag/agents)
1644-
- [Tasks API](https://dev.julep.ai/api/docs#tag/tasks)
1645-
- [Executions API](https://dev.julep.ai/api/docs#tag/executions)
1646-
1647-
<div align="center">
1648-
<a href="#top">
1649-
<img src="https://img.shields.io/badge/Back%20to%20Top-000000?style=for-the-badge&logo=github&logoColor=white" alt="Back to Top">
1650-
</a>&nbsp;|&nbsp;
1651-
<a href="#-table-of-contents">
1652-
<img src="https://img.shields.io/badge/Table%20of%20Contents-000000?style=for-the-badge&logo=github&logoColor=white" alt="Table of Contents">
1653-
</a>
1654-
</div>
1655-
1656-
## Local Quickstart
1657-
1658-
**Requirements**:
1659-
1660-
- latest docker compose installed
1661-
1662-
**Steps**:
1663-
1664-
1. `git clone https://github.com/julep-ai/julep.git`
1665-
2. `cd julep`
1666-
3. `docker volume create cozo_backup`
1667-
4. `docker volume create cozo_data`
1668-
5. `cp .env.example .env # <-- Edit this file`
1669-
6. `docker compose --env-file .env --profile temporal-ui --profile single-tenant --profile self-hosted-db up --build`
1670-
1671-
<div align="center">
1672-
<a href="#top">
1673-
<img src="https://img.shields.io/badge/Back%20to%20Top-000000?style=for-the-badge&logo=github&logoColor=white" alt="Back to Top">
1674-
</a>&nbsp;|&nbsp;
1675-
<a href="#-table-of-contents">
1676-
<img src="https://img.shields.io/badge/Table%20of%20Contents-000000?style=for-the-badge&logo=github&logoColor=white" alt="Table of Contents">
1677-
</a>
1678-
</div>
1679-
1680-
---
1681-
1682-
## What's the difference between Julep and LangChain etc?
1683-
1684-
### Different Use Cases
1685-
1686-
Think of LangChain and Julep as tools with different focuses within the AI development stack.
1687-
1688-
LangChain is great for creating sequences of prompts and managing interactions with LLMs. It has a large ecosystem with lots of pre-built integrations, which makes it convenient if you want to get something up and running quickly. LangChain fits well with simple use cases that involve a linear chain of prompts and API calls.
1689-
1690-
Julep, on the other hand, is more about building persistent AI agents that can maintain context over long-term interactions. It shines when you need complex workflows that involve multi-step tasks, conditional logic, and integration with various tools or APIs directly within the agent's process. It's designed from the ground up to manage persistent sessions and complex workflows.
1691-
1692-
Use Julep if you imagine building a complex AI assistant that needs to:
1693-
1694-
- Keep track of user interactions over days or weeks.
1695-
- Perform scheduled tasks, like sending daily summaries or monitoring data sources.
1696-
- Make decisions based on prior interactions or stored data.
1697-
- Interact with multiple external services as part of its workflow.
1698-
1699-
Then Julep provides the infrastructure to support all that without you having to build it from scratch.
1700-
1701-
### Different Form Factor
1702-
1703-
Julep is a **platform** that includes a language for describing workflows, a server for running those workflows, and an SDK for interacting with the platform. In order to build something with Julep, you write a description of the workflow in `YAML`, and then run the workflow in the cloud.
1704-
1705-
Julep is built for heavy-lifting, multi-step, and long-running workflows and there's no limit to how complex the workflow can be.
1706-
1707-
LangChain is a **library** that includes a few tools and a framework for building linear chains of prompts and tools. In order to build something with LangChain, you typically write Python code that configures and runs the model chains you want to use.
1708-
1709-
LangChain might be sufficient and quicker to implement for simple use cases that involve a linear chain of prompts and API calls.
1710-
1711-
### In Summary
1712-
1713-
Use LangChain when you need to manage LLM interactions and prompt sequences in a stateless or short-term context.
1714-
1715-
Choose Julep when you need a robust framework for stateful agents with advanced workflow capabilities, persistent sessions, and complex task orchestration.
1716-
1717-
<div align="center">
1718-
<a href="#top">
1719-
<img src="https://img.shields.io/badge/Back%20to%20Top-000000?style=for-the-badge&logo=github&logoColor=white" alt="Back to Top">
1720-
</a>&nbsp;|&nbsp;
1721-
<a href="#-table-of-contents">
1722-
<img src="https://img.shields.io/badge/Table%20of%20Contents-000000?style=for-the-badge&logo=github&logoColor=white" alt="Table of Contents">
1723-
</a>
1724-
</div>
1725-
1726-
"provider": "brave",
1727-
"method": "search",
1728-
"setup": {"api_key": "your_brave_api_key"},
1729-
},
1730-
)
17311567
```
17321568

17331569
### Managing Sessions and Users
@@ -1873,4 +1709,4 @@ Choose Julep when you need a robust framework for stateful agents with advanced
18731709
<a href="#-table-of-contents">
18741710
<img src="https://img.shields.io/badge/Table%20of%20Contents-000000?style=for-the-badge&logo=github&logoColor=white" alt="Table of Contents">
18751711
</a>
1876-
</div>
1712+
</div>

0 commit comments

Comments
 (0)