Class FaissStore

A class that wraps the FAISS (Facebook AI Similarity Search) vector database for efficient similarity search and clustering of dense vectors.

Hierarchy

SaveableVectorStore
- FaissStore

Constructors

constructor

new FaissStore(embeddings, args): FaissStore
Parameters
- embeddings: Embeddings
- args: FaissLibArgs
Returns FaissStore
Overrides SaveableVectorStore.constructor
- Defined in langchain/src/vectorstores/faiss.ts:45

Properties

FilterType

FilterType: string | object

_mapping

_mapping: Record<number, string>

args

args: FaissLibArgs

docstore

docstore: SynchronousInMemoryDocstore

embeddings

embeddings: Embeddings

lc_kwargs

lc_kwargs: SerializedFields

lc_namespace

lc_namespace: string[] = ...

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.

lc_serializable

lc_serializable: boolean = false

`Optional` _index

_index?: IndexFlatL2

Accessors

index

get index(): IndexFlatL2
Returns IndexFlatL2
- Defined in langchain/src/vectorstores/faiss.ts:68
set index(index): void
Parameters
- index: IndexFlatL2
Returns void
- Defined in langchain/src/vectorstores/faiss.ts:77

lc_aliases

get lc_aliases(): undefined | {
[key: string]: string;
}
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.

Returns undefined | {
[key: string]: string;
}
Inherited from SaveableVectorStore.lc_aliases
- Defined in langchain/src/load/serializable.ts:132

lc_attributes

get lc_attributes(): undefined | SerializedFields
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.

Returns undefined | SerializedFields
Inherited from SaveableVectorStore.lc_attributes
- Defined in langchain/src/load/serializable.ts:122

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from SaveableVectorStore.lc_id
- Defined in langchain/src/load/serializable.ts:100

lc_secrets

get lc_secrets(): undefined | {
[key: string]: string;
}
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.

Returns undefined | {
[key: string]: string;
}
Inherited from SaveableVectorStore.lc_secrets
- Defined in langchain/src/load/serializable.ts:112

Methods

_vectorstoreType

_vectorstoreType(): string
Returns string
Overrides SaveableVectorStore._vectorstoreType
- Defined in langchain/src/vectorstores/faiss.ts:33

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.
Overrides SaveableVectorStore.addDocuments
- Defined in langchain/src/vectorstores/faiss.ts:59

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.
Overrides SaveableVectorStore.addVectors
- Defined in langchain/src/vectorstores/faiss.ts:88

asRetriever

asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<FaissStore>
Parameters
- Optional kOrFields: number | Partial<VectorStoreRetrieverInput<FaissStore>>
- Optional filter: string | object
- Optional callbacks: Callbacks
- Optional tags: string[]
- Optional metadata: Record<string, unknown>
- Optional verbose: boolean
Returns VectorStoreRetriever<FaissStore>
Inherited from SaveableVectorStore.asRetriever
- Defined in langchain/src/vectorstores/base.ts:246

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.
Overrides SaveableVectorStore.delete
- Defined in langchain/src/vectorstores/faiss.ts:181

getDocstore

getDocstore(): SynchronousInMemoryDocstore
Returns SynchronousInMemoryDocstore
- Defined in langchain/src/vectorstores/faiss.ts:41

getMapping

getMapping(): Record<number, string>
Returns Record<number, string>
- Defined in langchain/src/vectorstores/faiss.ts:37

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.
- Defined in langchain/src/vectorstores/faiss.ts:230

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.
Overrides SaveableVectorStore.save
- Defined in langchain/src/vectorstores/faiss.ts:160

similaritySearch

similaritySearch(query, k?, filter?, _callbacks?): Promise<Document<Record<string, any>>[]>
Parameters
- query: string
- k: number = 4
- filter: undefined | string | object = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<Document<Record<string, any>>[]>
Inherited from SaveableVectorStore.similaritySearch
- Defined in langchain/src/vectorstores/base.ts:174

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.
Overrides SaveableVectorStore.similaritySearchVectorWithScore
- Defined in langchain/src/vectorstores/faiss.ts:130

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[Document<Record<string, any>>, number][]>
Parameters
- query: string
- k: number = 4
- filter: undefined | string | object = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<[Document<Record<string, any>>, number][]>
Inherited from SaveableVectorStore.similaritySearchWithScore
- Defined in langchain/src/vectorstores/base.ts:189

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from SaveableVectorStore.toJSON
- Defined in langchain/src/load/serializable.ts:140

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from SaveableVectorStore.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:214

`Optional` maxMarginalRelevanceSearch

