UpstashVectorStore
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:25
Provides support for writing and querying vector data in Upstash.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UpstashVectorStore(
params?):UpstashVectorStore
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:43
Parameters
Section titled “Parameters”params?
Section titled “params?”UpstashParams
Returns
Section titled “Returns”UpstashVectorStore
Example
Section titled “Example”const vectorStore = new UpstashVectorStore({ namespace: "my-namespace" })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/upstash/src/UpstashVectorStore.ts:26
Overrides
Section titled “Overrides”namespace
Section titled “namespace”namespace:
string
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:30
Methods
Section titled “Methods”client()
Section titled “client()”client():
Promise<Index<Dict>>
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:74
Connects to the database specified in environment vars.
Returns
Section titled “Returns”Promise<Index<Dict>>
A connection to the database, or the error encountered while connecting/setting up.
Overrides
Section titled “Overrides”add(
embeddingResults):Promise<string[]>
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:83
Adds vector record(s) to the table.
Parameters
Section titled “Parameters”embeddingResults
Section titled “embeddingResults”The Nodes to be inserted, optionally including metadata tuples.
Returns
Section titled “Returns”Promise<string[]>
ids of the embeddings (infered from the id_ field of embeddingResults objects)
Overrides
Section titled “Overrides”addPlainText()
Section titled “addPlainText()”addPlainText(
text):Promise<string[]>
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:101
Adds plain text record(s) to the table. Upstash take cares of embedding conversion.
Parameters
Section titled “Parameters”The Nodes to be inserted, optionally including metadata tuples.
Returns
Section titled “Returns”Promise<string[]>
ids of the embeddings (infered from the id_ field of embeddingResults objects)
delete()
Section titled “delete()”delete(
refDocId):Promise<void>
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:133
Deletes all nodes from the database that belong to the given document.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Reference document ID - all nodes with this ref_doc_id will be deleted.
Returns
Section titled “Returns”Promise<void>
Promise that resolves if the delete query did not throw an error.
Overrides
Section titled “Overrides”deleteMany()
Section titled “deleteMany()”deleteMany(
ids):Promise<void>
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:157
Deletes multiple records from the database by their IDs.
Parameters
Section titled “Parameters”string[]
Array of node IDs to delete.
Returns
Section titled “Returns”Promise<void>
Promise that resolves if the delete query did not throw an error.
query()
Section titled “query()”query(
query,_options?):Promise<VectorStoreQueryResult>
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:167
Query the vector store for the closest matching data to the query embeddings
Parameters
Section titled “Parameters”The VectorStoreQuery to be used
_options?
Section titled “_options?”object
Returns
Section titled “Returns”Promise<VectorStoreQueryResult>
Zero or more Document instances with data from the vector store.
Overrides
Section titled “Overrides”toFilterString()
Section titled “toFilterString()”toFilterString(
filter):string
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:207
Parameters
Section titled “Parameters”filter
Section titled “filter”Returns
Section titled “Returns”string
toUpstashFilter()
Section titled “toUpstashFilter()”toUpstashFilter(
stdFilters?):string|undefined
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:211
Parameters
Section titled “Parameters”stdFilters?
Section titled “stdFilters?”Returns
Section titled “Returns”string | undefined
nodeToRecord()
Section titled “nodeToRecord()”nodeToRecord(
node):object
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:229
Parameters
Section titled “Parameters”Returns
Section titled “Returns”object
id:
string
vector
Section titled “vector”vector:
number[]
metadata
Section titled “metadata”metadata:
Metadata
textNodeToRecord()
Section titled “textNodeToRecord()”textNodeToRecord(
node):object
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:239
Parameters
Section titled “Parameters”Returns
Section titled “Returns”object
id:
string
data:
string=node.text
metadata
Section titled “metadata”metadata:
Metadata
exists()
Section titled “exists()”exists(
refDocId):Promise<boolean>
Defined in: packages/providers/storage/upstash/src/UpstashVectorStore.ts:249
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