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.

Hierarchy

  • CloseVector<CloseVectorHNSWNode>
    • CloseVectorNode

Constructors

Properties

FilterType: ((doc) => boolean)

Type declaration

    • (doc): boolean
    • Parameters

      • doc: Document<Record<string, any>>

      Returns boolean

credentials?: CloseVectorCredentials

Accessors

Methods

  • 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<Record<string, any>>[]

      The documents to be added to the vector store.

    Returns Promise<void>

    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.

    Parameters

    • vectors: number[][]

      The vectors to be added to the vector store.

    • documents: Document<Record<string, any>>[]

      The documents corresponding to the vectors.

    Returns Promise<void>

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

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

  • 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. In CloseVector, we use IndexedDB to mock the file system. Therefore, this parameter is can be treated as a key to the contents stored.

    Returns Promise<void>

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

  • Method to save the index to the CloseVector CDN.

    Parameters

    • options: {
          credentials?: CloseVectorCredentials;
          description?: string;
          onProgress?: ((progress) => void);
          public?: boolean;
          uuid?: string;
      }
      • Optional credentials?: CloseVectorCredentials

        the credentials to be used to access the CloseVector API

      • Optional description?: string

        a description of the index

      • Optional onProgress?: ((progress) => void)

        a callback function to track the upload progress

          • (progress): void
          • a callback function to track the upload progress

            Parameters

            • progress: {
                  loaded: number;
                  total: number;
              }
              • loaded: number
              • total: number

            Returns void

      • Optional public?: boolean

        a boolean to determine if the index should be public or private, if not provided, the index will be private. If the index is public, it can be accessed by anyone with the uuid.

      • Optional uuid?: string

        after uploading the index to the CloseVector CDN, the uuid of the index can be obtained by instance.uuid

    Returns Promise<void>

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

    • Optional filter: ((doc) => boolean)

      An optional filter function to filter the documents.

        • (doc): boolean
        • Parameters

          • doc: Document<Record<string, any>>

          Returns boolean

    Returns Promise<[Document<Record<string, unknown>>, number][]>

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

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

    Parameters

    • docs: Document<Record<string, any>>[]

      The documents to be added to the HNSWLib instance.

    • embeddings: EmbeddingsInterface

      The embeddings to be used by the HNSWLib instance.

    • Optional args: Record<string, unknown>

      An optional configuration object for the HNSWLib instance.

    • Optional credentials: CloseVectorCredentials

      An optional credential object for the CloseVector API.

    Returns Promise<CloseVectorNode>

    A Promise that resolves to a new CloseVectorNode instance.

  • Static method to create a new CloseVectorWeb instance from texts and metadata. It creates a new Document instance for each text and metadata, then calls the fromDocuments method to create the CloseVectorWeb 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 CloseVectorWeb instance.

    • Optional args: Record<string, unknown>

      An optional configuration object for the CloseVectorWeb instance.

    • Optional credential: CloseVectorCredentials

      An optional credential object for the CloseVector API.

    Returns Promise<CloseVectorNode>

    A Promise that resolves to a new CloseVectorWeb instance.

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

    • Optional credentials: CloseVectorCredentials

    Returns Promise<CloseVectorNode>

    A Promise that resolves to a new CloseVectorNode instance.

  • Method to load the index from the CloseVector CDN.

    Parameters

    • options: {
          embeddings: EmbeddingsInterface;
          uuid: string;
          credentials?: CloseVectorCredentials;
          onProgress?: ((progress) => void);
      }
      • embeddings: EmbeddingsInterface

        the embeddings to be used by the CloseVectorWeb instance

      • uuid: string

        after uploading the index to the CloseVector CDN, the uuid of the index can be obtained by instance.uuid

      • Optional credentials?: CloseVectorCredentials

        the credentials to be used to access the CloseVector API

      • Optional onProgress?: ((progress) => void)

        a callback function to track the download progress

          • (progress): void
          • a callback function to track the download progress

            Parameters

            • progress: {
                  loaded: number;
                  total: number;
              }
              • loaded: number
              • total: number

            Returns void

    Returns Promise<CloseVectorNode>

Generated using TypeDoc