Skip to main content

Class: VectorStore

vectorstores/base.VectorStore

Hierarchy

Constructors

constructor

new VectorStore(embeddings, _dbConfig)

Parameters

NameType
embeddingsEmbeddings
_dbConfigRecord<string, any>

Defined in

langchain/src/vectorstores/base.ts:26

Properties

embeddings

embeddings: Embeddings

Defined in

langchain/src/vectorstores/base.ts:23

Methods

addDocuments

Abstract addDocuments(documents): Promise<void>

Parameters

NameType
documentsDocument<Record<string, any>>[]

Returns

Promise<void>

Defined in

langchain/src/vectorstores/base.ts:35


addVectors

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

Parameters

NameType
vectorsnumber[][]
documentsDocument<Record<string, any>>[]

Returns

Promise<void>

Defined in

langchain/src/vectorstores/base.ts:30


asRetriever

asRetriever(k?): BaseRetriever

Parameters

NameType
k?number

Returns

BaseRetriever

Defined in

langchain/src/vectorstores/base.ts:92


similaritySearch

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

Parameters

NameTypeDefault value
querystringundefined
knumber4
filterundefined | objectundefined

Returns

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

Defined in

langchain/src/vectorstores/base.ts:43


similaritySearchVectorWithScore

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

Parameters

NameType
querynumber[]
knumber
filter?object

Returns

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

Defined in

langchain/src/vectorstores/base.ts:37


similaritySearchWithScore

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

Parameters

NameTypeDefault value
querystringundefined
knumber4
filterundefined | objectundefined

Returns

Promise<[object, number][]>

Defined in

langchain/src/vectorstores/base.ts:57


fromDocuments

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

Parameters

NameType
_docsDocument<Record<string, any>>[]
_embeddingsEmbeddings
_dbConfigRecord<string, any>

Returns

Promise<VectorStore>

Defined in

langchain/src/vectorstores/base.ts:81


fromTexts

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

Parameters

NameType
_textsstring[]
_metadatasobject | object[]
_embeddingsEmbeddings
_dbConfigRecord<string, any>

Returns

Promise<VectorStore>

Defined in

langchain/src/vectorstores/base.ts:69