A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.
A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.
A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.
The final serialized identifier for the module.
A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.
Adds documents to the Voy database. The documents are embedded using embeddings provided while instantiating the class.
An array of Document instances associated with the vectors.
Adds vectors to the Voy database. The vectors are associated with the provided documents.
An array of vectors to be added to the database.
An array of Document instances associated with the vectors.
Optional kOrFields: number | Partial<VectorStoreRetrieverInput<VoyVectorStore>>Optional filter: string | objectOptional callbacks: CallbacksOptional tags: string[]Optional metadata: Record<string, unknown>Optional verbose: booleanMethod to delete data from the Voy index. It can delete data based on specific IDs or a filter.
Object that includes either an array of IDs or a filter for the data to be deleted.
Optional deletePromise that resolves when the deletion is complete.
Searches for vectors in the Voy database that are similar to the provided query vector.
The query vector.
The number of similar vectors to return.
A promise that resolves with an array of tuples, each containing a Document instance and a similarity score.
Optional maxReturn documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Text to look up documents similar to.
Static fromCreates a new VoyVectorStore instance from an array of Document instances.
The documents are added to the Voy database.
An array of Document instances.
An Embeddings instance used to generate embeddings for the documents.
An instance of Voy client to use in the underlying operations.
A promise that resolves with a new VoyVectorStore instance.
Static fromCreates a new VoyVectorStore instance from an array of text strings. The text
strings are converted to Document instances and added to the Voy
database.
An array of text strings.
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.
An Embeddings instance used to generate embeddings for the documents.
An instance of Voy client to use in the underlying operations.
A promise that resolves with a new VoyVectorStore instance.
Static lc_Generated using TypeDoc
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.