Class SaveableVectorStoreAbstract

FilterType

embeddings

AbstractaddDocuments

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

• Parameters

  • documents: DocumentInterface<Record<string, any>>[]
  • Optionaloptions: AddDocumentOptions

  Returns Promise<void | string[]>

AbstractaddVectors

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

• Parameters

  • vectors: number[][]
  • documents: DocumentInterface<Record<string, any>>[]
  • Optionaloptions: AddDocumentOptions

  Returns Promise<void | string[]>

asRetriever

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

• Parameters

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

  Returns VectorStoreRetriever<SaveableVectorStore>

delete

• delete(_params?): Promise<void>

• Parameters

  • Optional_params: Record<string, any>

  Returns Promise<void>

OptionalmaxMarginalRelevanceSearch

• maxMarginalRelevanceSearch(query, options, _callbacks): Promise<DocumentInterface<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>
  • _callbacks: undefined | Callbacks

  Returns Promise<DocumentInterface<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
  • k: number = 4
  • filter: undefined | string | object = undefined
  • _callbacks: undefined | Callbacks = undefined

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

AbstractsimilaritySearchVectorWithScore

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

• Parameters

  • query: number[]
  • k: number
  • Optionalfilter: string | object

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

similaritySearchWithScore

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

• Parameters

  • query: string
  • k: number = 4
  • filter: undefined | string | object = undefined
  • _callbacks: undefined | Callbacks = undefined

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

toJSON

• toJSON(): Serialized

• Returns Serialized

toJSONNotImplemented

• toJSONNotImplemented(): SerializedNotImplemented

• Returns SerializedNotImplemented

StaticfromDocuments

• fromDocuments(_docs, _embeddings, _dbConfig): Promise<VectorStore>

• Parameters

  • _docs: DocumentInterface<Record<string, any>>[]
  • _embeddings: EmbeddingsInterface
  • _dbConfig: Record<string, any>

  Returns Promise<VectorStore>

StaticfromTexts

• fromTexts(_texts, _metadatas, _embeddings, _dbConfig): Promise<VectorStore>

• Parameters

  • _texts: string[]
  • _metadatas: object | object[]
  • _embeddings: EmbeddingsInterface
  • _dbConfig: Record<string, any>

  Returns Promise<VectorStore>