maxMarginalRelevanceSearch(query, options, _callbacks): Promise<Document<Record<string, any>>[]>
Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Parameters
- query: string
  
  Text to look up documents similar to.
- options: MaxMarginalRelevanceSearchOptions<string | object>
- _callbacks: undefined | Callbacks
Returns Promise<Document<Record<string, any>>[]>
- List of documents selected by maximal marginal relevance.
Inherited from SaveableVectorStore.maxMarginalRelevanceSearch
- Defined in langchain/src/vectorstores/base.ts:217

`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: Embeddings
  
  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.
Overrides SaveableVectorStore.fromDocuments
- Defined in langchain/src/vectorstores/faiss.ts:391

`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: Embeddings
  
  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.
- Defined in langchain/src/vectorstores/faiss.ts:414

`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: Embeddings
  
  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.
Overrides SaveableVectorStore.fromTexts
- Defined in langchain/src/vectorstores/faiss.ts:363

`Static` importFaiss

importFaiss(): Promise<{
IndexFlatL2: typeof IndexFlatL2;
}>
Returns Promise<{
IndexFlatL2: typeof IndexFlatL2;
}>
- Defined in langchain/src/vectorstores/faiss.ts:429

`Static` importPickleparser

importPickleparser(): Promise<{
NameRegistry: typeof NameRegistry;
Parser: typeof Parser;
}>
Returns Promise<{
NameRegistry: typeof NameRegistry;
Parser: typeof Parser;
}>
- Defined in langchain/src/vectorstores/faiss.ts:444

`Static` lc_name

lc_name(): string
The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

Returns string
Inherited from SaveableVectorStore.lc_name
- Defined in langchain/src/load/serializable.ts:93

`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: Embeddings
  
  An Embeddings object.
Returns Promise<FaissStore>
A Promise that resolves with a new FaissStore instance.
Overrides SaveableVectorStore.load
- Defined in langchain/src/vectorstores/faiss.ts:263

`Static` loadFromPython

loadFromPython(directory, embeddings): Promise<FaissStore>
Parameters
- directory: string
- embeddings: Embeddings
Returns Promise<FaissStore>
- Defined in langchain/src/vectorstores/faiss.ts:284

Class FaissStore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

embeddings: Embeddings

args: FaissLibArgs

Returns FaissStore

Properties

FilterType

_mapping

args

docstore

embeddings

lc_kwargs

lc_namespace

lc_serializable

Optional _index

Accessors

index

Returns IndexFlatL2

Parameters

index: IndexFlatL2

Returns void

lc_aliases

Returns undefined | { [key: string]: string; }

lc_attributes

Returns undefined | SerializedFields

lc_id

Returns string[]

lc_secrets

Returns undefined | { [key: string]: string; }

Methods

_vectorstoreType

Returns string

addDocuments

Parameters

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

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

Optional ids?: string[]

Returns Promise<string[]>

addVectors

Parameters

vectors: number[][]

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

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

Optional ids?: string[]

Returns Promise<string[]>

asRetriever

Parameters

Optional kOrFields: number | Partial<VectorStoreRetrieverInput<FaissStore>>

Optional filter: string | object

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<FaissStore>

delete

Parameters

params: { ids: string[]; }

ids: string[]

Returns Promise<void>

getDocstore

Returns SynchronousInMemoryDocstore

getMapping

Returns Record<number, string>

mergeFrom

Parameters

targetIndex: FaissStore

Returns Promise<string[]>

save

Parameters

directory: string

Returns Promise<void>

similaritySearch

`Optional` _index

Returns undefined | {
[key: string]: string;
}

Returns undefined | {
[key: string]: string;
}

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

`Optional` ids?: string[]

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

`Optional` ids?: string[]

`Optional` kOrFields: number | Partial<VectorStoreRetrieverInput<FaissStore>>

`Optional` filter: string | object

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

params: {
ids: string[];
}

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

`Optional` dbConfig: {
docstore?: SynchronousInMemoryDocstore;
}

`Optional` docstore?: SynchronousInMemoryDocstore

`Static` fromIndex

`Optional` dbConfig: {
docstore?: SynchronousInMemoryDocstore;
}

`Optional` docstore?: SynchronousInMemoryDocstore

`Static` fromTexts

`Optional` dbConfig: {
docstore?: SynchronousInMemoryDocstore;
}

`Optional` docstore?: SynchronousInMemoryDocstore

`Static` importFaiss

Returns Promise<{
IndexFlatL2: typeof IndexFlatL2;
}>

`Static` importPickleparser

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

`Static` lc_name

`Static` load

`Static` loadFromPython