Skip to content
Nappai Documentation

Supabase Vector Store

Supabase Vector Store stores documents in a table of your Supabase project and searches it by meaning.

A vector database stores texts so they can be searched by meaning, not just by exact words. That way an agent can find the paragraph of a manual that answers a question even if it uses different words.

When to use it

  • Your application already uses Supabase and you want to add a knowledge base.
  • You want the documents next to the rest of your Supabase project data.

Configuration

The Operation field decides what the component does, and the fields and outputs change with your choice:

  • Add (default): stores in the database the documents it receives in Ingest Data.
  • Search: finds the documents closest to the text in Search Query.
  • Retriever: offers the database as a search engine for another component to use, for example an agent or a question-answering chain.

You need a Supabase API credential with your Supabase project address and key. See Credentials.

FieldWhat it does
Credential (required)The Supabase API credential with the connection details.
OperationWhat the component does: Add, Search or Retriever.
Ingest Data (required)With Add. The documents to store, usually those coming out of a text splitter or a file loader.
Search QueryWith Search. The text to search for. If left empty, nothing is returned.
EmbeddingThe connector where you plug the component that turns texts into numbers to compare them by meaning, such as OpenAI Embeddings. Always use the same one to store and to search.
Query NameThe name of the search function created in your Supabase project.

Advanced options

FieldWhat it does
Number Of ResultsHow many documents each search returns. Default: 4.
Table NameThe table where documents are stored.

Output

The outputs depend on Operation:

  • Results: with Add and Search. With Search, the list of documents found, which you can pass to a prompt or an agent.
  • Vector Store: with Add. The database, to connect it to components that work with a vector database.
  • Retriever: with Retriever. The search engine, to connect it to components that ask for one.

In tool mode, an agent can use the component to search by itself. See Tool Mode.

Example

A startup keeps its product documentation in Supabase.

  1. Add Supabase Vector Store with Operation set to Search.
  2. Choose the Supabase API credential and type the table and the search function.
  3. Connect the embeddings component it was stored with.