Class SupabaseVectorStore

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

Hierarchy

VectorStore
- SupabaseVectorStore

Constructors

constructor

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

Properties

FilterType

FilterType: SupabaseMetadata | SupabaseFilterRPCCall

client

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

embeddings

embeddings: Embeddings

lc_kwargs

lc_kwargs: SerializedFields

lc_namespace

lc_namespace: string[] = ...

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

lc_serializable

lc_serializable: boolean = false

queryName

queryName: string

tableName

tableName: string

upsertBatchSize

upsertBatchSize: number = 500

`Optional` filter

filter?: SupabaseMetadata | SupabaseFilterRPCCall

Accessors

lc_aliases

get lc_aliases(): undefined | {
[key: string]: string;
}
A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

Returns undefined | {
[key: string]: string;
}
Inherited from VectorStore.lc_aliases
- Defined in langchain/src/load/serializable.ts:132

lc_attributes

get lc_attributes(): undefined | SerializedFields
A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

Returns undefined | SerializedFields
Inherited from VectorStore.lc_attributes
- Defined in langchain/src/load/serializable.ts:122

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from VectorStore.lc_id
- Defined in langchain/src/load/serializable.ts:100

lc_secrets

get lc_secrets(): undefined | {
[key: string]: string;
}
A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

Returns undefined | {
[key: string]: string;
}
Inherited from VectorStore.lc_secrets
- Defined in langchain/src/load/serializable.ts:112

Methods

_vectorstoreType

_vectorstoreType(): string
Returns string
Overrides VectorStore._vectorstoreType
- Defined in langchain/src/vectorstores/supabase.ts:62

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 langchain/src/vectorstores/supabase.ts:82

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 langchain/src/vectorstores/supabase.ts:101

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 langchain/src/vectorstores/base.ts:246

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 langchain/src/vectorstores/supabase.ts:141

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 langchain/src/vectorstores/supabase.ts:224

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 langchain/src/vectorstores/base.ts:174

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 langchain/src/vectorstores/supabase.ts:193

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 langchain/src/vectorstores/base.ts:189

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from VectorStore.toJSON
- Defined in langchain/src/load/serializable.ts:140

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from VectorStore.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:214

`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 langchain/src/vectorstores/supabase.ts:287

`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 langchain/src/vectorstores/supabase.ts:303

`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 langchain/src/vectorstores/supabase.ts:262

`Static` lc_name

lc_name(): string
The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

Returns string
Inherited from VectorStore.lc_name
- Defined in langchain/src/load/serializable.ts:93

`Protected` _searchSupabase

_searchSupabase(query, k, filter?): Promise<SearchEmbeddingsResponse[]>
Parameters
- query: number[]
- k: number
- Optional filter: SupabaseMetadata | SupabaseFilterRPCCall
Returns Promise<SearchEmbeddingsResponse[]>
- Defined in langchain/src/vectorstores/supabase.ts:148

Class SupabaseVectorStore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

embeddings: Embeddings

args: SupabaseLibArgs

Returns SupabaseVectorStore

Properties

FilterType

client

embeddings

lc_kwargs

lc_namespace

lc_serializable

queryName

tableName

upsertBatchSize

Optional filter

Accessors

lc_aliases

Returns undefined | { [key: string]: string; }

lc_attributes

Returns undefined | SerializedFields

lc_id

Returns string[]

lc_secrets

Returns undefined | { [key: string]: string; }

Methods

_vectorstoreType

Returns string

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

`Optional` filter

Returns undefined | {
[key: string]: string;
}

Returns undefined | {
[key: string]: string;
}

`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

`Static` lc_name

`Protected` _searchSupabase

`Optional` filter: SupabaseMetadata | SupabaseFilterRPCCall