Interface VectorStoreInterface<Metadata>

FilterType

embeddings

addDocuments

• addDocuments(documents, options?): Promise<void | string[]>

• Parameters

  • documents: DocumentInterface<Metadata>[]

  • Optional options: AddDocumentOptions

  Returns Promise<void | string[]>

addVectors

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

• Parameters

  • vectors: number[][]

  • documents: DocumentInterface<Metadata>[]

  • Optional options: AddDocumentOptions

  Returns Promise<void | string[]>

asRetriever

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

• Parameters

  • Optional kOrFields: number | Partial<BaseRetrieverInput & {
        vectorStore: VectorStoreInterface<Metadata>;
        filter?: string | object;
        k?: number;
        searchType?: "similarity";
    }> | Partial<BaseRetrieverInput & {
        searchType: "mmr";
        vectorStore: VectorStoreInterface<Metadata>;
        filter?: string | object;
        k?: number;
        searchKwargs?: VectorStoreRetrieverMMRSearchKwargs;
    }>

  • Optional filter: string | object

  • Optional callbacks: CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[]

  • Optional tags: string[]

  • Optional metadata: Record<string, unknown>

  • Optional verbose: boolean

  Returns VectorStoreRetriever<VectorStoreInterface<Metadata>, Metadata>

delete

• delete(_params?): Promise<void>

• Parameters

  • Optional _params: Record<string, any>

  Returns Promise<void>

similaritySearch

• similaritySearch(query, k?, filter?, callbacks?): Promise<DocumentInterface<Metadata>[]>

• Parameters

  • query: string

  • Optional k: number

  • Optional filter: string | object

  • Optional callbacks: CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[]

  Returns Promise<DocumentInterface<Metadata>[]>

similaritySearchVectorWithScore

• similaritySearchVectorWithScore(query, k, filter?): Promise<[DocumentInterface<Metadata>, number][]>

• Parameters

  • query: number[]

  • k: number

  • Optional filter: string | object

  Returns Promise<[DocumentInterface<Metadata>, number][]>

similaritySearchWithScore

• similaritySearchWithScore(query, k?, filter?, callbacks?): Promise<[DocumentInterface<Metadata>, number][]>

• Parameters

  • query: string

  • Optional k: number

  • Optional filter: string | object

  • Optional callbacks: CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[]

  Returns Promise<[DocumentInterface<Metadata>, number][]>

Optional maxMarginalRelevanceSearch

• maxMarginalRelevanceSearch(query, options, callbacks): Promise<DocumentInterface<Metadata>[]>

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

  • callbacks: undefined | CallbackManager | (BaseCallbackHandlerMethodsClass | BaseCallbackHandler)[]

  Returns Promise<DocumentInterface<Metadata>[]>

  • List of documents selected by maximal marginal relevance.