ElasticSearchVectorStore
Defined in: packages/providers/storage/elastic-search/src/ElasticSearchVector.ts:43
ElasticSearchVectorStore provides vector storage and similarity search capabilities using Elasticsearch. It extends BaseVectorStore to implement vector storage operations with Elasticsearch as the backend.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ElasticSearchVectorStore(
init):ElasticSearchVectorStore
Defined in: packages/providers/storage/elastic-search/src/ElasticSearchVector.ts:64
Creates a new instance of ElasticSearchVectorStore
Parameters
Section titled “Parameters”ElasticSearchParams
Configuration parameters for Elasticsearch connection and indexing
Returns
Section titled “Returns”ElasticSearchVectorStore
Overrides
Section titled “Overrides”Properties
Section titled “Properties”embedModel
Section titled “embedModel”embedModel:
BaseEmbedding
Defined in: packages/core/src/vector-store/index.ts:128
Inherited from
Section titled “Inherited from”isEmbeddingQuery?
Section titled “isEmbeddingQuery?”
optionalisEmbeddingQuery:boolean
Defined in: packages/core/src/vector-store/index.ts:130
Inherited from
Section titled “Inherited from”BaseVectorStore.isEmbeddingQuery
storesText
Section titled “storesText”storesText:
boolean=true
Defined in: packages/providers/storage/elastic-search/src/ElasticSearchVector.ts:44
Overrides
Section titled “Overrides”Methods
Section titled “Methods”client()
Section titled “client()”client():
Client
Defined in: packages/providers/storage/elastic-search/src/ElasticSearchVector.ts:97
Returns the Elasticsearch client instance
Returns
Section titled “Returns”Client
The configured Elasticsearch client
Overrides
Section titled “Overrides”add(
nodes):Promise<string[]>
Defined in: packages/providers/storage/elastic-search/src/ElasticSearchVector.ts:143
Adds nodes to the vector store
Parameters
Section titled “Parameters”Array of BaseNode objects to store
Returns
Section titled “Returns”Promise<string[]>
Array of node IDs that were successfully stored
Throws
Section titled “Throws”Error if nodes don’t have embeddings
Overrides
Section titled “Overrides”delete()
Section titled “delete()”delete(
refDocId,deleteOptions?):Promise<void>
Defined in: packages/providers/storage/elastic-search/src/ElasticSearchVector.ts:187
Deletes nodes from the vector store by reference document ID
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Reference document ID to delete
deleteOptions?
Section titled “deleteOptions?”object
Optional deletion parameters
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”query()
Section titled “query()”query(
query,options?):Promise<VectorStoreQueryResult>
Defined in: packages/providers/storage/elastic-search/src/ElasticSearchVector.ts:253
Performs a vector similarity search query
Parameters
Section titled “Parameters”Vector store query parameters
options?
Section titled “options?”object
Optional query parameters
Returns
Section titled “Returns”Promise<VectorStoreQueryResult>
Query results containing matching nodes, similarities, and IDs
Throws
Section titled “Throws”Error if query embedding is not provided
Overrides
Section titled “Overrides”exists()
Section titled “exists()”exists(
refDocId):Promise<boolean>
Defined in: packages/providers/storage/elastic-search/src/ElasticSearchVector.ts:372
Check if any nodes exist for the given document reference ID. Used for de-duplication during ingestion.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
The reference document ID to check
Returns
Section titled “Returns”Promise<boolean>
true if any nodes with this ref_doc_id exist