github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-09-01 19:12:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs[patch]: Adds first kv store doc matching new template (#24844)

Browse Source
This commit is contained in:
Jacob Lee
2024-07-30 15:58:51 -07:00
committed by GitHub
parent a4e940550a
commit 21eb4c9e5d
2 changed files with 170 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
libs/cli/langchain_cli/integration_template/docs/kv_store.ipynb
View File

@@ -21,7 +21,7 @@
"\n",
"- TODO: Make sure API reference link is correct.\n",
"\n",
"This will help you getting started with __ModuleName__ [key-value stores](/docs/concepts/#key-value-stores). For detailed documentation of all __ModuleName__ByteStore features and configurations head to the [API reference](https://api.python.langchain.com/en/latest/stores/langchain_core.stores.__module_name__ByteStore.html).\n",
"This will help you get started with __ModuleName__ [key-value stores](/docs/concepts/#key-value-stores). For detailed documentation of all __ModuleName__ByteStore features and configurations head to the [API reference](https://api.python.langchain.com/en/latest/stores/langchain_core.stores.__module_name__ByteStore.html).\n",
"\n",
"- TODO: Add any other relevant links, like information about models, prices, context windows, etc. See https://python.langchain.com/v0.2/docs/integrations/stores/in_memory/ for an example.\n",
"\n",
@@ -113,7 +113,9 @@
"source": [
"## Usage\n",
"\n",
"- TODO: Run cells so output can be seen."
"- TODO: Run cells so output can be seen.\n",
"\n",
"You can set data under keys like this using the `mset` method:"
]
},
{
@@ -122,15 +124,26 @@
"metadata": {},
"outputs": [],
"source": [
"kv_store.mset([\n",
" [\"key1\", b\"value1\"],\n",
" [\"key2\", b\"value2\"],\n",
"])\n",
"kv_store.mset(\n",
" [\n",
" [\"key1\", b\"value1\"],\n",
" [\"key2\", b\"value2\"],\n",
" ]\n",
")\n",
"\n",
"kv_store.mget([\n",
" \"key1\",\n",
" \"key2\",\n",
"])"
"kv_store.mget(\n",
" [\n",
" \"key1\",\n",
" \"key2\",\n",
" ]\n",
")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"And you can delete data using the `mdelete` method:"
]
},
{
@@ -139,15 +152,19 @@
"metadata": {},
"outputs": [],
"source": [
"kv_store.mdelete([\n",
" \"key1\",\n",
" \"key2\",\n",
"])\n",
"kv_store.mdelete(\n",
" [\n",
" \"key1\",\n",
" \"key2\",\n",
" ]\n",
")\n",
"\n",
"kv_store.mget([\n",
" \"key1\",\n",
" \"key2\",\n",
"])"
"kv_store.mget(\n",
" [\n",
" \"key1\",\n",
" \"key2\",\n",
" ]\n",
")"
]
},
{
@@ -165,7 +182,7 @@
"source": [
"## API reference\n",
"\n",
"For detailed documentation of all __ModuleName__ByteStore features and configurations head to the API reference: https://api.python.langchain.com/en/latest/stores/__module_name__.stores.__ModuleName__ByteStore.html"
"For detailed documentation of all __ModuleName__ByteStore features and configurations, head to the API reference: https://api.python.langchain.com/en/latest/stores/__module_name__.stores.__ModuleName__ByteStore.html"
]
}
],