Skip to content
Nappai Documentation

Weaviate Cloud (v4)

Weaviate Cloud (v4) stores documents in your Weaviate Cloud database and searches it by meaning, with filters on each document’s data.

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

  • You already use Weaviate Cloud and want your flows to store and search in it.
  • You need a cloud-managed vector database for a lot of content.
  • You want to filter searches by the documents’ 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 Weaviate API credential with your Weaviate database address and key. See Credentials.

FieldWhat it does
Credential (required)The Weaviate 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.
Index Name (required)The Weaviate collection where documents are stored.

Advanced options

FieldWhat it does
Number Of ResultsHow many documents each search returns. Default: 4.
Text KeyThe Weaviate field that holds each document’s text. Default: text.
Apply Metadata FilterWith Search. Turn it on to search only among documents whose data meet some conditions, for example city equal to Barcelona. When on, Filter Mode (Manual, conditions written here; Dynamic, conditions coming from the flow), Logical Operator (AND, all; OR, any) and Number Of Filters appear.

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 digital newspaper keeps its articles in Weaviate Cloud.

  1. Add Weaviate Cloud (v4) with Operation set to Search and the Weaviate API credential.
  2. Type the collection name in Index Name and connect the same embeddings component they were stored with.
  3. Turn on Apply Metadata Filter to search only the business section.