-
Notifications
You must be signed in to change notification settings - Fork 13.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a new vector store - AwaDB (#5971)
Added AwaDB vector store, which is a wrapper over the AwaDB, that can be used as a vector storage and has an efficient similarity search. Added integration tests for the vector store Added jupyter notebook with the example Delete a unneeded empty file and resolve the conflict(#5886) Please check, Thanks! @dev2049 @hwchase17 --------- Co-authored-by: vincent <awadb.vincent@gmail.com>
- Loading branch information
Showing
7 changed files
with
620 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# AwaDB | ||
|
||
>[AwaDB](https://github.com/awa-ai/awadb) is an AI Native database for the search and storage of embedding vectors used by LLM Applications. | ||
## Installation and Setup | ||
|
||
```bash | ||
pip install awadb | ||
``` | ||
|
||
|
||
## VectorStore | ||
|
||
There exists a wrapper around AwaDB vector databases, allowing you to use it as a vectorstore, | ||
whether for semantic search or example selection. | ||
|
||
```python | ||
from langchain.vectorstores import AwaDB | ||
``` | ||
|
||
For a more detailed walkthrough of the AwaDB wrapper, see [this notebook](../modules/indexes/vectorstores/examples/awadb.ipynb) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,194 @@ | ||
{ | ||
"cells": [ | ||
{ | ||
"cell_type": "markdown", | ||
"id": "833c4789", | ||
"metadata": {}, | ||
"source": [ | ||
"# AwaDB\n", | ||
"[AwaDB](https://github.com/awa-ai/awadb) is an AI Native database for the search and storage of embedding vectors used by LLM Applications.\n", | ||
"This notebook shows how to use functionality related to the AwaDB." | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "252930ea", | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"!pip install awadb" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "f2b71a47", | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"from langchain.text_splitter import CharacterTextSplitter\n", | ||
"from langchain.vectorstores import AwaDB\n", | ||
"from langchain.document_loaders import TextLoader" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "49be0bac", | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"loader = TextLoader('../../../state_of_the_union.txt')\n", | ||
"documents = loader.load()\n", | ||
"text_splitter = CharacterTextSplitter(chunk_size= 100, chunk_overlap=0)\n", | ||
"docs = text_splitter.split_documents(documents)" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "18714278", | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"db = AwaDB.from_documents(docs)\n", | ||
"query = \"What did the president say about Ketanji Brown Jackson\"\n", | ||
"docs = db.similarity_search(query)" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "62b7a4c5", | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"print(docs[0].page_content)" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "a9b4be48", | ||
"metadata": {}, | ||
"source": [ | ||
"And I did that 4 days ago, when I nominated Circuit Court of Appeals Judge Ketanji Brown Jackson. One of our nation’s top legal minds, who will continue Justice Breyer’s legacy of excellence." | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "87fec6b5", | ||
"metadata": {}, | ||
"source": [ | ||
"## Similarity search with score" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "17231924", | ||
"metadata": {}, | ||
"source": [ | ||
"The returned distance score is between 0-1. 0 is dissimilar, 1 is the most similar" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "f40ddae1", | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"docs = db.similarity_search_with_score(query)" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "f0045583", | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"print(docs[0])" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "8c2da99d", | ||
"metadata": {}, | ||
"source": [ | ||
"(Document(page_content='And I did that 4 days ago, when I nominated Circuit Court of Appeals Judge Ketanji Brown Jackson. One of our nation’s top legal minds, who will continue Justice Breyer’s legacy of excellence.', metadata={'source': '../../../state_of_the_union.txt'}), 0.561813814013747)" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "0b49fb59", | ||
"metadata": {}, | ||
"source": [ | ||
"## Restore the table created and added data before" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "1bfa6e25", | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"AwaDB automatically persists added document data" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"id": "2a0f3b35", | ||
"metadata": {}, | ||
"source": [ | ||
"If you can restore the table you created and added before, you can just do this as below:" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "1fd4b5b0", | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"awadb_client = awadb.Client()\n", | ||
"ret = awadb_client.Load('langchain_awadb')\n", | ||
"if ret : print('awadb load table success')\n", | ||
"else:\n", | ||
" print('awadb load table failed')" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"id": "5ae9a9dd", | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"awadb load table success" | ||
] | ||
} | ||
], | ||
"metadata": { | ||
"kernelspec": { | ||
"display_name": "Python 3 (ipykernel)", | ||
"language": "python", | ||
"name": "python3" | ||
}, | ||
"language_info": { | ||
"codemirror_mode": { | ||
"name": "ipython", | ||
"version": 3 | ||
}, | ||
"file_extension": ".py", | ||
"mimetype": "text/x-python", | ||
"name": "python", | ||
"nbconvert_exporter": "python", | ||
"pygments_lexer": "ipython3", | ||
"version": "3.11.1" | ||
} | ||
}, | ||
"nbformat": 4, | ||
"nbformat_minor": 5 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.