Vector Database (powered by LangChain) [ARCHIVED]
The vector db destination destination has been split into separate destinations per vector database. This destination will not receive any further updates and is not subject to SLAs. The separate destinations support all features of this destination and are actively maintained. Please migrate to the respective destination as soon as possible.
Please use the respective destination for the vector database you want to use to ensure you receive updates and support.
To following databases are supported:
Overview
This destination prepares data to be used by Langchain to retrieve relevant context for question answering use cases.
There are three parts to this:
- Processing - split up individual records in chunks so they will fit the context window and decide which fields to use as context and which are supplementary metadata.
- Embedding - convert the text into a vector representation using a pre-trained model (currently only OpenAI
text-embedding-ada-002is supported) - Indexing - store the vectors in a vector database for similarity search
Processing
Each record will be split into text fields and meta fields as configured in the "Processing" section. All text fields are concatenated into a single string and then split into chunks of configured length. The meta fields are stored as-is along with the embedded text chunks. Please note that meta data fields can only be used for filtering and not for retrieval and have to be of type string, number, boolean (all other values are ignored). Depending on the chosen vector store, additional limitations might apply.
When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array.
The chunk length is measured in tokens produced by the tiktoken library. The maximum is 8191 tokens, which is the maximum length supported by the text-embedding-ada-002 model.
The stream name gets added as a metadata field _airbyte_stream to each document. If available, the primary key of the record is used to identify the document to avoid duplications when updated versions of records are indexed. It is added as the _record_id metadata field.
Embedding
THe OpenAI embedding API is used to calculate embeddings - see OpenAI API for details. To do so, an OpenAI API key is required.
This integration will be constrained by the speed of the OpenAI embedding API.
For testing purposes, it's also possible to use the Fake embeddings integration. It will generate random embeddings and is suitable to test a data pipeline without incurring embedding costs.
Indexing
Pinecone vector store
For production use, use the pinecone vector store. Use the Pinecone web UI or API to create a project and an index before running the destination. All streams will be indexed into the same index, the _airbyte_stream metadata field is used to distinguish between streams. Overall, the size of the metadata fields is limited to 30KB per document. Both OpenAI and Fake embeddings are produced with 1536 vector dimensions, make sure to configure the index accordingly.
To initialize a langchain QA chain based on the indexed data, use the following code (set the open API key and pinecone key and environment as OPENAI_API_KEY, PINECONE_KEY and PINECONE_ENV env variables):
from langchain import OpenAI
from langchain.chains import RetrievalQA
from langchain.llms import OpenAI
from langchain.vectorstores import Pinecone
from langchain.embeddings import OpenAIEmbeddings
import pinecone
import os
embeddings = OpenAIEmbeddings()
pinecone.init(api_key=os.environ["PINECONE_KEY"], environment=os.environ["PINECONE_ENV"])
index = pinecone.Index("<your pinecone index name>")
vector_store = Pinecone(index, embeddings.embed_query, "text")
qa = RetrievalQA.from_chain_type(llm=OpenAI(temperature=0), chain_type="stuff", retriever=vector_store.as_retriever())
For Pinecone pods of type starter, only up to 10,000 chunks can be indexed. For production use, please use a higher tier.
Chroma vector store
The Chroma vector store is running the Chroma embedding database as persistent client and stores the vectors in a local file.
The destination_path has to start with /local. Any directory nesting within local will be mapped onto the local mount.
By default, the LOCAL_ROOT env variable in the .env file is set /tmp/airbyte_local.
The local mount is mounted by Docker onto LOCAL_ROOT. This means the /local is substituted by /tmp/airbyte_local by default.
To initialize a langchain QA chain based on the indexed data, use the following code (set the openai API key as OPENAI_API_KEY env variable):
from langchain import OpenAI
from langchain.chains import RetrievalQA
from langchain.llms import OpenAI
from langchain.vectorstores import Chroma
from langchain.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
vector_store = Chroma(embedding_function=embeddings, persist_directory="/tmp/airbyte_local/<your configured directory>")
qa = RetrievalQA.from_chain_type(llm=OpenAI(temperature=0), chain_type="stuff", retriever=vector_store.as_retriever())
Chroma is meant to be used on a local workstation and won't work on Kubernetes.
Please make sure that Docker Desktop has access to /tmp (and /private on a MacOS, as /tmp has a symlink that points to /private. It will not work otherwise). You allow it with "File sharing" in Settings -> Resources -> File sharing -> add the one or two above folder and hit the "Apply & restart" button.
DocArrayHnswSearch vector store
For local testing, the DocArrayHnswSearch is recommended - it stores the vectors in a local file with a sqlite database for metadata. It is not suitable for production use, but it is the easiest to set up for testing and development purposes.
The destination_path has to start with /local. Any directory nesting within local will be mapped onto the local mount.
By default, the LOCAL_ROOT env variable in the .env file is set /tmp/airbyte_local.
The local mount is mounted by Docker onto LOCAL_ROOT. This means the /local is substituted by /tmp/airbyte_local by default.
DocArrayHnswSearch does not support incremental sync, so the destination will always do a full refresh sync.
To initialize a langchain QA chain based on the indexed data, use the following code (set the openai API key as OPENAI_API_KEY env variable):
from langchain import OpenAI
from langchain.chains import RetrievalQA
from langchain.llms import OpenAI
from langchain.vectorstores import DocArrayHnswSearch
from langchain.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
vector_store = DocArrayHnswSearch.from_params(embeddings, "/tmp/airbyte_local/<your configured directory>", 1536)
qa = RetrievalQA.from_chain_type(llm=OpenAI(temperature=0), chain_type="stuff", retriever=vector_store.as_retriever())
This destination will delete all existing files in the configured directory on each. Make sure to not use a directory that contains other files.
DocArrayHnswSearch is meant to be used on a local workstation and won't work on Kubernetes.
Please make sure that Docker Desktop has access to /tmp (and /private on a MacOS, as /tmp has a symlink that points to /private. It will not work otherwise). You allow it with "File sharing" in Settings -> Resources -> File sharing -> add the one or two above folder and hit the "Apply & restart" button.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.1.2 | 2023-11-13 | #32455 | Fix build |
| 0.1.1 | 2023-09-01 | #30282 | Use embedders from CDK |
| 0.1.0 | 2023-09-01 | #30080 | Fix bug with potential data loss on append+dedup syncing. 🚨 Streams using append+dedup mode need to be reset after upgrade. |
| 0.0.8 | 2023-08-21 | #29515 | Clean up generated schema spec |
| 0.0.7 | 2023-08-18 | #29513 | Fix for starter pods |
| 0.0.6 | 2023-08-02 | #28977 | Validate pinecone index dimensions during check |
| 0.0.5 | 2023-07-25 | #28605 | Add Chroma support |
| 0.0.4 | 2023-07-21 | #28556 | Correctly dedupe records with composite and nested primary keys |
| 0.0.3 | 2023-07-20 | #28509 | Change the base image to python:3.9-slim to fix build |
| 0.0.2 | 2023-07-18 | #26184 | Adjust python dependencies and release on cloud |
| 0.0.1 | 2023-07-12 | #26184 | Initial release |