Update API concepts page.

This commit is contained in:
Andrew Nguonly
2024-06-14 15:22:26 -07:00
parent 66955951a4
commit 277a8efcca
3 changed files with 30 additions and 7 deletions
+23
View File
@@ -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
+5 -5
View File
@@ -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**
+2 -2
View File
@@ -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'