Class AzureCosmosDBNoSQLVectorStore

constructor

• new AzureCosmosDBNoSQLVectorStore(embeddings, dbConfig): AzureCosmosDBNoSQLVectorStore

• Parameters

  • embeddings: EmbeddingsInterface
  • dbConfig: AzureCosmosDBNoSQLConfig

  Returns AzureCosmosDBNoSQLVectorStore

FilterType

initialize

addDocuments

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

• Method for adding documents to the AzureCosmosDBNoSQLVectorStore. 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 AzureCosmosDBNoSQLVectorStore.

  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.

delete

• delete(params?): Promise<void>

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

  Parameters

  • params: AzureCosmosDBNoSqlDeleteParams = {}

    Parameters for the delete operation.

  Returns Promise<void>

  A promise that resolves when the documents have been removed.

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.

similaritySearch

• similaritySearch(query, k?, filter?): Promise<Document[]>

• Performs a similarity search on the vectors stored in the container.

  Parameters

  • query: string

    Query text for the similarity search.
  • k: number = 4
  • filter: undefined | AzureCosmosDBNoSQLFilterType = undefined

    Optional filter options for the documents.

  Returns Promise<Document[]>

  Promise that resolves to a list of documents.

similaritySearchVectorWithScore

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

• Performs a similarity search on the vectors stored in the container.

  Parameters

  • queryVector: number[]

    Query vector for the similarity search.
  • k: number = 4
  • filter: undefined | AzureCosmosDBNoSQLFilterType = undefined

    Optional filter options for the documents.

  Returns Promise<[Document, number][]>

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

StaticfromDocuments

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

• Static method to create an instance of AzureCosmosDBNoSQLVectorStore 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: AzureCosmosDBNoSQLConfig

    Database configuration for Azure Cosmos DB for NoSQL.

  Returns Promise<AzureCosmosDBNoSQLVectorStore>

  Promise that resolves to a new instance of AzureCosmosDBNoSQLVectorStore.

StaticfromTexts

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

• Static method to create an instance of AzureCosmosDBNoSQLVectorStore 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: AzureCosmosDBNoSQLConfig

    Database configuration for Azure Cosmos DB for NoSQL.

  Returns Promise<AzureCosmosDBNoSQLVectorStore>

  Promise that resolves to a new instance of AzureCosmosDBNoSQLVectorStore.