WEBDIENSTE/langgraph
1
0
Fork 0
mirror of https://github.com/langchain-ai/langgraph.git synced 2026-08-22 15:42:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add docs for assistant versioning (#1828)

Browse Source 
* draft of conceptual docs

* Improve the conceptual docs

* adding how-to

* add diagram, make callout to conceptual guide

* updated image

* updated screenshots to new UI

* add link, typo

---------

Co-authored-by: Lance Martin <lance@langchain.dev>
This commit is contained in:
Isaac Francisco
2024-09-25 16:13:08 +00:00
committed by GitHub
co-authored by Lance Martin
parent 6c171e2838
commit 042653207f
14 changed files with 379 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/cloud/reference/api/openapi.json
+178 -5
View File
@@ -334,6 +334,113 @@
}
}
},
"/assistants/{assistant_id}/versions": {
"post": {
"tags": [
"assistants/manage"
],
"summary": "Get Assistant Versions",
"description": "Get all versions of an assistant.",
"operationId": "get_assistant_versions_assistants__assistant_id__versions_get",
"parameters": [
{
"description": "The ID of the assistant.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Assistant Id",
"description": "The ID of the assistant."
},
"name": "assistant_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/Assistant"
},
"type": "array",
"title": "Response Search Assistants Assistants Search Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/assistants/{assistant_id}/change_version": {
"post": {
"tags": [
"assistants/manage"
],
"summary": "Change Assistant Version",
"description": "Change the version of an assistant.",
"operationId": "change_assistant_version__assistant_id__change_version__version_post",
"parameters": [
{
"description": "The ID of the assistant.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Assistant Id",
"description": "The ID of the assistant."
},
"name": "assistant_id",
"in": "path"
},
{
"description": "The version to change to.",
"required": true,
"schema": {
"type": "integer",
"title": "Version",
"description": "The version of the assistant to change to."
},
"name": "version",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Assistant"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/threads": {
"post": {
"tags": [
@@ -1760,6 +1867,14 @@
"metadata": {
"type": "object",
"title": "Metadata"
},
"version": {
"type": "integer",
"title": "Version"
},
"name": {
"type": "string",
"title": "Assistant Name"
}
},
"type": "object",
@@ -1820,12 +1935,29 @@
"type": "object",
"title": "Metadata",
"description": "Metadata to merge with existing assistant metadata."
},
"name": {
"type": "string",
"title": "Assistant Name",
"description": "The assistant name."
}
},
"type": "object",
"title": "AssistantPatch",
"description": "Payload for updating an assistant."
},
"AssistantVersionChange": {
"properties": {
"version": {
"type": "integer",
"title": "Version",
"description": "The assistant version."
}
},
"type": "object",
"title": "AssistantVersionChange",
"description": "Payload for changing the version of an assistant."
},
"Config": {
"properties": {
"tags": {
@@ -2268,7 +2400,8 @@
"messages",
"updates",
"events",
"debug"
"debug",
"custom"
]
},
"type": "array"
@@ -2280,7 +2413,8 @@
"messages",
"updates",
"events",
"debug"
"debug",
"custom"
]
}
],
@@ -2315,6 +2449,11 @@
],
"title": "Multitask Strategy",
"default": "reject"
},
"after_seconds": {
"type": "integer",
"title": "After Seconds",
"description": "Number of seconds to wait before starting the run."
}
},
"type": "object",
@@ -2442,7 +2581,8 @@
"messages",
"updates",
"events",
"debug"
"debug",
"custom"
]
},
"type": "array"
@@ -2454,7 +2594,8 @@
"messages",
"updates",
"events",
"debug"
"debug",
"custom"
]
}
],
@@ -2487,6 +2628,11 @@
],
"title": "On Disconnect",
"default": "cancel"
},
"after_seconds": {
"type": "integer",
"title": "After Seconds",
"description": "Number of seconds to wait before starting the run."
}
},
"type": "object",
@@ -2555,6 +2701,33 @@
"title": "SearchRequest",
"description": "Payload for listing assistants."
},
"AssistantVersionsSearchRequest": {
"properties": {
"metadata": {
"type": "object",
"title": "Metadata",
"description": "Metadata to search for."
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Maximum number to return.",
"default": 10,
"minimum": 1,
"maximum": 1000
},
"offset": {
"type": "integer",
"title": "Offset",
"description": "Offset to start from.",
"default": 0,
"minimum": 0
}
},
"type": "object",
"title": "SearchRequest",
"description": "Payload for listing assistant versions."
},
"ThreadSearchRequest": {
"properties": {
"metadata": {
@@ -2859,4 +3032,4 @@
}
}
}
}
}