Weaviate Vector Store node#
Use the Weaviate node to interact with your Weaviate collection as a vector store. You can insert documents into or retrieve documents from a vector database. You can also retrieve documents to provide them to a retriever connected to a chain or connect this node directly to an agent to use as a tool. On this page, you'll find the node parameters for the Weaviate node, and links to more resources.
Credentials
You can find authentication information for this node here.
Parameter resolution in sub-nodes
Sub-nodes behave differently to other nodes when processing multiple items using an expression.
Most nodes, including root nodes, take any number of items as input, process these items, and output the results. You can use expressions to refer to input items, and the node resolves the expression for each item in turn. For example, given an input of five name
values, the expression {{ $json.name }}
resolves to each name in turn.
In sub-nodes, the expression always resolves to the first item. For example, given an input of five name
values, the expression {{ $json.name }}
always resolves to the first name.
Node usage patterns#
You can use the Weaviate Vector Store node in the following patterns.
Use as a regular node to insert and retrieve documents#
You can use the Weaviate Vector Store as a regular node to insert or get documents. This pattern places the Weaviate Vector Store in the regular connection flow without using an agent.
Connect directly to an AI agent as a tool#
You can connect the Weaviate Vector Store node directly to the tool connector of an AI agent to use a vector store as a resource when answering queries.
Here, the connection would be: AI agent (tools connector) -> Weaviate Vector Store node.
Use a retriever to fetch documents#
You can use the Vector Store Retriever node with the Weaviate Vector Store node to fetch documents from the Weaviate Vector Store node. This is often used with the Question and Answer Chain node to fetch documents from the vector store that match the given chat input.
Use the Vector Store Question Answer Tool to answer questions#
Another pattern uses the Vector Store Question Answer Tool to summarize results and answer questions from the Weaviate Vector Store node. Rather than connecting the Weaviate Vector Store directly as a tool, this pattern uses a tool specifically designed to summarizes data in the vector store.
Node parameters#
Multitenancy
You can separate your data into isolated tenants for the same collection (for example, for different customers). For that, you must always provide a Tenant Name both when inserting and retrieving objects. Read more about multi tenancy in Weaviate docs.
Operation Mode#
This Vector Store node has four modes: Get Many, Insert Documents, Retrieve Documents (As Vector Store for Chain/Tool), and Retrieve Documents (As Tool for AI Agent). The mode you select determines the operations you can perform with the node and what inputs and outputs are available.
Get Many#
In this mode, you can retrieve multiple documents from your vector database by providing a prompt. The prompt will be embedded and used for similarity search. The node will return the documents that are most similar to the prompt with their similarity score. This is useful if you want to retrieve a list of similar documents and pass them to an agent as additional context.
Insert Documents#
Use Insert Documents mode to insert new documents into your vector database.
Retrieve Documents (As Vector Store for Chain/Tool)#
Use Retrieve Documents (As Vector Store for Chain/Tool) mode with a vector-store retriever to retrieve documents from a vector database and provide them to the retriever connected to a chain. In this mode you must connect the node to a retriever node or root node.
Retrieve Documents (As Tool for AI Agent)#
Use Retrieve Documents (As Tool for AI Agent) mode to use the vector store as a tool resource when answering queries. When formulating responses, the agent uses the vector store when the vector store name and description match the question details.
Get Many parameters#
- Weaviate Collection: Enter the name of the Weaviate collection to use.
- Prompt: Enter the search query.
- Limit: Enter how many results to retrieve from the vector store. For example, set this to
10
to get the ten best results.
Insert Documents parameters#
- Weaviate Collection: Enter the name of the Weaviate collection to use.
- Embedding Batch Size: The number of documents to embed in a single batch. The default is 200 documents.
Retrieve Documents (As Vector Store for Chain/Tool) parameters#
- Weaviate Collection: Enter the name of the Weaviate collection to use.
Retrieve Documents (As Tool for AI Agent) parameters#
- Weaviate Collection: The name of the vector store.
- Description: Explain to the LLM what this tool does. A good, specific description allows LLMs to produce expected results more often.
- Weaviate Collection: Enter the name of the Weaviate collection to use.
- Limit: Enter how many results to retrieve from the vector store. For example, set this to
10
to get the ten best results.
Include Metadata#
Whether to include document metadata.
You can use this with the Get Many and Retrieve Documents (As Tool for AI Agent) modes.
Rerank Results#
Enables reranking. If you enable this option, you must connect a reranking node to the vector store. That node will then rerank the results for queries. You can use this option with the Get Many
, Retrieve Documents (As Vector Store for Chain/Tool)
and Retrieve Documents (As Tool for AI Agent)
modes.
Node options#
Search Filters#
Available for the Get Many, Retrieve Documents (As Vector Store for Chain/Tool), and Retrieve Documents (As Tool for AI Agent) operation modes.
When searching for data, use this to match metadata associated with documents. You can learn more about the operators and query structure in Weaviate's conditional filters documentation.
You can use both AND
and OR
with different operators. Operators are case insensitive:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
Supported operators:
Operator | Required Field(s) | Description |
---|---|---|
'equal' |
valueString or valueNumber |
Checks if the property is equal to the given string or number. |
'like' |
valueString |
Checks if the string property matches a pattern (for example, sub-string match). |
'containsAny' |
valueTextArray (string[]) |
Checks if the property contains any of the given values. |
'containsAll' |
valueTextArray (string[]) |
Checks if the property contains all of the given values. |
'greaterThan' |
valueNumber |
Checks if the property value is greater than the given number. |
'lessThan' |
valueNumber |
Checks if the property value is less than the given number. |
'isNull' |
valueBoolean (true/false) |
Checks if the property is null or not. (must enable before ingestion) |
'withinGeoRange' |
valueGeoCoordinates (object with geolocation data) |
Filters by proximity to geographic coordinates. |
When inserting data, the document loader sets the metadata. Refer to Default Data Loader for more information on loading documents.
Metadata Keys#
You can define which metadata keys you want Weaviate to return on your queries. This can reduce network load, as you will only get properties you have defined. Returns all properties from the server by default.
Available for the Get Many, Retrieve Documents (As Vector Store for Chain/Tool), and Retrieve Documents (As Tool for AI Agent) operation modes.
Tenant Name#
The specific tenant to store or retrieve documents for.
Must enable at creation
You must pass a tenant name at first ingestion to enable multitenancy for a collection. You can't enable or disable multitenancy after creation.
Text Key#
The key in the document that contains the embedded text.
Skip Init Checks#
Whether to skip initialization checks when instantiating the client.
Init Timeout#
Number of seconds to wait before timing out during initial checks.
Insert Timeout#
Number of seconds to wait before timing out during inserts.
Query Timeout#
Number of seconds to wait before timing out during queries.
GRPC Proxy#
A proxy to use for gRPC requests.
Clear Data#
Available for the Insert Documents operation mode.
Whether to clear the collection or tenant before inserting new data.
Templates and examples#
Related resources#
Refer to LangChain's Weaviate documentation for more information about the service.
Refer to Weaviate Installation for a self hosted Weaviate Cluster.
View n8n's Advanced AI documentation.