Class AzureCosmosDBVectorStore

constructor

• new AzureCosmosDBVectorStore(embeddings, dbConfig): AzureCosmosDBVectorStore

• Parameters

  • embeddings: EmbeddingsInterface

  • dbConfig: AzureCosmosDBConfig

  Returns AzureCosmosDBVectorStore

Readonly embeddingKey

Readonly indexName

Readonly textKey

addDocuments

• addDocuments(documents): Promise<string[]>

• Method for adding documents to the AzureCosmosDBVectorStore. It first converts the documents to texts and then adds them as vectors.

  Parameters

  • documents: DocumentInterface[]

    The documents to add.

  Returns Promise<string[]>

  A promise that resolves to the added documents IDs.

addVectors

• addVectors(vectors, documents): Promise<string[]>

• Method for adding vectors to the AzureCosmosDBVectorStore.

  Parameters

  • vectors: number[][]

    Vectors to be added.

  • documents: DocumentInterface[]

    Corresponding documents to be added.

  Returns Promise<string[]>

  A promise that resolves to the added documents IDs.

checkIndexExists

• checkIndexExists(): Promise<boolean>

• Checks if the specified index name during instance construction exists on the collection.

  Returns Promise<boolean>

  A promise that resolves to a boolean indicating if the index exists.

close

• close(): Promise<void>

• Closes any newly instanciated Azure Cosmos DB client. If the client was passed in the constructor, it will not be closed.

  Returns Promise<void>

  A promise that resolves when any newly instanciated Azure Cosmos DB client been closed.

createIndex

• createIndex(numLists?, dimensions?, similarity?): Promise<void>

• Creates 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.

  Parameters

  • numLists: number = 100

    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

  • dimensions: undefined | number = undefined

    Number of dimensions for vector similarity. The maximum number of supported dimensions is 2000. If no number is provided, it will be determined automatically by embedding a short text.

  • similarity: AzureCosmosDBSimilarityType = AzureCosmosDBSimilarityType.COS

    Similarity metric to use with the IVF index. Possible options are:

    • CosmosDBSimilarityType.COS (cosine distance)
    • CosmosDBSimilarityType.L2 (Euclidean distance)
    • CosmosDBSimilarityType.IP (inner product)

  Returns Promise<void>

  A promise that resolves when the index has been created.

delete

• delete(params?): Promise<void>

• Removes specified documents from the AzureCosmosDBVectorStore. If no IDs or filter are specified, all documents will be removed.

  Parameters

  • params: string[] | AzureCosmosDBDeleteParams = {}

    Parameters for the delete operation.

  Returns Promise<void>

  A promise that resolves when the documents have been removed.

deleteIndex

• deleteIndex(): Promise<void>

• Deletes the index specified during instance construction if it exists.

  Returns Promise<void>

  A promise that resolves when the index has been deleted.

maxMarginalRelevanceSearch

• maxMarginalRelevanceSearch(query, options): Promise<Document[]>

• Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.

  Parameters

  • query: string

    Text to look up documents similar to.

  • options: MaxMarginalRelevanceSearchOptions<this["FilterType"]>

  Returns Promise<Document[]>

  List of documents selected by maximal marginal relevance.

similaritySearchVectorWithScore

• similaritySearchVectorWithScore(queryVector, k?): Promise<[Document, number][]>

• Method that performs a similarity search on the vectors stored in the collection. It returns a list of documents and their corresponding similarity scores.

  Parameters

  • queryVector: number[]

    Query vector for the similarity search.

  • k: number = 4

  Returns Promise<[Document, number][]>

  Promise that resolves to a list of documents and their corresponding similarity scores.

Static fromDocuments

• fromDocuments(docs, embeddings, dbConfig): Promise<AzureCosmosDBVectorStore>

• Static 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.

  Parameters

  • docs: Document[]

    List of documents to be converted to vectors.

  • embeddings: EmbeddingsInterface

    Embeddings to be used for conversion.

  • dbConfig: AzureCosmosDBConfig

    Database configuration for Azure Cosmos DB for MongoDB vCore.

  Returns Promise<AzureCosmosDBVectorStore>

  Promise that resolves to a new instance of AzureCosmosDBVectorStore.

Static fromTexts

• fromTexts(texts, metadatas, embeddings, dbConfig): Promise<AzureCosmosDBVectorStore>

• Static 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.

  Parameters

  • texts: string[]

    List of texts to be converted to vectors.

  • metadatas: object | object[]

    Metadata for the texts.

  • embeddings: EmbeddingsInterface

    Embeddings to be used for conversion.

  • dbConfig: AzureCosmosDBConfig

    Database configuration for Azure Cosmos DB for MongoDB vCore.

  Returns Promise<AzureCosmosDBVectorStore>

  Promise that resolves to a new instance of AzureCosmosDBVectorStore.