UpstashVectorStore
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:28
Provides support for writing and querying vector data in Upstash.
Extends
BaseVectorStore
Constructors
new UpstashVectorStore()
new UpstashVectorStore(
params?):UpstashVectorStore
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:46
Parameters
params?
UpstashParams
Returns
Example
Overrides
BaseVectorStore.constructor
Properties
storesText
storesText:
boolean=true
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:29
Overrides
BaseVectorStore.storesText
namespace
namespace:
string
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:33
Methods
client()
client():
Promise<Index<Dict>>
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:77
Connects to the database specified in environment vars.
Returns
Promise<Index<Dict>>
A connection to the database, or the error encountered while connecting/setting up.
Overrides
BaseVectorStore.client
add()
add(
embeddingResults):Promise<string[]>
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:86
Adds vector record(s) to the table.
Parameters
embeddingResults
BaseNode<Metadata>[]
The Nodes to be inserted, optionally including metadata tuples.
Returns
Promise<string[]>
ids of the embeddings (infered from the id_ field of embeddingResults objects)
Overrides
BaseVectorStore.add
addPlainText()
addPlainText(
text):Promise<string[]>
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:104
Adds plain text record(s) to the table. Upstash take cares of embedding conversion.
Parameters
text
TextNode<Metadata>[]
The Nodes to be inserted, optionally including metadata tuples.
Returns
Promise<string[]>
ids of the embeddings (infered from the id_ field of embeddingResults objects)
delete()
delete(
refDocId):Promise<void>
Defined in: 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
refDocId
string
Unique identifier for the record to delete.
Returns
Promise<void>
Promise that resolves if the delete query did not throw an error.
Overrides
BaseVectorStore.delete
deleteMany()
deleteMany(
refDocId):Promise<void>
Defined in: 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
refDocId
string[]
Unique identifier for the record to delete.
Returns
Promise<void>
Promise that resolves if the delete query did not throw an error.
query()
query(
query,_options?):Promise<VectorStoreQueryResult>
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:158
Query the vector store for the closest matching data to the query embeddings
Parameters
query
VectorStoreQuery
The VectorStoreQuery to be used
_options?
object
Returns
Promise<VectorStoreQueryResult>
Zero or more Document instances with data from the vector store.
Overrides
BaseVectorStore.query
toFilterString()
toFilterString(
filter):string
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:198
Parameters
filter
MetadataFilter
Returns
string
toUpstashFilter()
toUpstashFilter(
stdFilters?):undefined|string
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:202
Parameters
stdFilters?
MetadataFilters
Returns
undefined | string
nodeToRecord()
nodeToRecord(
node):object
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:220
Parameters
node
BaseNode<Metadata>
Returns
object
id
id:
string
vector
vector:
number[]
metadata
metadata:
Metadata
textNodeToRecord()
textNodeToRecord(
node):object
Defined in: providers/storage/upstash/src/UpstashVectorStore.ts:230
Parameters
node
TextNode<Metadata>
Returns
object
id
id:
string
data
data:
string=node.text
metadata
metadata:
Metadata