From c74aba8cc581f478c5fb4880cf28e84395978773 Mon Sep 17 00:00:00 2001 From: William FH <13333726+hinthornw@users.noreply.github.com> Date: Wed, 2 Oct 2024 16:53:39 -0700 Subject: [PATCH] [Docs] Storage ref docs (#1985) --- docs/docs/reference/store.md | 6 ++++++ docs/mkdocs.yml | 1 + libs/checkpoint/langgraph/store/base/__init__.py | 2 +- 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/docs/reference/store.md diff --git a/docs/docs/reference/store.md b/docs/docs/reference/store.md new file mode 100644 index 000000000..1f9a33245 --- /dev/null +++ b/docs/docs/reference/store.md @@ -0,0 +1,6 @@ +# Storage + +::: langgraph.store.base + + +::: langgraph.store.postgres \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 93b373a67..838f2d848 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -206,6 +206,7 @@ nav: - Reference: - Graphs: reference/graphs.md - Checkpointing: reference/checkpoints.md + - Storage: reference/store.md - Prebuilt Components: reference/prebuilt.md - Channels: reference/channels.md - Errors: reference/errors.md diff --git a/libs/checkpoint/langgraph/store/base/__init__.py b/libs/checkpoint/langgraph/store/base/__init__.py index 2e1dbf604..a4e69a848 100644 --- a/libs/checkpoint/langgraph/store/base/__init__.py +++ b/libs/checkpoint/langgraph/store/base/__init__.py @@ -14,7 +14,7 @@ class Item: Args: value (dict[str, Any]): The stored data as a dictionary. Keys are filterable. - (str): Unique identifier within the namespace. + key (str): Unique identifier within the namespace. namespace (tuple[str, ...]): Hierarchical path defining the collection in which this document resides. Represented as a tuple of strings, allowing for nested categorization. For example: ("documents", 'user123')