Readonly embeddingReadonly indexReadonly textMethod for adding documents to the AzureCosmosDBVectorStore. It first converts the documents to texts and then adds them as vectors.
The documents to add.
A promise that resolves when the documents have been added.
Method for adding vectors to the AzureCosmosDBVectorStore.
Vectors to be added.
Corresponding documents to be added.
A promise that resolves when the vectors and documents have been added.
Optional kOrFields: number | Partial<VectorStoreRetrieverInput<AzureCosmosDBVectorStore>>Optional filter: string | objectOptional callbacks: CallbacksOptional tags: string[]Optional metadata: Record<string, unknown>Optional verbose: booleanCreates an index on the collection with the specified index name during instance construction.
Setting the numLists parameter correctly is important for achieving good accuracy and performance. Since the vector store uses IVF as the indexing strategy, you should create the index only after you have loaded a large enough sample documents to ensure that the centroids for the respective buckets are faily distributed.
We recommend that numLists is set to documentCount/1000 for up to 1 million documents and to sqrt(documentCount) for more than 1 million documents. As the number of items in your database grows, you should tune numLists to be larger in order to achieve good latency performance for vector search.
If you're experimenting with a new scenario or creating a small demo, you can start with numLists set to 1 to perform a brute-force search across all vectors. This should provide you with the most accurate results from the vector search, however be aware that the search speed and latency will be slow. After your initial setup, you should go ahead and tune the numLists parameter using the above guidance.
This integer is the number of clusters that the inverted file (IVF) index uses to group the vector data. We recommend that numLists is set to documentCount/1000 for up to 1 million documents and to sqrt(documentCount) for more than 1 million documents. Using a numLists value of 1 is akin to performing brute-force search, which has limited performance
Number of dimensions for vector similarity. The maximum number of supported dimensions is 2000
Similarity metric to use with the IVF index. Possible options are:
A promise that resolves when the index has been created.
Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Text to look up documents similar to.
List of documents selected by maximal marginal relevance.
Optional k: numberOptional filter: string | objectOptional _callbacks: CallbacksMethod that performs a similarity search on the vectors stored in the collection. It returns a list of documents and their corresponding similarity scores.
Query vector for the similarity search.
Promise that resolves to a list of documents and their corresponding similarity scores.
Optional k: numberOptional filter: string | objectOptional _callbacks: CallbacksStatic fromStatic method to create an instance of AzureCosmosDBVectorStore from a list of documents. It first converts the documents to vectors and then adds them to the collection.
List of documents to be converted to vectors.
Embeddings to be used for conversion.
Database configuration for Azure Cosmos DB for MongoDB vCore.
Promise that resolves to a new instance of AzureCosmosDBVectorStore.
Static fromStatic method to create an instance of AzureCosmosDBVectorStore from a list of texts. It first converts the texts to vectors and then adds them to the collection.
List of texts to be converted to vectors.
Metadata for the texts.
Embeddings to be used for conversion.
Database configuration for Azure Cosmos DB for MongoDB vCore.
Promise that resolves to a new instance of AzureCosmosDBVectorStore.
Generated using TypeDoc
Azure Cosmos DB for MongoDB vCore vector store. To use this, you should have both:
mongodbNPM package installedYou do not need to create a database or collection, it will be created automatically.
Though you do need to create an index on the collection, which can be done using the
createIndexmethod.