Class SupabaseVectorStore

constructor

• new SupabaseVectorStore(embeddings, args): SupabaseVectorStore

• Parameters

  • embeddings: EmbeddingsInterface

  • args: SupabaseLibArgs

  Returns SupabaseVectorStore

FilterType

client

queryName

tableName

upsertBatchSize

Optional filter

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.

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.

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.

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.

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.

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: EmbeddingsInterface

    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.

Static fromExistingIndex

• fromExistingIndex(embeddings, dbConfig): Promise<SupabaseVectorStore>

• Creates a new SupabaseVectorStore instance from an existing index.

  Parameters

  • embeddings: EmbeddingsInterface

    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.

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: EmbeddingsInterface

    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.