From 277a8efccaa686291448aa0b073638aecae1f8f9 Mon Sep 17 00:00:00 2001 From: Andrew Nguonly Date: Fri, 14 Jun 2024 15:22:26 -0700 Subject: [PATCH] Update API concepts page. --- docs/docs/deploy/api_concepts.md | 23 +++++++++++++++++++++++ docs/docs/deploy/cli.md | 10 +++++----- docs/mkdocs.yml | 4 ++-- 3 files changed, 30 insertions(+), 7 deletions(-) diff --git a/docs/docs/deploy/api_concepts.md b/docs/docs/deploy/api_concepts.md index e69de29bb..be523f6e8 100644 --- a/docs/docs/deploy/api_concepts.md +++ b/docs/docs/deploy/api_concepts.md @@ -0,0 +1,23 @@ +# API Concepts +This page discusses high-level concepts of the LangGraph Deploy API. The complete API specification is available locally at [`http://localhost:8123/docs`](http://localhost:8123/docs) or [here](). + +## Assistant +An assistant is a configured instance of a [`CompiledGraph`](../../reference/graphs/#compiledgraph). It abstracts the cognitive architecture of the graph and contains instance specific configuration and metadata. Multiple assistants can reference the same graph but can contain different configuration and metadata, which may differentiate the behavior of the assistants. + +An assistant (i.e. the graph) is invoked as part of a [run](#run). + +## Thread +A thread contains the accumulated state of a group of [runs](#run). If a run is executed on a thread, then the [state](../../concepts/#state-management) of the underlying graph of the [assistant](#assistant) will be persisted to the thread. A thread's current and historical state can be retrieved. + +To persist state, a thread must be created prior to executing a run. + +## Run +A run is an invocation of an [assistant](#assistant). Each run may have its own input, configuration, and metadata, which may affect execution and output of the underlying graph. A run can optionally be executed on a [thread](#thread). + +### Streaming + +### Human-in-the-Loop + +### Multi-Tasking + +### Webhooks diff --git a/docs/docs/deploy/cli.md b/docs/docs/deploy/cli.md index 077896c97..2bb3c092a 100644 --- a/docs/docs/deploy/cli.md +++ b/docs/docs/deploy/cli.md @@ -61,7 +61,7 @@ The base command for the LangGraph CLI is `langgraph`. **Usage** ``` -langgraph --help +langgraph [OPTIONS] COMMAND [ARGS] ``` ### `build` @@ -69,7 +69,7 @@ Build LangGraph Deploy API server Docker image. **Usage** ``` -langgraph build -t my-image +langgraph build [OPTIONS] ``` **Options** @@ -87,7 +87,7 @@ Stop LangGraph Deploy API server. **Usage** ``` -langgraph down +langgraph down [OPTIONS] ``` **Options** @@ -106,7 +106,7 @@ Show LangGraph Deploy API server logs. **Usage** ``` -langgraph logs +langgraph logs [OPTIONS] ``` **Options** @@ -123,7 +123,7 @@ Start LangGraph Deploy API server. **Usage** ``` -langgraph up +langgraph up [OPTIONS] ``` **Options** diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index bdad20897..c03ed60e0 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -169,8 +169,8 @@ nav: - API Concepts: 'deploy/api_concepts.md' - CLI: 'deploy/cli.md' - SDK: - - Python: 'deploy/python_sdk.md' - - JS/TS: 'deploy/js_sdk.md' + - Python: 'deploy/sdk/python_sdk.md' + - JS/TS: 'deploy/sdk/js_sdk.md' - Deployment: - Self-Hosted: 'deploy/deployment/self_hosted.md' - Managed: 'deploy/deployment/managed.md'