Class VoyVectorStore

Class that extends VectorStore. It allows to perform similarity search using Voi similarity search engine. The class requires passing Voy Client as an input parameter.

Hierarchy

  • VectorStore
    • VoyVectorStore

Constructors

constructor

Properties

FilterType client docstore embeddings numDimensions

Methods

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

Constructors

constructor

Properties

FilterType

FilterType: string | object

Defines the filter type used in search and delete operations. Can be an object for structured conditions or a string for simpler filtering.

client

client: VoyClient

docstore

docstore: InternalDoc[] = []

embeddings

embeddings: EmbeddingsInterface<number[]>

Embeddings interface for generating vector embeddings from text queries, enabling vector-based similarity searches.

numDimensions

numDimensions: null | number = null

Methods

addDocuments

  • addDocuments(documents): Promise<void>

  • Adds documents to the Voy database. The documents are embedded using embeddings provided while instantiating the class.

    Parameters

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

      An array of Document instances associated with the vectors.

    Returns Promise<void>

addVectors

  • addVectors(vectors, documents): Promise<void>

  • Adds vectors to the Voy database. The vectors are associated with the provided documents.

    Parameters

    • vectors: number[][]

      An array of vectors to be added to the database.

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

      An array of Document instances associated with the vectors.

    Returns Promise<void>

asRetriever

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

  • Creates a VectorStoreRetriever instance with flexible configuration options.

    Parameters

    • OptionalkOrFields: number | Partial<VectorStoreRetrieverInput<VoyVectorStore>>

      If a number is provided, it sets the k parameter (number of items to retrieve).

      • If an object is provided, it should contain various configuration options.
    • Optionalfilter: string | object

      Optional filter criteria to limit the items retrieved based on the specified filter type.

    • Optionalcallbacks: Callbacks

      Optional callbacks that may be triggered at specific stages of the retrieval process.

    • Optionaltags: string[]

      Tags to categorize or label the VectorStoreRetriever. Defaults to an empty array if not provided.

    • Optionalmetadata: Record<string, unknown>

      Additional metadata as key-value pairs to add contextual information for the retrieval process.

    • Optionalverbose: boolean

      If true, enables detailed logging for the retrieval process. Defaults to false.

    Returns VectorStoreRetriever<VoyVectorStore>

    • A configured VectorStoreRetriever instance based on the provided parameters.

    Example

    Basic usage with a k value:

    const retriever = myVectorStore.asRetriever(5);

    Usage with a configuration object:

    const retriever = myVectorStore.asRetriever({
      k: 10,
      filter: myFilter,
      tags: ['example', 'test'],
      verbose: true,
      searchType: 'mmr',
      searchKwargs: { alpha: 0.5 },
    });

delete

  • delete(params): Promise<void>

  • Method to delete data from the Voy index. It can delete data based on specific IDs or a filter.

    Parameters

    • params: {
          deleteAll?: boolean;
      }

      Object that includes either an array of IDs or a filter for the data to be deleted.

      • OptionaldeleteAll?: boolean

    Returns Promise<void>

    Promise that resolves when the deletion is complete.

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>>[]>

  • Searches for documents similar to a text query by embedding the query and performing a similarity search on the resulting vector.

    Parameters

    • query: string

      Text query for finding similar documents.

    • Optionalk: number

      Number of similar results to return. Defaults to 4.

    • Optionalfilter: string | object

      Optional filter based on FilterType.

    • Optional_callbacks: Callbacks

      Optional callbacks for monitoring search progress

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

    A promise resolving to an array of DocumentInterface instances representing similar documents.

similaritySearchVectorWithScore

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

  • Searches for vectors in the Voy database that are similar to the provided query vector.

    Parameters

    • query: number[]

      The query vector.

    • k: number

      The number of similar vectors to return.

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

    A promise that resolves with an array of tuples, each containing a Document instance and a similarity score.

similaritySearchWithScore

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

  • Searches for documents similar to a text query by embedding the query, and returns results with similarity scores.

    Parameters

    • query: string

      Text query for finding similar documents.

    • Optionalk: number

      Number of similar results to return. Defaults to 4.

    • Optionalfilter: string | object

      Optional filter based on FilterType.

    • Optional_callbacks: Callbacks

      Optional callbacks for monitoring search progress

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

    A promise resolving to an array of tuples, each containing a document and its similarity score.

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

StaticfromDocuments

  • fromDocuments(docs, embeddings, client): Promise<VoyVectorStore>

  • Creates a new VoyVectorStore instance from an array of Document instances. The documents are added to the Voy database.

    Parameters

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

      An array of Document instances.

    • embeddings: EmbeddingsInterface<number[]>

      An Embeddings instance used to generate embeddings for the documents.

    • client: VoyClient

      An instance of Voy client to use in the underlying operations.

    Returns Promise<VoyVectorStore>

    A promise that resolves with a new VoyVectorStore instance.

StaticfromTexts

  • fromTexts(texts, metadatas, embeddings, client): Promise<VoyVectorStore>

  • Creates a new VoyVectorStore instance from an array of text strings. The text strings are converted to Document instances and added to the Voy database.

    Parameters

    • texts: string[]

      An array of text strings.

    • metadatas: object | object[]

      An array of metadata objects or a single metadata object. If an array is provided, it must have the same length as the texts array.

    • embeddings: EmbeddingsInterface<number[]>

      An Embeddings instance used to generate embeddings for the documents.

    • client: VoyClient

      An instance of Voy client to use in the underlying operations.

    Returns Promise<VoyVectorStore>

    A promise that resolves with a new VoyVectorStore instance.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods