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.
Optional _indexA 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.
Method to add documents to the vector store. It first converts the documents to vectors using the embeddings, then adds the vectors to the vector store.
The documents to be added to the vector store.
A Promise that resolves when the documents have been added.
Method to add vectors to the vector store. It first initializes the index if it hasn't been initialized yet, then adds the vectors to the index and the documents to the document store.
The vectors to be added to the vector store.
The documents corresponding to the vectors.
A Promise that resolves when the vectors and documents have been added.
Optional kOrFields: number | Partial<VectorStoreRetrieverInput<HNSWLib>>Optional filter: ((doc) => boolean)Optional callbacks: CallbacksOptional tags: string[]Optional metadata: Record<string, unknown>Optional verbose: booleanMethod to delete the vector store from a directory. It deletes the hnswlib.index file, the docstore.json file, and the args.json file from the directory.
An object with a directory property that specifies the directory from which to delete the vector store.
A Promise that resolves when the vector store has been deleted.
Method to save the vector store to a directory. It saves the HNSW index, the arguments, and the document store to the directory.
The directory to which to save the vector store.
A Promise that resolves when the vector store has been saved.
Method to perform a similarity search in the vector store using a query vector. It returns the k most similar documents along with their similarity scores. An optional filter function can be provided to filter the documents.
The query vector.
The number of most similar documents to return.
Optional filter: ((doc) => boolean)An optional filter function to filter the documents.
A Promise that resolves to an array of tuples, where each tuple contains a document and its 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 fromStatic method to create a new HNSWLib instance from documents. It creates a new HNSWLib instance, adds the documents to it, then returns the instance.
The documents to be added to the HNSWLib instance.
The embeddings to be used by the HNSWLib instance.
Optional dbConfig: { An optional configuration object for the document store.
Optional docstore?: SynchronousInMemoryDocstoreA Promise that resolves to a new HNSWLib instance.
Static fromStatic method to create a new HNSWLib instance from texts and metadata. It creates a new Document instance for each text and metadata, then calls the fromDocuments method to create the HNSWLib instance.
The texts to be used to create the documents.
The metadata to be used to create the documents.
The embeddings to be used by the HNSWLib instance.
Optional dbConfig: { An optional configuration object for the document store.
Optional docstore?: SynchronousInMemoryDocstoreA Promise that resolves to a new HNSWLib instance.
Static importsStatic lc_Static loadStatic method to load a vector store from a directory. It reads the HNSW index, the arguments, and the document store from the directory, then creates a new HNSWLib instance with these values.
The directory from which to load the vector store.
The embeddings to be used by the HNSWLib instance.
A Promise that resolves to a new HNSWLib instance.
Generated using TypeDoc
Class that implements a vector store using Hierarchical Navigable Small World (HNSW) graphs. It extends the SaveableVectorStore class and provides methods for adding documents and vectors, performing similarity searches, and saving and loading the vector store.