Class HNSWLib

constructor

• new HNSWLib(embeddings, args): HNSWLib

• Parameters

  • embeddings: EmbeddingsInterface
  • args: HNSWLibArgs

  Returns HNSWLib

FilterType

args

docstore

index

• get index(): HierarchicalNSW

• Returns HierarchicalNSW

• set index(index): void

• Parameters

  • index: HierarchicalNSW

  Returns void

addDocuments

• addDocuments(documents): Promise<void>

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

  Parameters

  • documents: Document[]

    The documents to be added to the vector store.

  Returns Promise<void>

  A Promise that resolves when the documents have been added.

addVectors

• addVectors(vectors, documents): Promise<void>

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

  Parameters

  • vectors: number[][]

    The vectors to be added to the vector store.
  • documents: Document[]

    The documents corresponding to the vectors.

  Returns Promise<void>

  A Promise that resolves when the vectors and documents have been added.

delete

• delete(params): Promise<void>

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

  Parameters

  • params: {
        directory: string;
    }

    An object with a directory property that specifies the directory from which to delete the vector store.

    • directory: string

  Returns Promise<void>

  A Promise that resolves when the vector store has been deleted.

save

• save(directory): Promise<void>

• Method to save the vector store to a directory. It saves the HNSW index, the arguments, and the document store to the directory.

  Parameters

  • directory: string

    The directory to which to save the vector store.

  Returns Promise<void>

  A Promise that resolves when the vector store has been saved.

similaritySearchVectorWithScore

• similaritySearchVectorWithScore(query, k, filter?): Promise<[Document, number][]>

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

  Parameters

  • query: number[]

    The query vector.
  • k: number

    The number of most similar documents to return.
  • Optionalfilter: ((doc: Document) => boolean)

    An optional filter function to filter the documents.

    • • (doc): boolean

      • Parameters

        • doc: Document

        Returns boolean

  Returns Promise<[Document, number][]>

  A Promise that resolves to an array of tuples, where each tuple contains a document and its similarity score.

StaticfromDocuments

• fromDocuments(docs, embeddings, dbConfig?): Promise<HNSWLib>

• Static method to create a new HNSWLib instance from documents. It creates a new HNSWLib instance, adds the documents to it, then returns the instance.

  Parameters

  • docs: Document[]

    The documents to be added to the HNSWLib instance.
  • embeddings: EmbeddingsInterface

    The embeddings to be used by the HNSWLib instance.
  • OptionaldbConfig: {
        docstore?: SynchronousInMemoryDocstore;
    }

    An optional configuration object for the document store.

    • Optionaldocstore?: SynchronousInMemoryDocstore

  Returns Promise<HNSWLib>

  A Promise that resolves to a new HNSWLib instance.

StaticfromTexts

• fromTexts(texts, metadatas, embeddings, dbConfig?): Promise<HNSWLib>

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

  Parameters

  • texts: string[]

    The texts to be used to create the documents.
  • metadatas: object | object[]

    The metadata to be used to create the documents.
  • embeddings: EmbeddingsInterface

    The embeddings to be used by the HNSWLib instance.
  • OptionaldbConfig: {
        docstore?: SynchronousInMemoryDocstore;
    }

    An optional configuration object for the document store.

    • Optionaldocstore?: SynchronousInMemoryDocstore

  Returns Promise<HNSWLib>

  A Promise that resolves to a new HNSWLib instance.

Staticimports

• imports(): Promise<{
      HierarchicalNSW: typeof HierarchicalNSW;
  }>

• Returns Promise<{
      HierarchicalNSW: typeof HierarchicalNSW;
  }>

Staticload

• load(directory, embeddings): Promise<HNSWLib>

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

  Parameters

  • directory: string

    The directory from which to load the vector store.
  • embeddings: EmbeddingsInterface

    The embeddings to be used by the HNSWLib instance.

  Returns Promise<HNSWLib>

  A Promise that resolves to a new HNSWLib instance.