Class MomentoVectorIndex

A vector store that uses the Momento Vector Index.

Remarks

To sign up for a free Momento account, visit https://console.gomomento.com.

Hierarchy

  • VectorStore
    • MomentoVectorIndex

Constructors

constructor

Properties

FilterType embeddings

Methods

addDocuments addVectors asRetriever delete getClient maxMarginalRelevanceSearch similaritySearch similaritySearchVectorWithScore similaritySearchWithScore toJSON toJSONNotImplemented fromDocuments fromTexts

Constructors

constructor

Properties

FilterType

FilterType: string | object

embeddings

embeddings: EmbeddingsInterface

Methods

addDocuments

  • addDocuments(documents, documentProps?): Promise<void>

  • Adds vectors to the index. Generates embeddings from the documents using the Embeddings instance passed to the constructor.

    Parameters

    • documents: Document<Record<string, any>>[]

      Array of Document instances to be added to the index.

    • OptionaldocumentProps: DocumentProps

    Returns Promise<void>

    Promise that resolves when the documents have been added to the index.

addVectors

  • addVectors(vectors, documents, documentProps?): Promise<void | string[]>

  • Adds vectors to the index.

    Parameters

    • vectors: number[][]

      The vectors to add to the index.

    • documents: Document<Record<string, any>>[]

      The documents to add to the index.

    • OptionaldocumentProps: DocumentProps

      The properties of the documents to add to the index, specifically the ids.

    Returns Promise<void | string[]>

    Promise that resolves when the vectors have been added to the index. Also returns the ids of the documents that were added.

    Remarks

    If the index does not already exist, it will be created if ensureIndexExists is true.

asRetriever

  • asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<MomentoVectorIndex>

  • Parameters

    • OptionalkOrFields: number | Partial<VectorStoreRetrieverInput<MomentoVectorIndex>>
    • Optionalfilter: string | object
    • Optionalcallbacks: Callbacks
    • Optionaltags: string[]
    • Optionalmetadata: Record<string, unknown>
    • Optionalverbose: boolean

    Returns VectorStoreRetriever<MomentoVectorIndex>

delete

getClient

maxMarginalRelevanceSearch

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

  • 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<string | object>

    Returns Promise<Document<Record<string, any>>[]>

    • List of documents selected by maximal marginal relevance.

similaritySearch

  • similaritySearch(query, k?, filter?, _callbacks?): Promise<DocumentInterface<Record<string, any>>[]>

  • Parameters

    • query: string
    • Optionalk: number
    • Optionalfilter: string | object
    • Optional_callbacks: Callbacks

    Returns Promise<DocumentInterface<Record<string, any>>[]>

similaritySearchVectorWithScore

  • similaritySearchVectorWithScore(query, k): Promise<[Document<Record<string, any>>, number][]>

  • Searches the index for the most similar vectors to the query vector.

    Parameters

    • query: number[]

      The query vector.

    • k: number

      The number of results to return.

    Returns Promise<[Document<Record<string, any>>, number][]>

    Promise that resolves to the documents of the most similar vectors to the query vector.

similaritySearchWithScore

  • similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[DocumentInterface<Record<string, any>>, number][]>

  • Parameters

    • query: string
    • Optionalk: number
    • Optionalfilter: string | object
    • Optional_callbacks: Callbacks

    Returns Promise<[DocumentInterface<Record<string, any>>, number][]>

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

StaticfromDocuments

StaticfromTexts

  • fromTexts(texts, metadatas, embeddings, dbConfig, documentProps?): Promise<MomentoVectorIndex>

  • Stores the documents in the index.

    Converts the documents to vectors using the Embeddings instance passed.

    Parameters

    • texts: string[]

      The texts to store in the index.

    • metadatas: object | object[]

      The metadata to store in the index.

    • embeddings: EmbeddingsInterface

      The embeddings instance to use to generate embeddings from the documents.

    • dbConfig: MomentoVectorIndexLibArgs

      The configuration to use to instantiate the vector store.

    • OptionaldocumentProps: DocumentProps

      The properties of the documents to add to the index, specifically the ids.

    Returns Promise<MomentoVectorIndex>

    Promise that resolves to the vector store.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods