SupabaseVectorStore
Defined in: packages/providers/storage/supabase/src/SupabaseVectorStore.ts:35
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SupabaseVectorStore(
init):SupabaseVectorStore
Defined in: packages/providers/storage/supabase/src/SupabaseVectorStore.ts:46
Creates a new instance of SupabaseVectorStore
Parameters
Section titled “Parameters”Configuration object containing either a Supabase client or URL/key pair, and table name
Returns
Section titled “Returns”SupabaseVectorStore
Throws
Section titled “Throws”Error if neither client nor valid URL/key pair is provided
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/supabase/src/SupabaseVectorStore.ts:36
Overrides
Section titled “Overrides”Methods
Section titled “Methods”client()
Section titled “client()”client():
SupabaseClient<any,"public",any>
Defined in: packages/providers/storage/supabase/src/SupabaseVectorStore.ts:67
Returns the Supabase client instance used by this vector store
Returns
Section titled “Returns”SupabaseClient<any, "public", any>
The configured Supabase client
Overrides
Section titled “Overrides”add(
nodes):Promise<string[]>
Defined in: packages/providers/storage/supabase/src/SupabaseVectorStore.ts:77
Adds an array of 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 the insertion fails
Overrides
Section titled “Overrides”delete()
Section titled “delete()”delete(
refDocId,deleteOptions?):Promise<void>
Defined in: packages/providers/storage/supabase/src/SupabaseVectorStore.ts:112
Deletes documents from the vector store based on the reference document ID
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
The reference document ID to delete
deleteOptions?
Section titled “deleteOptions?”object
Optional parameters for the delete operation
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”Error if the deletion fails
Overrides
Section titled “Overrides”query()
Section titled “query()”query(
query,options?):Promise<VectorStoreQueryResult>
Defined in: packages/providers/storage/supabase/src/SupabaseVectorStore.ts:135
Queries the vector store for similar documents
Parameters
Section titled “Parameters”Query parameters including the query embedding and number of results to return
options?
Section titled “options?”object
Optional parameters for the query operation
Returns
Section titled “Returns”Promise<VectorStoreQueryResult>
Object containing matched nodes, similarity scores, and document IDs
Throws
Section titled “Throws”Error if query embedding is not provided or if the query fails
Overrides
Section titled “Overrides”exists()
Section titled “exists()”exists(
refDocId):Promise<boolean>
Defined in: packages/providers/storage/supabase/src/SupabaseVectorStore.ts:268
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