Class SupabaseVectorStore

Class for interacting with a Supabase database to store and manage vectors.

Hierarchy

VectorStore
- SupabaseVectorStore

Index

Constructors

constructor

new SupabaseVectorStore(embeddings, args): SupabaseVectorStore
Parameters
- embeddings: Embeddings
- args: SupabaseLibArgs
Returns SupabaseVectorStore
Overrides VectorStore.constructor
- Defined in docs/api_refs/langchain/src/vectorstores/supabase.ts:67

Properties

FilterType

FilterType: SupabaseMetadata | SupabaseFilterRPCCall

client

client: default<any, "public", any>

embeddings

embeddings: Embeddings

queryName

queryName: string

tableName

tableName: string

upsertBatchSize

upsertBatchSize: number = 500

`Optional` filter

filter?: SupabaseMetadata | SupabaseFilterRPCCall

Methods

addDocuments

addDocuments(documents, options?): Promise<string[]>
Adds documents to the vector store.
Parameters
- documents: Document<Record<string, any>>[]
  
  The documents to add.
- Optional options: {
  ids?: string[] | number[];
  }
  
  Optional parameters for adding the documents.
  - Optional ids?: string[] | number[]
Returns Promise<string[]>
A promise that resolves when the documents have been added.
Overrides VectorStore.addDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/supabase.ts:83

addVectors

addVectors(vectors, documents, options?): Promise<string[]>
Adds vectors to the vector store.
Parameters
- vectors: number[][]
  
  The vectors to add.
- documents: Document<Record<string, any>>[]
  
  The documents associated with the vectors.
- Optional options: {
  ids?: string[] | number[];
  }
  
  Optional parameters for adding the vectors.
  - Optional ids?: string[] | number[]
Returns Promise<string[]>
A promise that resolves with the IDs of the added vectors when the vectors have been added.
Overrides VectorStore.addVectors
- Defined in docs/api_refs/langchain/src/vectorstores/supabase.ts:102

asRetriever

asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<SupabaseVectorStore>
Parameters
- Optional kOrFields: number | Partial<VectorStoreRetrieverInput<SupabaseVectorStore>>
- Optional filter: SupabaseMetadata | SupabaseFilterRPCCall
- Optional callbacks: Callbacks
- Optional tags: string[]
- Optional metadata: Record<string, unknown>
- Optional verbose: boolean
Returns VectorStoreRetriever<SupabaseVectorStore>
Inherited from VectorStore.asRetriever
- Defined in docs/api_refs/langchain/src/vectorstores/base.ts:252

delete

delete(params): Promise<void>
Deletes vectors from the vector store.
Parameters
- params: {
  ids: string[] | number[];
  }
  
  The parameters for deleting vectors.
  - ids: string[] | number[]
Returns Promise<void>
A promise that resolves when the vectors have been deleted.
Overrides VectorStore.delete
- Defined in docs/api_refs/langchain/src/vectorstores/supabase.ts:142

maxMarginalRelevanceSearch

maxMarginalRelevanceSearch(query, options): Promise<Document<Record<string, any>>[]>
Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Parameters
- query: string
  
  Text to look up documents similar to.
- options: MaxMarginalRelevanceSearchOptions<SupabaseMetadata | SupabaseFilterRPCCall>
Returns Promise<Document<Record<string, any>>[]>
- List of documents selected by maximal marginal relevance.
Overrides VectorStore.maxMarginalRelevanceSearch
- Defined in docs/api_refs/langchain/src/vectorstores/supabase.ts:226

similaritySearch

similaritySearch(query, k?, filter?, _callbacks?): Promise<Document<Record<string, any>>[]>
Parameters
- query: string
- k: number = 4
- filter: undefined | SupabaseMetadata | SupabaseFilterRPCCall = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<Document<Record<string, any>>[]>
Inherited from VectorStore.similaritySearch
- Defined in docs/api_refs/langchain/src/vectorstores/base.ts:180

similaritySearchVectorWithScore

similaritySearchVectorWithScore(query, k, filter?): Promise<[Document<Record<string, any>>, number][]>
Performs a similarity search on the vector store.
Parameters
- query: number[]
  
  The query vector.
- k: number
  
  The number of results to return.
- Optional filter: SupabaseMetadata | SupabaseFilterRPCCall
  
  Optional filter to apply to the search.
Returns Promise<[Document<Record<string, any>>, number][]>
A promise that resolves with the search results when the search is complete.
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in docs/api_refs/langchain/src/vectorstores/supabase.ts:195

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[Document<Record<string, any>>, number][]>
Parameters
- query: string
- k: number = 4
- filter: undefined | SupabaseMetadata | SupabaseFilterRPCCall = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<[Document<Record<string, any>>, number][]>
Inherited from VectorStore.similaritySearchWithScore
- Defined in docs/api_refs/langchain/src/vectorstores/base.ts:195

