From 0dee089ba76b0e7438b19d5e57d41a9f9c403535 Mon Sep 17 00:00:00 2001 From: dwelch-spike <53876192+dwelch-spike@users.noreply.github.com> Date: Sun, 11 May 2025 13:30:29 +0000 Subject: [PATCH] docs: document the move of the aerospike vector store integration to langchain-aerospike vec-595 (#31156) **Description:** The Aerospike Vector Search vector store integration has moved out of langchain-community and to its own repository, https://github.com/aerospike/langchain-aerospike. This PR updates langchain documentation to reference it. If no one reviews your PR within a few days, please @-mention one of baskaryan, eyurtsev, ccurme, vbarda, hwchase17. --- .../docs/integrations/providers/aerospike.mdx | 10 +- .../integrations/vectorstores/aerospike.ipynb | 289 +++++------------- 2 files changed, 75 insertions(+), 224 deletions(-) diff --git a/docs/docs/integrations/providers/aerospike.mdx b/docs/docs/integrations/providers/aerospike.mdx index 9dfbaa68091..19486dca55a 100644 --- a/docs/docs/integrations/providers/aerospike.mdx +++ b/docs/docs/integrations/providers/aerospike.mdx @@ -8,17 +8,19 @@ Install the AVS Python SDK and AVS langchain vector store: ```bash -pip install aerospike-vector-search langchain-community +pip install aerospike-vector-search langchain-aerospike +``` -See the documentation for the Ptyhon SDK [here](https://aerospike-vector-search-python-client.readthedocs.io/en/latest/index.html). -The documentation for the AVS langchain vector store is [here](https://python.langchain.com/api_reference/community/vectorstores/langchain_community.vectorstores.aerospike.Aerospike.html). +See the documentation for the Python SDK [here](https://aerospike-vector-search-python-client.readthedocs.io/en/latest/index.html). +The documentation for the AVS langchain vector store is [here](https://langchain-aerospike.readthedocs.io/en/latest/). ## Vector Store To import this vectorstore: ```python -from langchain_community.vectorstores import Aerospike +from langchain_aerospike.vectorstores import Aerospike +``` See a usage example [here](https://python.langchain.com/docs/integrations/vectorstores/aerospike/). diff --git a/docs/docs/integrations/vectorstores/aerospike.ipynb b/docs/docs/integrations/vectorstores/aerospike.ipynb index 17f9fda39f9..37cd13fd919 100644 --- a/docs/docs/integrations/vectorstores/aerospike.ipynb +++ b/docs/docs/integrations/vectorstores/aerospike.ipynb @@ -11,8 +11,8 @@ "datasets stored in Aerospike. This new service lives outside of Aerospike and\n", "builds an index to perform those searches.\n", "\n", - "This notebook showcases the functionality of the LangChain Aerospike VectorStore\n", - "integration.\n", + "This notebook showcases the functionality of the [LangChain Aerospike VectorStore\n", + "integration](https://github.com/aerospike/langchain-aerospike).\n", "\n", "## Install AVS\n", "\n", @@ -25,11 +25,11 @@ }, { "cell_type": "code", - "execution_count": 1, + "execution_count": 11, "metadata": {}, "outputs": [], "source": [ - "AVS_HOST = \"\"\n", + "AVS_HOST = \"\"\n", "AVS_PORT = 5000" ] }, @@ -43,15 +43,25 @@ }, { "cell_type": "code", - "execution_count": 2, + "execution_count": 5, "metadata": { "vscode": { "languageId": "shellscript" } }, - "outputs": [], + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "\n", + "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m A new release of pip is available: \u001b[0m\u001b[31;49m25.0.1\u001b[0m\u001b[39;49m -> \u001b[0m\u001b[32;49m25.1.1\u001b[0m\n", + "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m To update, run: \u001b[0m\u001b[32;49mpip install --upgrade pip\u001b[0m\n" + ] + } + ], "source": [ - "!pip install --upgrade --quiet aerospike-vector-search==3.0.1 langchain-community sentence-transformers langchain" + "!pip install --upgrade --quiet aerospike-vector-search==4.2.0 langchain-aerospike langchain-community sentence-transformers langchain" ] }, { @@ -65,28 +75,32 @@ }, { "cell_type": "code", - "execution_count": 3, + "execution_count": 6, "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ - "--2024-05-10 17:28:17-- https://github.com/aerospike/aerospike-vector-search-examples/raw/7dfab0fccca0852a511c6803aba46578729694b5/quote-semantic-search/container-volumes/quote-search/data/quotes.csv.tgz\n", - "Resolving github.com (github.com)... 140.82.116.4\n", - "Connecting to github.com (github.com)|140.82.116.4|:443... connected.\n", + "--2025-05-07 21:06:30-- https://github.com/aerospike/aerospike-vector-search-examples/raw/7dfab0fccca0852a511c6803aba46578729694b5/quote-semantic-search/container-volumes/quote-search/data/quotes.csv.tgz\n", + "Resolving github.com (github.com)... 140.82.116.3\n", + "Connecting to github.com (github.com)|140.82.116.3|:443... connected.\n", + "HTTP request sent, awaiting response... 301 Moved Permanently\n", + "Location: https://github.com/aerospike/aerospike-vector/raw/7dfab0fccca0852a511c6803aba46578729694b5/quote-semantic-search/container-volumes/quote-search/data/quotes.csv.tgz [following]\n", + "--2025-05-07 21:06:30-- https://github.com/aerospike/aerospike-vector/raw/7dfab0fccca0852a511c6803aba46578729694b5/quote-semantic-search/container-volumes/quote-search/data/quotes.csv.tgz\n", + "Reusing existing connection to github.com:443.\n", "HTTP request sent, awaiting response... 302 Found\n", - "Location: https://raw.githubusercontent.com/aerospike/aerospike-vector-search-examples/7dfab0fccca0852a511c6803aba46578729694b5/quote-semantic-search/container-volumes/quote-search/data/quotes.csv.tgz [following]\n", - "--2024-05-10 17:28:17-- https://raw.githubusercontent.com/aerospike/aerospike-vector-search-examples/7dfab0fccca0852a511c6803aba46578729694b5/quote-semantic-search/container-volumes/quote-search/data/quotes.csv.tgz\n", - "Resolving raw.githubusercontent.com (raw.githubusercontent.com)... 185.199.110.133, 185.199.109.133, 185.199.111.133, ...\n", + "Location: https://raw.githubusercontent.com/aerospike/aerospike-vector/7dfab0fccca0852a511c6803aba46578729694b5/quote-semantic-search/container-volumes/quote-search/data/quotes.csv.tgz [following]\n", + "--2025-05-07 21:06:30-- https://raw.githubusercontent.com/aerospike/aerospike-vector/7dfab0fccca0852a511c6803aba46578729694b5/quote-semantic-search/container-volumes/quote-search/data/quotes.csv.tgz\n", + "Resolving raw.githubusercontent.com (raw.githubusercontent.com)... 185.199.110.133, 185.199.111.133, 185.199.108.133, ...\n", "Connecting to raw.githubusercontent.com (raw.githubusercontent.com)|185.199.110.133|:443... connected.\n", "HTTP request sent, awaiting response... 200 OK\n", "Length: 11597643 (11M) [application/octet-stream]\n", "Saving to: ‘quotes.csv.tgz’\n", "\n", - "quotes.csv.tgz 100%[===================>] 11.06M 1.94MB/s in 6.1s \n", + "quotes.csv.tgz 100%[===================>] 11.06M 12.7MB/s in 0.9s \n", "\n", - "2024-05-10 17:28:23 (1.81 MB/s) - ‘quotes.csv.tgz’ saved [11597643/11597643]\n", + "2025-05-07 21:06:32 (12.7 MB/s) - ‘quotes.csv.tgz’ saved [11597643/11597643]\n", "\n" ] } @@ -106,7 +120,7 @@ }, { "cell_type": "code", - "execution_count": 4, + "execution_count": 7, "metadata": {}, "outputs": [], "source": [ @@ -132,14 +146,14 @@ }, { "cell_type": "code", - "execution_count": 5, + "execution_count": 8, "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ - "page_content=\"quote: I'm selfish, impatient and a little insecure. I make mistakes, I am out of control and at times hard to handle. But if you can't handle me at my worst, then you sure as hell don't deserve me at my best.\" metadata={'source': './quotes.csv', 'row': 0, 'author': 'Marilyn Monroe', 'category': 'attributed-no-source, best, life, love, mistakes, out-of-control, truth, worst'}\n" + "page_content='quote: I'm selfish, impatient and a little insecure. I make mistakes, I am out of control and at times hard to handle. But if you can't handle me at my worst, then you sure as hell don't deserve me at my best.' metadata={'source': './quotes.csv', 'row': 0, 'author': 'Marilyn Monroe', 'category': 'attributed-no-source, best, life, love, mistakes, out-of-control, truth, worst'}\n" ] } ], @@ -158,178 +172,18 @@ }, { "cell_type": "code", - "execution_count": 6, + "execution_count": 9, "metadata": {}, "outputs": [ - { - "data": { - "application/vnd.jupyter.widget-view+json": { - "model_id": "60662fc2676a46a2ac48fbf30d9c85fe", - "version_major": 2, - "version_minor": 0 - }, - "text/plain": [ - "modules.json: 0%| | 0.00/349 [00:00