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

Constructors

Properties

FilterType: string | object
client: VoyClient
docstore: InternalDoc[] = []
numDimensions: null | number = null

Methods

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

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

      • Optional deleteAll?: boolean

    Returns Promise<void>

    Promise that resolves when the deletion is complete.

  • Parameters

    • query: string
    • Optional k: number
    • Optional filter: string | object
    • Optional _callbacks: Callbacks

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

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

  • Parameters

    • query: string
    • Optional k: number
    • Optional filter: string | object
    • Optional _callbacks: Callbacks

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

  • Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.

    Parameters

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

    • List of documents selected by maximal marginal relevance.
  • 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

      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.

Generated using TypeDoc