Installation

Weaviate Cloud only

Install the Query Agent client package alongside the regular Weaviate client. Below are the prerequisites and the install commands for Python and JavaScript/TypeScript.

The Query Agent is available exclusively for use with a Weaviate Cloud instance. See the page on Weaviate Cloud for more detail.

You can try this Weaviate Agent with a free cluster on Weaviate Cloud.

For Python, you can install the Weaviate client library with the optional agents extras to use the Query Agent. This will install the weaviate-agents package along with the weaviate-client package.

Install the client library using the following command:

pip install -U "weaviate-client[agents]"

See the Python Client installation page for more detail.

For existing installations, even pip install -U "weaviate-client[agents]" may not upgrade weaviate-agents to the latest version. If this occurs, additionally try to explicitly upgrade the weaviate-agents package:

pip install -U weaviate-agents

Or install a specific version:

pip install -U weaviate-agents==1.6.0

You can install for TypeScript or JavaScript via npm:

npm install weaviate-agents@latest

Have a question or feedback? Here's how to reach us.