Skip to content

Commit

Permalink
docs: update agents docs
Browse files Browse the repository at this point in the history
  • Loading branch information
philipbalbas committed Apr 19, 2024
1 parent 7000518 commit 545dda1
Show file tree
Hide file tree
Showing 14 changed files with 96 additions and 314 deletions.
7 changes: 3 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ layout:
description:
visible: false
tableOfContents:
visible: true
**visible**: true
outline:
visible: false
pagination:
Expand All @@ -17,8 +17,7 @@ layout:
{% hint style="success" %}
Julep is a platform for building AI agents that have memory and can plan and execute tasks. It is:

* Backed by [S1](broken-reference), our model that's optimized for agentic tasks
* [Open source](https://github.com/julep-ai/agents) (coming soon)
* [Open source](https://github.com/julep-ai/julep)
{% endhint %}

<table data-column-title-hidden data-view="cards"><thead><tr><th>Title</th><th>Description</th><th data-hidden data-card-target data-type="content-ref">Link 1</th></tr></thead><tbody><tr><td><h3><mark style="color:blue;">I'm just curious...</mark></h3></td><td>Read more about the <a href="introduction/julep-in-a-nutshell.md">Julep Platform</a> and <a href="README (1).md">why we are building it</a>.</td><td><a href="introduction/julep-in-a-nutshell.md">julep-in-a-nutshell.md</a></td></tr><tr><td><h3><mark style="color:green;">I want to learn more.</mark></h3></td><td>Learn <a href="introduction/core-concepts.md">core concepts</a> behind the Julep Platform.</td><td><a href="introduction/core-concepts.md">core-concepts.md</a></td></tr><tr><td><h3><mark style="color:purple;">I'm in, let's go!</mark></h3></td><td>Get started building your <a href="broken-reference">first agent</a>.</td><td><a href="getting-started/agents-quickstart.md">agents-quickstart.md</a></td></tr><tr><td><h3><mark style="color:orange;">Learn more about Agents</mark></h3></td><td>Read the <a href="agents/overview.md">Agents Overview</a> or follow the <a href="agents/tutorial.md">Tutorial</a>.</td><td><a href="agents/overview.md">overview.md</a></td></tr><tr><td><h3><mark style="color:green;">Explore S1</mark></h3></td><td>Read more <a href="s1-model/overview.md">about our model</a> or <a href="s1-model/tutorial.md">learn how to use it</a>.</td><td><a href="s1-model/overview.md">overview.md</a></td></tr><tr><td><h3><mark style="color:red;">I'm stuck. Need help!</mark></h3></td><td>Get help on our <a href="https://discord.gg/RdaGyrzpC8">discord community</a>, create a <a href="https://github.com/julep-ai/platform">Github issue</a> or <a href="faqs/technical-details.md">check out FAQs</a>.</td><td><a href="https://discord.gg/RdaGyrzpC8">https://discord.gg/RdaGyrzpC8</a></td></tr><tr><td><h3>SDKs</h3></td><td></td><td><a href="sdks/available-sdks.md">available-sdks.md</a></td></tr><tr><td><h3>FAQs</h3></td><td></td><td><a href="faqs/general-overview.md">general-overview.md</a></td></tr><tr><td><h3>API Reference</h3></td><td></td><td><a href="api-reference/agents-api/">agents-api</a></td></tr></tbody></table>
<table data-column-title-hidden data-view="cards"><thead><tr><th>Title</th><th>Description</th><th data-hidden data-card-target data-type="content-ref">Link 1</th></tr></thead><tbody><tr><td><h3><mark style="color:blue;">I'm just curious...</mark></h3></td><td>Read more about the <a href="introduction/julep-in-a-nutshell.md">Julep Platform</a> and <a href="README (1).md">why we are building it</a>.</td><td><a href="introduction/julep-in-a-nutshell.md">julep-in-a-nutshell.md</a></td></tr><tr><td><h3><mark style="color:green;">I want to learn more.</mark></h3></td><td>Learn <a href="introduction/core-concepts.md">core concepts</a> behind the Julep Platform.</td><td><a href="introduction/core-concepts.md">core-concepts.md</a></td></tr><tr><td><h3><mark style="color:purple;">I'm in, let's go!</mark></h3></td><td>Get started building your <a href="getting-started/agents-quickstart.md">first agent</a>.</td><td><a href="getting-started/agents-quickstart.md">agents-quickstart.md</a></td></tr><tr><td><h3><mark style="color:orange;">Learn more about Agents</mark></h3></td><td>Read the <a href="agents/overview.md">Agents Overview</a> or follow the <a href="agents/tutorial.md">Tutorial</a>.</td><td><a href="agents/overview.md">overview.md</a></td></tr><tr><td></td><td>Get help on our <a href="https://discord.gg/RdaGyrzpC8">discord community</a>, create a <a href="https://github.com/julep-ai/platform">Github issue</a> or <a href="faqs/technical-details.md">check out FAQs</a>.</td><td><a href="https://discord.gg/RdaGyrzpC8">https://discord.gg/RdaGyrzpC8</a></td></tr><tr><td><h3>SDKs</h3></td><td></td><td><a href="sdks/available-sdks.md">available-sdks.md</a></td></tr><tr><td><h3>FAQs</h3></td><td></td><td><a href="faqs/general-overview.md">general-overview.md</a></td></tr><tr><td><h3>API Reference</h3></td><td></td><td><a href="api-reference/agents-api/">agents-api</a></td></tr></tbody></table>
30 changes: 2 additions & 28 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@
* [Welcome to Julep](README.md)
* [Julep in a nutshell](introduction/julep-in-a-nutshell.md)
* [Motivation](<README (1).md>)
* [Core Concepts](introduction/core-concepts.md)

## 🚀 Getting Started

* [Agents Quickstart](getting-started/agents-quickstart.md)
* [Model Quickstart](getting-started/python-setup.md)

## 🤖 Agents (alpha) <a href="#agents" id="agents"></a>

Expand All @@ -19,20 +14,7 @@
* [Self-hosting](agents/self-hosting.md)
* [Example: Jessica](agents/jessica.md)

## 💁 S1 Model

* [Overview](s1-model/overview.md)
* [Tutorial](s1-model/tutorial.md)
* [Concepts](s1-model/context-sections.md)
* [Capabilities](s1-model/capabilities/README.md)
* [Human-like conversations](s1-model/capabilities/capabilities.md)

## 🧪 Agent Studio

* [Model Playground](agent-studio/playground.md)
* [Agents Playground](agent-studio/agents-playground.md)

## 🛠️ SDKs
## 📖 API REFERENCE

* [Python SDK](python-sdk-docs/README.md)
* [Client](python-sdk-docs/julep/client.md)
Expand All @@ -52,26 +34,18 @@
* [Session](js-sdk-docs/classes/managers_session.SessionsManager.md)
* [Tool](js-sdk-docs/classes/managers_tool.ToolsManager.md)
* [User](js-sdk-docs/classes/managers_user.UsersManager.md)

## 📖 API REFERENCE

* [Agents API (alpha)](api-reference/agents-api/README.md)
* [Agents API](api-reference/agents-api/README.md)
* [Agents](api-reference/agents-api/agents-api.md)
* [Users](api-reference/agents-api/agents-api-1.md)
* [Sessions](api-reference/agents-api/agents-api-2.md)
* [Memories](api-reference/agents-api/agents-api-3.md)
* [Docs](api-reference/agents-api/agents-api-4.md)
* [Tasks](api-reference/agents-api/agents-api-5.md)
* [Task Runs](api-reference/agents-api/agents-api-6.md)
* [Model API](api-reference/model-api.md)
* [Chat Completions](api-reference/model-api/model-api.md)
* [Completions (Advanced)](api-reference/model-api/model-api-1.md)
* [Generation Parameters](api-reference/model-api/generation-parameters.md)

## 🔍 FAQs

* [General Questions](faqs/general-overview.md)
* [Agent Studio](faqs/agent-prototyping.md)
* [Memory and Learning](faqs/memory-and-learning.md)
* [Sessions and Tasks](faqs/sessions-and-tasks.md)
* [Technical Details](faqs/technical-details.md)
Expand Down
10 changes: 5 additions & 5 deletions docs/agents/jessica.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@
description: Jessica
---

# Jessica Playground
## Deepnote example

## What is Jessica
Jessica is a satirical AI agent we designed using the Julep API for testing interactions. You can easily test and deploy Jessica or any custom-designed agent on the Deepnote by visiting [this link](https://deepnote.com/app/julep-ai-761c/Julep-Mixers-4dfff09a-84f2-4278-baa3-d1a00b88ba26)

## Playground site

<figure><img src="../.gitbook/assets/jessica.png" alt="Jessica page"><figcaption></figcaption></figure>

<figure><img src="../.gitbook/assets/jessica-prompt.png" alt="Jessica prompt"><figcaption></figcaption></figure>

Jessica is an example agent that uses the Julep Agents API that you can access at [https://jessica.julep.ai](https://jessica.julep.ai).
You can also talk to Jessica via our playground at [https://jessica.julep.ai](https://jessica.julep.ai).

The playground is also open source which you can access [here](https://github.com/julep-ai/jessica-public).

## How to run and deploy

To run your own agent using this playground, you simply need to modify the `.env` file and add the following variables.

```.env
Expand Down
10 changes: 3 additions & 7 deletions docs/agents/tutorial.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# Tutorial

{% hint style="info" %}
**Coming soon.**
{% endhint %}

### Loom Demo

(Step by step code follows)

{% embed url="https://www.loom.com/share/9d303e8ad1714c19a20afede05cdc7d3?sid=b5600ea5-583d-498e-8917-f2b35ca38a3c" %}
{% embed url="https://www.loom.com/share/79646b058235467fb9042d242ce0d7a4?sid=86d9da76-87e5-4bf9-a2a8-0e9ee1c59f1c" %}

***

Expand Down Expand Up @@ -122,7 +118,7 @@ for step in run.execution_steps():
Step Result: Starting the research on Sam Altman. I'll begin by gathering information from various sources on the web.
---

Step Result:
Step Result:
---

Step Result: Found numerous articles, interviews, and resources on Sam Altman, including his role at OpenAI, investments, and insights into technology and entrepreneurship.
Expand All @@ -138,7 +134,7 @@ Sam Altman, known for his leadership at OpenAI, has been a pivotal figure in the
Step Result: Now, I'll send the compiled summary and details to the webhook.
---

Step Result:
Step Result:
---

Step Result: Delivered data to webhook
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/agents-api/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Agents API (alpha)
# Agents API

[![Run In Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/33213061-a0a1e3a9-9681-44ae-a5c2-703912b32336?action=collection%2Ffork\&source=rip\_markdown\&collection-url=entityId%3D33213061-a0a1e3a9-9681-44ae-a5c2-703912b32336%26entityType%3Dcollection%26workspaceId%3D183380b4-f2ac-44ef-b018-1f65dfc8256b)

Expand Down
178 changes: 3 additions & 175 deletions docs/api-reference/agents-api/agents-api-6.md
Original file line number Diff line number Diff line change
@@ -1,177 +1,5 @@
# Task Runs

## Agens

### List agents

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/agents" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Create a new agent

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/agents" method="post" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Get a specific agent by id

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/agents/{agent_id}" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Update an agent

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/agents/{agent_id}" method="put" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Delete an agent

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/agents/{agent_id}" method="delete" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

***

## Users

### List all users

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/users" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Create a new user

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/users" method="post" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Get a specific user by id

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/users/{user_id}" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Update a specific user by id

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/users/{user_id}" method="put" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Delete a specific user by id

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/users/{user_id}" method="delete" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

***

## Sessions

### List sessions

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/sessions" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Create a new session

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/sessions" method="post" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Get a specific session by id

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/sessions/{session_id}" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Update a specific session by id

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/sessions/{session_id}" method="put" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Delete a specific session by id

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/sessions/{session_id}" method="delete" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

***

## Chat

### Chat with an agent in a session

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/sessions/{session_id}/chat" method="post" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Get suggestions made by the agent based on the session

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/sessions/{session_id}/suggestions" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Get a session's chat history

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/sessions/{session_id}/history" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

***

## Memories

### Get an agent's memories

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/agents/{agent_id}/memories" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Delete a memory by id

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/agents/{agent_id}/memories/{memory_id}" method="delete" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

***

## Tools

***

## Docs

### Get all docs (for an agent or user)

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/agents/{agent_id}/additional_info" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/users/{user_id}/additional_info" method="get" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Create a new doc (for agent or user)

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/agents/{agent_id}/additional_info" method="post" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/users/{user_id}/additional_info" method="post" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

### Delete a doc by id

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/agents/{agent_id}/additional_info/{additional_info_id}" method="delete" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}

{% swagger src="../../.gitbook/assets/agents-openapi.yaml" path="/users/{user_id}/additional_info/{additional_info_id}" method="delete" %}
[agents-openapi.yaml](../../.gitbook/assets/agents-openapi.yaml)
{% endswagger %}
{% hint style="info" %}
**Coming soon.**
{% endhint %}
20 changes: 10 additions & 10 deletions docs/faqs/general-overview.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# General Overview

1. **What is Julep AI?**\
Julep AI is a platform that enables the rapid prototyping and deployment of AI agents. These agents can autonomously accomplish goals by planning steps, selecting tools, and executing actions iteratively, utilizing Large Language Models (LLMs).\

2. **How do Julep agents function?**\
Agents operate semi-autonomously by interacting with users or systems, making decisions, and performing tasks. They leverage a memory system to retain state and context, improving over time as they interact more with their environment.\

3. **Can Julep agents be integrated into existing systems?**\
Absolutely. Julep AI provides an API SDK that facilitates the integration of AI agents into existing products and workflows.\

4. **Does Julep support customization of AI agents?**\
1. **What is Julep AI?**
Julep AI is a platform that enables the rapid prototyping and deployment of AI agents. These agents can autonomously accomplish goals by planning steps, selecting tools, and executing actions iteratively, utilizing Large Language Models (LLMs).
<br />
2. **How do Julep agents function?**
Agents operate semi-autonomously by interacting with users or systems, making decisions, and performing tasks. They leverage a memory system to retain state and context, improving over time as they interact more with their environment.
<br />
3. **Can Julep agents be integrated into existing systems?**
Absolutely. Julep AI provides an API SDK that facilitates the integration of AI agents into existing products and workflows.
<br />
4. **Does Julep support customization of AI agents?**
Julep AI offers extensive customization options, allowing users to define the behavior, memory scope, and capabilities of their AI agents.
16 changes: 8 additions & 8 deletions docs/faqs/memory-and-learning.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Memory and Learning

1. **What types of memory do Julep AI agents have?**\
Julep AI agents possess three types of memory: _episodic_, for events; _implicit_, for beliefs; and _semantic_, for factual and conceptual information.\
\
Episodic memory allows agents to recall past events, implicit memory aids in understanding user preferences and behaviors, and semantic memory provides a knowledge base for factual queries.\
1. **What types of memory do Julep AI agents have?**
Julep AI agents possess three types of memory: _episodic_, for events; _implicit_, for beliefs; and _semantic_, for factual and conceptual information.

2. **Do agents form new memories from each interaction?**\
Yes, agents update their memories after each interaction, extracting new episodes, beliefs, and facts to improve future performance and personalization.\

3. **Can I reset or delete an agent’s memories?**\
Episodic memory allows agents to recall past events, implicit memory aids in understanding user preferences and behaviors, and semantic memory provides a knowledge base for factual queries.
<br />
2. **Do agents form new memories from each interaction?**
Yes, agents update their memories after each interaction, extracting new episodes, beliefs, and facts to improve future performance and personalization.
<br />
3. **Can I reset or delete an agent’s memories?**
Users have the ability to reset or delete memories within the platform to manage the information that their agents retain.
Loading

0 comments on commit 545dda1

Please sign in to comment.