UpstashVectorStore
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:28
Provides support for writing and querying vector data in Upstash.
Extends
Section titled “Extends”BaseVectorStore
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UpstashVectorStore(
params?):UpstashVectorStore
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:46
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”BaseVectorStore.constructor
Properties
Section titled “Properties”storesText
Section titled “storesText”storesText:
boolean=true
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:29
Overrides
Section titled “Overrides”BaseVectorStore.storesText
namespace
Section titled “namespace”namespace:
string
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:33
Methods
Section titled “Methods”client()
Section titled “client()”client():
Promise<Index<Dict>>
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:77
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”BaseVectorStore.client
add(
embeddingResults):Promise<string[]>
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:86
Adds vector record(s) to the table.
Parameters
Section titled “Parameters”embeddingResults
Section titled “embeddingResults”BaseNode<Metadata>[]
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”BaseVectorStore.add
addPlainText()
Section titled “addPlainText()”addPlainText(
text):Promise<string[]>
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:104
Adds plain text record(s) to the table. Upstash take cares of embedding conversion.
Parameters
Section titled “Parameters”TextNode<Metadata>[]
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: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:137
Deletes a single record from the database by id. NOTE: Uses the collection property controlled by setCollection/getCollection.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Unique identifier for the record to delete.
Returns
Section titled “Returns”Promise<void>
Promise that resolves if the delete query did not throw an error.
Overrides
Section titled “Overrides”BaseVectorStore.delete
deleteMany()
Section titled “deleteMany()”deleteMany(
refDocId):Promise<void>
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:148
Deletes a single record from the database by id. NOTE: Uses the collection property controlled by setCollection/getCollection.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string[]
Unique identifier for the record 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: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:158
Query the vector store for the closest matching data to the query embeddings
Parameters
Section titled “Parameters”VectorStoreQuery
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”BaseVectorStore.query
toFilterString()
Section titled “toFilterString()”toFilterString(
filter):string
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:198
Parameters
Section titled “Parameters”filter
Section titled “filter”MetadataFilter
Returns
Section titled “Returns”string
toUpstashFilter()
Section titled “toUpstashFilter()”toUpstashFilter(
stdFilters?):undefined|string
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:202
Parameters
Section titled “Parameters”stdFilters?
Section titled “stdFilters?”MetadataFilters
Returns
Section titled “Returns”undefined | string
nodeToRecord()
Section titled “nodeToRecord()”nodeToRecord(
node):object
Defined in: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:220
Parameters
Section titled “Parameters”BaseNode<Metadata>
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: .build/typescript/packages/providers/storage/upstash/src/UpstashVectorStore.ts:230
Parameters
Section titled “Parameters”TextNode<Metadata>
Returns
Section titled “Returns”object
id:
string
data:
string=node.text
metadata
Section titled “metadata”metadata:
Metadata