Class MongoDBAtlasVectorSearch

constructor

• new MongoDBAtlasVectorSearch(embeddings, args): MongoDBAtlasVectorSearch

• Parameters

  • embeddings: EmbeddingsInterface
  • args: MongoDBAtlasVectorSearchLibArgs

  Returns MongoDBAtlasVectorSearch

FilterType

addDocuments

• addDocuments(documents, options?): Promise<any[]>

• Method to add documents to the MongoDB collection. It first converts the documents to vectors using the embeddings and then calls the addVectors method.

  Parameters

  • documents: Document[]

    Documents to be added.
  • Optionaloptions: {
        ids?: string[];
    }

    • Optionalids?: string[]

  Returns Promise<any[]>

  Promise that resolves when the documents have been added.

addVectors

• addVectors(vectors, documents, options?): Promise<any[]>

• Method to add vectors and their corresponding documents to the MongoDB collection.

  Parameters

  • vectors: number[][]

    Vectors to be added.
  • documents: Document[]

    Corresponding documents to be added.
  • Optionaloptions: {
        ids?: string[];
    }

    • Optionalids?: string[]

  Returns Promise<any[]>

  Promise that resolves when the vectors and documents have been added.

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(query, k, filter?): Promise<[Document, number][]>

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

  Parameters

  • query: number[]

    Query vector for the similarity search.
  • k: number

    Number of nearest neighbors to return.
  • Optionalfilter: MongoDBAtlasFilter

    Optional filter to be applied.

  Returns Promise<[Document, number][]>

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

StaticfixArrayPrecision

• fixArrayPrecision(array): number[]

• Static method to fix the precision of the array that ensures that every number in this array is always float when casted to other types. This is needed since MongoDB Atlas Vector Search does not cast integer inside vector search to float automatically. This method shall introduce a hint of error but should be safe to use since introduced error is very small, only applies to integer numbers returned by embeddings, and most embeddings shall not have precision as high as 15 decimal places.

  Parameters

  • array: number[]

    Array of number to be fixed.

  Returns number[]

StaticfromDocuments

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

• Static method to create an instance of MongoDBAtlasVectorSearch from a list of documents. It first converts the documents to vectors and then adds them to the MongoDB collection.

  Parameters

  • docs: Document[]

    List of documents to be converted to vectors.
  • embeddings: EmbeddingsInterface

    Embeddings to be used for conversion.
  • dbConfig: MongoDBAtlasVectorSearchLibArgs & {
        ids?: string[];
    }

    Database configuration for MongoDB Atlas.

  Returns Promise<MongoDBAtlasVectorSearch>

  Promise that resolves to a new instance of MongoDBAtlasVectorSearch.

StaticfromTexts

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

• Static method to create an instance of MongoDBAtlasVectorSearch from a list of texts. It first converts the texts to vectors and then adds them to the MongoDB 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: MongoDBAtlasVectorSearchLibArgs & {
        ids?: string[];
    }

    Database configuration for MongoDB Atlas.

  Returns Promise<MongoDBAtlasVectorSearch>

  Promise that resolves to a new instance of MongoDBAtlasVectorSearch.