Class: HNSWLib
vectorstores/hnswlib.HNSWLib
Hierarchy
↳
HNSWLib
Constructors
constructor
• new HNSWLib(embeddings
, args
)
Parameters
Name | Type |
---|---|
embeddings | Embeddings |
args | HNSWLibArgs |
Overrides
SaveableVectorStore.constructor
Defined in
langchain/src/vectorstores/hnswlib.ts:27
Properties
_index
• Optional
_index: HierarchicalNSW
Defined in
langchain/src/vectorstores/hnswlib.ts:21
args
• args: HNSWLibBase
Defined in
langchain/src/vectorstores/hnswlib.ts:25
docstore
• docstore: InMemoryDocstore
Defined in
langchain/src/vectorstores/hnswlib.ts:23
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:66
• set
index(index
): void
Parameters
Name | Type |
---|---|
index | HierarchicalNSW |
Returns
void
Defined in
langchain/src/vectorstores/hnswlib.ts:75
Methods
addDocuments
▸ addDocuments(documents
): Promise
<void
>
Parameters
Name | Type |
---|---|
documents | Document <Record <string , any >>[] |
Returns
Promise
<void
>
Overrides
SaveableVectorStore.addDocuments
Defined in
langchain/src/vectorstores/hnswlib.ts:35
addVectors
▸ addVectors(vectors
, documents
): Promise
<void
>
Parameters
Name | Type |
---|---|
vectors | number [][] |
documents | Document <Record <string , any >>[] |
Returns
Promise
<void
>
Overrides
SaveableVectorStore.addVectors
Defined in
langchain/src/vectorstores/hnswlib.ts:79
asRetriever
▸ asRetriever(k?
): BaseRetriever
Parameters
Name | Type |
---|---|
k? | number |
Returns
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
Defined in
langchain/src/vectorstores/hnswlib.ts:133
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
SaveableVectorStore.similaritySearch
Defined in
langchain/src/vectorstores/base.ts:43
similaritySearchVectorWithScore
▸ similaritySearchVectorWithScore(query
, k
): Promise
<[Document
<Record
<string
, any
>>, number
][]>
Parameters
Name | Type |
---|---|
query | number [] |
k | number |
Returns
Promise
<[Document
<Record
<string
, any
>>, number
][]>
Overrides
SaveableVectorStore.similaritySearchVectorWithScore
Defined in
langchain/src/vectorstores/hnswlib.ts:109
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 <Record <string , any >>[] |
embeddings | Embeddings |
dbConfig? | Object |
dbConfig.docstore? | InMemoryDocstore |
Returns
Promise
<HNSWLib
>
Overrides
SaveableVectorStore.fromDocuments
Defined in
langchain/src/vectorstores/hnswlib.ts:190
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
Defined in
langchain/src/vectorstores/hnswlib.ts:170
imports
▸ Static
imports(): Promise
<{ HierarchicalNSW
: typeof HierarchicalNSW
}>
Returns
Promise
<{ HierarchicalNSW
: typeof HierarchicalNSW
}>
Defined in
langchain/src/vectorstores/hnswlib.ts:206
load
▸ Static
load(directory
, embeddings
): Promise
<HNSWLib
>
Parameters
Name | Type |
---|---|
directory | string |
embeddings | Embeddings |
Returns
Promise
<HNSWLib
>
Overrides
Defined in
langchain/src/vectorstores/hnswlib.ts:150