From ead1d897e04b409d3f1d0c8738c21f7c126ad8be Mon Sep 17 00:00:00 2001 From: Nuno Campos Date: Tue, 12 Nov 2024 15:39:43 -0800 Subject: [PATCH] Update store section --- README.md | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6e07caa..00e427e 100644 --- a/README.md +++ b/README.md @@ -52,16 +52,16 @@ Convenience Endpoints: What APIs do you need to enable multi-turn interactions? - Persistent state - - get and update state - - append-only log of states - - optimized storage -- Support for concurrent inputs from user - - Implement chatbots with more natural UX - - Choose from 4 modes to handle this + - Get and update state + - Track history of past states of a thread, modelled as an append-only log of states + - Optimize storage by storing only diffs between states +- Concurrency controls + - Ensure that only one run per thread is active at a time + - Customizable handling of concurrent runs (interrupt, enqueue, interrupt or rollback) - CRUD endpoints for threads - - list threads by users - - list threads that need attention (interrupted) - - copy or delete threads + - List threads by user, or other metadata + - List threads by status (idle, interrupted, errored, finished) + - Copy or delete threads Endpoints: @@ -82,7 +82,20 @@ What do you need out of a memory API for agents? - Customizable memory scopes - Storing memory against the user, thread, assistant, company, etc - Accessing memory from different scopes in the same run -- … +- Flexible storage + - Support simple text memories, as well as structured data + - CRUD operations for memories (create, read, update, delete) +- Search and retrieval + - Get a single memory by namespace and key + - List memories filtered by namespace, contents, sorted by time, etc + +Endpoints: + +- [`PUT /store/items`](https://langchain-ai.github.io/agent-protocol/api.html#tag/store/PUT/store/items) - Create or update a memory item, at a given namespace and key. +- [`DELETE /store/items`](https://langchain-ai.github.io/agent-protocol/api.html#tag/store/DELETE/store/items) - Delete a memory item, at a given namespace and key. +- [`GET /store/items`](https://langchain-ai.github.io/agent-protocol/api.html#tag/store/GET/store/items) - Get a memory item, at a given namespace and key. +- [`POST /store/items/search`](https://langchain-ai.github.io/agent-protocol/api.html#tag/store/POST/store/items/search) - Search memory items. +- [`POST /store/namespaces`](https://langchain-ai.github.io/agent-protocol/api.html#tag/store/POST/store/namespaces) - List namespaces. ## Roadmap