Class: SaveableVectorStore

vectorstores/base.SaveableVectorStore

Hierarchy

• VectorStore

  ↳ SaveableVectorStore

  ↳↳ HNSWLib

Constructors

constructor

• new SaveableVectorStore(embeddings, _dbConfig)

Parameters

Name	Type
embeddings	Embeddings
_dbConfig	Record<string, any>

Inherited from

VectorStore.constructor

Defined in

langchain/src/vectorstores/base.ts:26

Properties

embeddings

• embeddings: Embeddings

Inherited from

VectorStore.embeddings

Defined in

langchain/src/vectorstores/base.ts:23

Methods

addDocuments

▸ Abstract addDocuments(documents): Promise<void>

Parameters

Name	Type
documents	Document<Record<string, any>>[]

Returns

Promise<void>

Inherited from

VectorStore.addDocuments

Defined in

langchain/src/vectorstores/base.ts:35

---

addVectors

▸ Abstract addVectors(vectors, documents): Promise<void>

Parameters

Name	Type
vectors	number[][]
documents	Document<Record<string, any>>[]

Returns

Promise<void>

Inherited from

VectorStore.addVectors

Defined in

langchain/src/vectorstores/base.ts:30

---

asRetriever

▸ asRetriever(k?): BaseRetriever

Parameters

Name	Type
k?	number

Returns

BaseRetriever

Inherited from

VectorStore.asRetriever

Defined in

langchain/src/vectorstores/base.ts:92

---

save

▸ Abstract save(directory): Promise<void>

Parameters

Name	Type
directory	string

Returns

Promise<void>

Defined in

langchain/src/vectorstores/base.ts:98

---

similaritySearch

▸ similaritySearch(query, k?, filter?): Promise<Document<Record<string, any>>[]>

Parameters

Name	Type	Default value
query	string	undefined
k	number	4
filter	undefined | object	undefined

Returns

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

Inherited from

VectorStore.similaritySearch

Defined in

langchain/src/vectorstores/base.ts:43

---

similaritySearchVectorWithScore

▸ Abstract similaritySearchVectorWithScore(query, k, filter?): Promise<[Document<Record<string, any>>, number][]>

Parameters

Name	Type
query	number[]
k	number
filter?	object

Returns

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

Inherited from

VectorStore.similaritySearchVectorWithScore

Defined in

langchain/src/vectorstores/base.ts:37

---

similaritySearchWithScore

▸ similaritySearchWithScore(query, k?, filter?): Promise<[object, number][]>

Parameters

Name	Type	Default value
query	string	undefined
k	number	4
filter	undefined | object	undefined

Returns

Promise<[object, number][]>

Inherited from

VectorStore.similaritySearchWithScore

Defined in

langchain/src/vectorstores/base.ts:57

---

fromDocuments

▸ Static fromDocuments(_docs, _embeddings, _dbConfig): Promise<VectorStore>

Parameters

Name	Type
_docs	Document<Record<string, any>>[]
_embeddings	Embeddings
_dbConfig	Record<string, any>

Returns

Promise<VectorStore>

Inherited from

VectorStore.fromDocuments

Defined in

langchain/src/vectorstores/base.ts:81

---

fromTexts

▸ Static fromTexts(_texts, _metadatas, _embeddings, _dbConfig): Promise<VectorStore>

Parameters

Name	Type
_texts	string[]
_metadatas	object | object[]
_embeddings	Embeddings
_dbConfig	Record<string, any>

Returns

Promise<VectorStore>

Inherited from

VectorStore.fromTexts

Defined in

langchain/src/vectorstores/base.ts:69

---

load

▸ Static load(_directory, _embeddings): Promise<SaveableVectorStore>

Parameters

Name	Type
_directory	string
_embeddings	Embeddings

Returns

Promise<SaveableVectorStore>

Defined in

langchain/src/vectorstores/base.ts:100