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 Vectara store.
An array of Document objects to add to the Vectara store.
A Promise that resolves when the documents have been added.
Vectara provides a way to add documents directly via their API. This API handles pre-processing and chunking internally in an optimal manner. This method is a wrapper to utilize that API within LangChain.
An array of VectaraFile objects representing the files and their respective file names to be uploaded to Vectara.
A Promise that resolves to the number of successfully uploaded files.
Throws an error, as this method is not implemented. Use addDocuments instead.
Not used.
Not used.
Does not return a value.
Optional kOrFields: number | Partial<VectorStoreRetrieverInput<VectaraStore>>Optional filter: VectaraFilterOptional callbacks: CallbacksOptional tags: string[]Optional metadata: Record<string, unknown>Optional verbose: booleanPerforms a similarity search and returns documents.
The query string for the similarity search.
Optional. The number of results to return. Default is 10.
Optional. A VectaraFilter object to refine the search results.
A Promise that resolves to an array of Document objects.
Throws an error, as this method is not implemented. Use similaritySearch or similaritySearchWithScore instead.
Not used.
Not used.
Optional _filter: VectaraFilterNot used.
Does not return a value.
Performs a similarity search and returns documents along with their scores.
The query string for the similarity search.
Optional. The number of results to return. Default is 10.
Optional. A VectaraFilter object to refine the search results.
A Promise that resolves to an array of tuples, each containing a Document and its 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 VectaraStore instance from documents.
An array of Document objects.
Not used.
A VectaraLibArgs object for initializing the VectaraStore instance.
A Promise that resolves to a VectaraStore instance.
Static fromCreates a VectaraStore instance from texts.
An array of text strings.
Metadata for the texts. Can be a single object or an array of objects.
Not used.
A VectaraLibArgs object for initializing the VectaraStore instance.
A Promise that resolves to a VectaraStore instance.
Static lc_Generated using TypeDoc
Class for interacting with the Vectara API. Extends the VectorStore class.