EndeeVectorStore
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:63
Endee vector store implementation.
Supports dense, sparse, and hybrid vector searches with advanced filtering capabilities.
Extends
Section titled “Extends”BaseVectorStore<Endee,EndeeCustomParams>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EndeeVectorStore(
params):EndeeVectorStore
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:89
Creates a new EndeeVectorStore instance.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”EndeeVectorStore
Overrides
Section titled “Overrides”Properties
Section titled “Properties”isEmbeddingQuery?
Section titled “isEmbeddingQuery?”
optionalisEmbeddingQuery:boolean
Defined in: packages/core/src/vector-store/index.ts:120
Inherited from
Section titled “Inherited from”BaseVectorStore.isEmbeddingQuery
storesText
Section titled “storesText”storesText:
boolean=true
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:67
Overrides
Section titled “Overrides”indexName
Section titled “indexName”indexName:
string
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:75
url:
string
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:76
authToken?
Section titled “authToken?”
optionalauthToken:string
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:77
batchSize
Section titled “batchSize”batchSize:
number
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:78
dimension?
Section titled “dimension?”
optionaldimension:number
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:79
sparseDimension?
Section titled “sparseDimension?”
optionalsparseDimension:number
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:80
spaceType
Section titled “spaceType”spaceType:
"cosine"|"ip"|"l2"
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:81
precision
Section titled “precision”precision:
Precision
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:82
optionalM:number
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:83
efCon?
Section titled “efCon?”
optionalefCon:number
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:84
Methods
Section titled “Methods”client()
Section titled “client()”client():
Endee
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:126
Returns the Endee client, lazily initializing if needed.
Returns
Section titled “Returns”Endee
Overrides
Section titled “Overrides”add(
embeddingResults):Promise<string[]>
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:199
Adds nodes to the vector store.
Parameters
Section titled “Parameters”embeddingResults
Section titled “embeddingResults”The nodes to be inserted
Returns
Section titled “Returns”Promise<string[]>
Array of node IDs that were added
Overrides
Section titled “Overrides”delete()
Section titled “delete()”delete(
refDocId):Promise<void>
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:261
Deletes all nodes associated with a document reference ID.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
The document reference ID
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”exists()
Section titled “exists()”exists(
refDocId):Promise<boolean>
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:273
Checks if any nodes exist for the given document reference ID.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
The document reference ID to check
Returns
Section titled “Returns”Promise<boolean>
true if any nodes with this ref_doc_id exist
Overrides
Section titled “Overrides”query()
Section titled “query()”query(
query,_options?):Promise<VectorStoreQueryResult>
Defined in: packages/providers/storage/endee/src/EndeeVectorStore.ts:296
Queries the vector store for the closest matching data.
Parameters
Section titled “Parameters”VectorStoreQuery<EndeeCustomParams>
The VectorStoreQuery to be used
_options?
Section titled “_options?”object
Additional options (currently unused)
Returns
Section titled “Returns”Promise<VectorStoreQueryResult>
Query results with nodes, similarities, and IDs