Class FaissStore

constructor

• new FaissStore(embeddings, args): FaissStore

• Parameters

  • embeddings: EmbeddingsInterface

  • args: FaissLibArgs

  Returns FaissStore

args

docstore

index

• get index(): IndexFlatL2

• Returns IndexFlatL2

• set index(index): void

• Parameters

  • index: IndexFlatL2

  Returns void

addDocuments

• addDocuments(documents, options?): Promise<string[]>

• Adds an array of Document objects to the store.

  Parameters

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

    An array of Document objects.

  • Optional options: {
        ids?: string[];
    }

    • Optional ids?: string[]

  Returns Promise<string[]>

  A Promise that resolves when the documents have been added.

addVectors

• addVectors(vectors, documents, options?): Promise<string[]>

• Adds an array of vectors and their corresponding Document objects to the store.

  Parameters

  • vectors: number[][]

    An array of vectors.

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

    An array of Document objects corresponding to the vectors.

  • Optional options: {
        ids?: string[];
    }

    • Optional ids?: string[]

  Returns Promise<string[]>

  A Promise that resolves with an array of document IDs when the vectors and documents have been added.

delete

• delete(params): Promise<void>

• Method to delete documents.

  Parameters

  • params: {
        ids: string[];
    }

    Object containing the IDs of the documents to delete.

    • ids: string[]

  Returns Promise<void>

  A promise that resolves when the deletion is complete.

getDocstore

• getDocstore(): SynchronousInMemoryDocstore

• Returns SynchronousInMemoryDocstore

getMapping

• getMapping(): Record<number, string>

• Returns Record<number, string>

mergeFrom

• mergeFrom(targetIndex): Promise<string[]>

• Merges the current FaissStore with another FaissStore.

  Parameters

  • targetIndex: FaissStore

    The FaissStore to merge with.

  Returns Promise<string[]>

  A Promise that resolves with an array of document IDs when the merge is complete.

save

• save(directory): Promise<void>

• Saves the current state of the FaissStore to a specified directory.

  Parameters

  • directory: string

    The directory to save the state to.

  Returns Promise<void>

  A Promise that resolves when the state has been saved.

similaritySearchVectorWithScore

• similaritySearchVectorWithScore(query, k): Promise<[Document<Record<string, any>>, number][]>

• Performs a similarity search in the vector store using a query vector and returns the top k results along with their scores.

  Parameters

  • query: number[]

    A query vector.

  • k: number

    The number of top results to return.

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

  A Promise that resolves with an array of tuples, each containing a Document and its corresponding score.

Static fromDocuments

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

• Creates a new FaissStore from an array of Document objects and an Embeddings object.

  Parameters

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

    An array of Document objects.

  • embeddings: EmbeddingsInterface

    An Embeddings object.

  • Optional dbConfig: {
        docstore?: SynchronousInMemoryDocstore;
    }

    An optional configuration object for the document store.

    • Optional docstore?: SynchronousInMemoryDocstore

  Returns Promise<FaissStore>

  A Promise that resolves with a new FaissStore instance.

Static fromIndex

• fromIndex(targetIndex, embeddings, dbConfig?): Promise<FaissStore>

• Creates a new FaissStore from an existing FaissStore and an Embeddings object.

  Parameters

  • targetIndex: FaissStore

    An existing FaissStore.

  • embeddings: EmbeddingsInterface

    An Embeddings object.

  • Optional dbConfig: {
        docstore?: SynchronousInMemoryDocstore;
    }

    An optional configuration object for the document store.

    • Optional docstore?: SynchronousInMemoryDocstore

  Returns Promise<FaissStore>

  A Promise that resolves with a new FaissStore instance.

Static fromTexts

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

• Creates a new FaissStore from an array of texts, their corresponding metadata, and an Embeddings object.

  Parameters

  • texts: string[]

    An array of texts.

  • metadatas: object | object[]

    An array of metadata corresponding to the texts, or a single metadata object to be used for all texts.

  • embeddings: EmbeddingsInterface

    An Embeddings object.

  • Optional dbConfig: {
        docstore?: SynchronousInMemoryDocstore;
    }

    An optional configuration object for the document store.

    • Optional docstore?: SynchronousInMemoryDocstore

  Returns Promise<FaissStore>

  A Promise that resolves with a new FaissStore instance.

Static importFaiss

• importFaiss(): Promise<{
      IndexFlatL2: typeof IndexFlatL2;
  }>

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

Static importPickleparser

• importPickleparser(): Promise<{
      NameRegistry: typeof NameRegistry;
      Parser: typeof Parser;
  }>

• Returns Promise<{
      NameRegistry: typeof NameRegistry;
      Parser: typeof Parser;
  }>

Static load

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

• Loads a FaissStore from a specified directory.

  Parameters

  • directory: string

    The directory to load the FaissStore from.

  • embeddings: EmbeddingsInterface

    An Embeddings object.

  Returns Promise<FaissStore>

  A Promise that resolves with a new FaissStore instance.

Static loadFromPython

• loadFromPython(directory, embeddings): Promise<FaissStore>

• Parameters

  • directory: string

  • embeddings: EmbeddingsInterface

  Returns Promise<FaissStore>