`Static` fromDocuments

fromDocuments(docs, embeddings, dbConfig): Promise<SupabaseVectorStore>
Creates a new SupabaseVectorStore instance from an array of documents.
Parameters
- docs: Document<Record<string, any>>[]
  
  The documents to create the instance from.
- embeddings: Embeddings
  
  The embeddings to use.
- dbConfig: SupabaseLibArgs
  
  The configuration for the Supabase database.
Returns Promise<SupabaseVectorStore>
A promise that resolves with a new SupabaseVectorStore instance when the instance has been created.
Overrides VectorStore.fromDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/supabase.ts:289

`Static` fromExistingIndex

fromExistingIndex(embeddings, dbConfig): Promise<SupabaseVectorStore>
Creates a new SupabaseVectorStore instance from an existing index.
Parameters
- embeddings: Embeddings
  
  The embeddings to use.
- dbConfig: SupabaseLibArgs
  
  The configuration for the Supabase database.
Returns Promise<SupabaseVectorStore>
A promise that resolves with a new SupabaseVectorStore instance when the instance has been created.
- Defined in docs/api_refs/langchain/src/vectorstores/supabase.ts:305

`Static` fromTexts

fromTexts(texts, metadatas, embeddings, dbConfig): Promise<SupabaseVectorStore>
Creates a new SupabaseVectorStore instance from an array of texts.
Parameters
- texts: string[]
  
  The texts to create documents from.
- metadatas: object | object[]
  
  The metadata for the documents.
- embeddings: Embeddings
  
  The embeddings to use.
- dbConfig: SupabaseLibArgs
  
  The configuration for the Supabase database.
Returns Promise<SupabaseVectorStore>
A promise that resolves with a new SupabaseVectorStore instance when the instance has been created.
Overrides VectorStore.fromTexts
- Defined in docs/api_refs/langchain/src/vectorstores/supabase.ts:264

Class SupabaseVectorStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

embeddings: Embeddings

args: SupabaseLibArgs

Returns SupabaseVectorStore

Properties

FilterType

client

embeddings

queryName

tableName

upsertBatchSize

Optional filter

Methods

addDocuments

Parameters

documents: Document<Record<string, any>>[]

Optional options: { ids?: string[] | number[]; }

Optional ids?: string[] | number[]

Returns Promise<string[]>

addVectors

Parameters

vectors: number[][]

documents: Document<Record<string, any>>[]

Optional options: { ids?: string[] | number[]; }

Optional ids?: string[] | number[]

Returns Promise<string[]>

asRetriever

Parameters

Optional kOrFields: number | Partial<VectorStoreRetrieverInput<SupabaseVectorStore>>

Optional filter: SupabaseMetadata | SupabaseFilterRPCCall

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<SupabaseVectorStore>

delete

Parameters

params: { ids: string[] | number[]; }

ids: string[] | number[]

Returns Promise<void>

maxMarginalRelevanceSearch

Parameters

query: string

options: MaxMarginalRelevanceSearchOptions<SupabaseMetadata | SupabaseFilterRPCCall>

Returns Promise<Document<Record<string, any>>[]>

similaritySearch

Parameters

query: string

k: number = 4

filter: undefined | SupabaseMetadata | SupabaseFilterRPCCall = undefined

_callbacks: undefined | Callbacks = undefined

Returns Promise<Document<Record<string, any>>[]>

similaritySearchVectorWithScore

Parameters

query: number[]

k: number

Optional filter: SupabaseMetadata | SupabaseFilterRPCCall

Returns Promise<[Document<Record<string, any>>, number][]>

similaritySearchWithScore

Parameters

query: string

k: number = 4

filter: undefined | SupabaseMetadata | SupabaseFilterRPCCall = undefined

_callbacks: undefined | Callbacks = undefined

Returns Promise<[Document<Record<string, any>>, number][]>

Static fromDocuments

Parameters

docs: Document<Record<string, any>>[]

embeddings: Embeddings

dbConfig: SupabaseLibArgs

Returns Promise<SupabaseVectorStore>

Static fromExistingIndex

`Optional` filter

`Optional` options: {
ids?: string[] | number[];
}

`Optional` ids?: string[] | number[]

`Optional` options: {
ids?: string[] | number[];
}

`Optional` ids?: string[] | number[]

`Optional` kOrFields: number | Partial<VectorStoreRetrieverInput<SupabaseVectorStore>>

`Optional` filter: SupabaseMetadata | SupabaseFilterRPCCall

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

params: {
ids: string[] | number[];
}

`Optional` filter: SupabaseMetadata | SupabaseFilterRPCCall

`Static` fromDocuments

`Static` fromExistingIndex

`Static` fromTexts