Class VoyVectorStore

constructor

• new VoyVectorStore(client, embeddings): VoyVectorStore

• Parameters

  • client: VoyClient

  • embeddings: EmbeddingsInterface

  Returns VoyVectorStore

client

docstore

numDimensions

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>

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.

    • Optional deleteAll?: boolean

  Returns Promise<void>

  Promise that resolves when the deletion is complete.

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.

Static fromDocuments

• 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

    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.

Static fromTexts

• 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

    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.