Updated the docs

julep-ai · Oct 19, 2024 · 32c9d15 · 32c9d15
1 parent ed619a2
commit 32c9d15
Show file tree

Hide file tree

Showing 37 changed files with 257 additions and 427 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 <p align="center">
   <br />
-  <a href="https://docs.julep.ai" rel="dofollow">Explore Doc</a>
+  <a href="https://docs.julep.ai" rel="dofollow">Explore Docs</a>
   ·
   <a href="https://discord.com/invite/JTSBGRZrzj" rel="dofollow">Discord</a>
   ·

diff --git a/docs/README.md b/docs/README.md
@@ -307,7 +307,7 @@ pip install julep
 import yaml
 from julep import Julep # or AsyncJulep
 
-client = Julep(api_key="your_julep_api_key")
+client = Julep(api_key="your_julep_api_key", environment=“dev”)
 
 agent = client.agents.create(
     name="Storytelling Agent",
@@ -434,7 +434,7 @@ while (message := input("Enter a message: ")) != "quit":
 import { Julep } from "@julep/sdk";
 import yaml from "js-yaml";
 
-const client = new Julep({ apiKey: "your_julep_api_key" });
+const client = new Julep({ apiKey: "your_julep_api_key",environment:“dev” });
 
 async function createAgent() {
   const agent = await client.agents.create({
@@ -967,6 +967,6 @@ These integrations can be used within your tasks to extend the capabilities of y
 
 Explore our comprehensive API documentation to learn more about agents, tasks, and executions:
 
-- [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)
+- [Agents API](https://dev.julep.ai/api/docs#tag/agents)
+- [Tasks API](https://dev.julep.ai/api/docs#tag/tasks)
+- [Executions API](https://dev.julep.ai/api/docs#tag/executions)
diff --git a/docs/api-reference/README.md b/docs/api-reference/README.md
@@ -1,11 +1,4 @@
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 # 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)

diff --git a/docs/api-reference/agents-api-1.md b/docs/api-reference/agents-api-1.md
@@ -2,14 +2,6 @@
 description: API for creating and modifying Users
 ---
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
-
 # Users
 
 ## List all users

diff --git a/docs/api-reference/agents-api-2.md b/docs/api-reference/agents-api-2.md
@@ -2,13 +2,6 @@
 description: API for creating and modifying Sessions
 ---
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 # Sessions
 
 ## List sessions

diff --git a/docs/api-reference/agents-api-3.md b/docs/api-reference/agents-api-3.md
@@ -2,13 +2,6 @@
 description: API for accessing Agent Memories
 ---
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 # Memories
 
 ## Get an agent's memories

diff --git a/docs/api-reference/agents-api-4.md b/docs/api-reference/agents-api-4.md
@@ -2,13 +2,6 @@
 description: API for creating and modifying docs
 ---
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 # Docs
 
 ## Get all docs (for an agent or user)

diff --git a/docs/api-reference/agents-api.md b/docs/api-reference/agents-api.md
@@ -1,14 +1,6 @@
 ---
 description: API for creating and modifying Agents
 ---
-
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 # Agents
 
 ## List agents

diff --git a/docs/concepts/agents.md b/docs/concepts/agents.md
@@ -2,13 +2,6 @@
 description: A fundamental building block of an AI app built using Julep.
 ---
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 # 🤖 Agents
 
 ## What is an Agent?

diff --git a/docs/concepts/documents.md b/docs/concepts/documents.md
@@ -2,13 +2,6 @@
 description: Documents to be added for Retrieval Augmented Generation
 ---
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 # 📖 Documents
 
 A typical RAG application has the following components:

diff --git a/docs/concepts/sessions/README.md b/docs/concepts/sessions/README.md
@@ -2,13 +2,6 @@
 description: A conversation "session" between a user and an agent.
 ---
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 # 🔁 Sessions
 
 ## What is a Session?

diff --git a/docs/concepts/sessions/adaptive-context.md b/docs/concepts/sessions/adaptive-context.md
@@ -1,12 +1,5 @@
 # Adaptive Context ᴺᴱᵂ
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 ### What is Adaptive Context?
 
 Adaptive Context is a feature in Julep that intelligently manages the context size for long-running sessions. It allows users to continue adding messages to a session indefinitely without worrying about hitting context window limits or incurring excessive costs.
@@ -72,7 +65,7 @@ Enabling Adaptive Context is straightforward and can be done when creating a new
 from julep import Client
 
 # Initialize the Julep client
-client = Client(api_key="your_api_key")
+client = Client(api_key="your_api_key", environment=“dev”)
 
 # Create a new session with Adaptive Context enabled
 session = client.sessions.create(
@@ -91,7 +84,7 @@ session = client.sessions.create(
 import { Client } from "@julep/sdk";
 
 // Initialize the Julep client
-const client = new Client({ apiKey: "your-api-key" });
+const client = new Client({ apiKey: "your-api-key", environment:“dev” });
 
 // Create a new session with Adaptive Context enabled
 const session = await client.sessions.create({

diff --git a/docs/concepts/users.md b/docs/concepts/users.md
@@ -2,13 +2,6 @@
 description: A real person or system that needs to interacts with the Agent in your app.
 ---
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 # 🙎 Users
 
 ## What is a User?

diff --git a/docs/explanation/chat_features.md b/docs/explanation/chat_features.md
@@ -1,12 +1,5 @@
 # Chat Features in Julep
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 Julep provides a robust chat system with various features for dynamic interaction with agents. Here's an overview of the key components and functionalities:
 
 ## Chat Input

diff --git a/docs/explanation/context_overflow.md b/docs/explanation/context_overflow.md
@@ -1,12 +1,5 @@
 # Context Overflow Handling in Julep
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 Julep provides mechanisms to handle scenarios where the context size grows beyond the `token_budget` or the model's input limit. The behavior is determined by the `context_overflow` setting:
 
 1. `null` (default): 

diff --git a/docs/explanation/core_concepts.md b/docs/explanation/core_concepts.md
@@ -1,12 +1,5 @@
 # Core Concepts in Julep
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 Julep is a powerful backend system for managing agent execution. It provides several key components that work together to create flexible and intelligent applications. Here are the core concepts:
 
 ## Agent

diff --git a/docs/explanation/default_system_template.md b/docs/explanation/default_system_template.md
@@ -1,12 +1,5 @@
 # Default System Template in Julep
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 Julep uses a default system template for sessions when a custom one is not provided. This template is written in Jinja2 and incorporates various elements from the agent, user, and session context. Here's a breakdown of the template:
 
 ```jinja

diff --git a/docs/explanation/execution_state_machine.md b/docs/explanation/execution_state_machine.md
@@ -1,12 +1,5 @@
 # Execution State Machine in Julep
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 In Julep, an Execution represents an instance of a Task that has been started with some input. The Execution follows a specific state machine model, ensuring consistent and predictable behavior throughout its lifecycle.
 
 ## Execution States

diff --git a/docs/explanation/metadata_precedence.md b/docs/explanation/metadata_precedence.md
@@ -1,12 +1,5 @@
 # Metadata Precedence in Julep
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 In Julep, several objects can have `metadata` added to them:
 - Agent
 - User

diff --git a/docs/explanation/multi_agent_sessions.md b/docs/explanation/multi_agent_sessions.md
@@ -1,12 +1,5 @@
 # Multi-Agent Sessions in Julep
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 Julep supports different types of sessions based on the number of agents and users involved. This flexibility allows for complex interactions and use cases.
 
 ## Types of Sessions

diff --git a/docs/explanation/task_workflows.md b/docs/explanation/task_workflows.md
@@ -1,11 +1,5 @@
 # Task Workflows in Julep
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
 
 Tasks in Julep are powerful, Github Actions-style workflows that define long-running, multi-step actions. They allow for complex operations by defining steps and have access to all Julep integrations.
 

diff --git a/docs/explanation/tool_integration.md b/docs/explanation/tool_integration.md
@@ -1,12 +1,5 @@
 # Tool Integration in Julep
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 Julep provides a flexible system for integrating various types of tools that agents can use during interactions. These tools enable agents to perform actions, retrieve information, or interact with external systems.
 
 ## Types of Tools

diff --git a/docs/how-to-guides/customizing_tasks.md b/docs/how-to-guides/customizing_tasks.md
@@ -1,20 +1,13 @@
 # Customizing Tasks
 
-*****
-> ### This docs site is currently under construction although this github README below should suffice for now.
-
-![](https://i.giphy.com/vR1dPIYzQmkRzLZk2w.webp)
-*****
-
-
 This guide covers how to define and customize tasks for agents in Julep.
 
 ## Creating a Basic Task
 
 Here's an example of creating a simple daily motivation task:
 
 ```bash
-curl -X POST "https://api.julep.ai/api/agents/YOUR_AGENT_ID/tasks" \
+curl -X POST "https://dev.julep.ai/api/agents/YOUR_AGENT_ID/tasks" \
      -H "Authorization: Bearer $JULEP_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
@@ -103,4 +96,4 @@ For tasks that can benefit from parallel processing, use the `parallel` step:
 ## Next Steps
 
 - Learn about [handling executions](./handling_executions.md) to manage and monitor your tasks.
-- Explore [integrating tools](../tutorials/integrating_tools.md) to enhance your task capabilities.
+- Explore [integrating tools](../tutorials/integrating_tools.md) to enhance your task capabilities.