Class: HNSWLib

vectorstores.HNSWLib

Hierarchy

• SaveableVectorStore

  ↳ HNSWLib

Constructors

constructor

• new HNSWLib(embeddings, args)

Parameters

Name	Type
embeddings	Embeddings
args	HNSWLibArgs

Overrides

SaveableVectorStore.constructor

Defined in

langchain/src/vectorstores/hnswlib.ts:29

Properties

_index

• Optional _index: HierarchicalNSW

Defined in

langchain/src/vectorstores/hnswlib.ts:23

---

args

• args: HNSWLibBase

Defined in

langchain/src/vectorstores/hnswlib.ts:27

---

docstore

• docstore: InMemoryDocstore

Defined in

langchain/src/vectorstores/hnswlib.ts:25

---

embeddings

• embeddings: Embeddings

Inherited from

SaveableVectorStore.embeddings

Defined in

langchain/src/vectorstores/base.ts:23

Accessors

index

• get index(): HierarchicalNSW

Returns

HierarchicalNSW

Defined in

langchain/src/vectorstores/hnswlib.ts:68

• set index(index): void

Parameters

Name	Type
index	HierarchicalNSW

Returns

void

Defined in

langchain/src/vectorstores/hnswlib.ts:77

Methods

addDocuments

▸ addDocuments(documents): Promise<void>

Parameters

Name	Type
documents	Document[]

Returns

Promise<void>

Overrides

SaveableVectorStore.addDocuments

Defined in

langchain/src/vectorstores/hnswlib.ts:37

---

addVectors

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

Parameters

Name	Type
vectors	number[][]
documents	Document[]

Returns

Promise<void>

Overrides

SaveableVectorStore.addVectors

Defined in

langchain/src/vectorstores/hnswlib.ts:81

---

asRetriever

▸ asRetriever(k?): BaseRetriever

Parameters

Name	Type
k?	number

Returns

BaseRetriever

Inherited from

SaveableVectorStore.asRetriever

Defined in

langchain/src/vectorstores/base.ts:92

---

save

▸ save(directory): Promise<void>

Parameters

Name	Type
directory	string

Returns

Promise<void>

Overrides

SaveableVectorStore.save

Defined in

langchain/src/vectorstores/hnswlib.ts:135

---

similaritySearch

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

Parameters

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

Returns

Promise<Document[]>

Inherited from

SaveableVectorStore.similaritySearch

Defined in

langchain/src/vectorstores/base.ts:43

---

similaritySearchVectorWithScore

▸ similaritySearchVectorWithScore(query, k): Promise<[Document, number][]>

Parameters

Name	Type
query	number[]
k	number

Returns

Promise<[Document, number][]>

Overrides

SaveableVectorStore.similaritySearchVectorWithScore

Defined in

langchain/src/vectorstores/hnswlib.ts:111

---

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

SaveableVectorStore.similaritySearchWithScore

Defined in

langchain/src/vectorstores/base.ts:57

---

fromDocuments

▸ Static fromDocuments(docs, embeddings, dbConfig?): Promise<HNSWLib>

Parameters

Name	Type
docs	Document[]
embeddings	Embeddings
dbConfig?	Object
dbConfig.docstore?	InMemoryDocstore

Returns

Promise<HNSWLib>

Overrides

SaveableVectorStore.fromDocuments

Defined in

langchain/src/vectorstores/hnswlib.ts:188

---

fromTexts

▸ Static fromTexts(texts, metadatas, embeddings, dbConfig?): Promise<HNSWLib>

Parameters

Name	Type
texts	string[]
metadatas	object | object[]
embeddings	Embeddings
dbConfig?	Object
dbConfig.docstore?	InMemoryDocstore

Returns

Promise<HNSWLib>

Overrides

SaveableVectorStore.fromTexts

Defined in

langchain/src/vectorstores/hnswlib.ts:168

---

imports

▸ Static imports(): Promise<{ HierarchicalNSW: typeof HierarchicalNSW }>

Returns

Promise<{ HierarchicalNSW: typeof HierarchicalNSW }>

Defined in

langchain/src/vectorstores/hnswlib.ts:204

---

load

▸ Static load(directory, embeddings): Promise<HNSWLib>

Parameters

Name	Type
directory	string
embeddings	Embeddings

Returns

Promise<HNSWLib>

Overrides

SaveableVectorStore.load

Defined in

langchain/src/vectorstores/hnswlib.ts:150