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.
Prerequisites
The Query Agent derives its access credentials from the Weaviate client object passed to it. This can be further restricted by the collection names provided to the Query Agent.
For example, if the associated Weaviate credentials' user has access to only a subset of collections, the Query Agent will only be able to access those collections.
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 Sandbox instance on Weaviate Cloud.
At this time, the Query Agent clients are available only for Python and JavaScript/TypeScript. Support for other languages will be added in the future.
Python client
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.
Troubleshooting: Force pip to install the latest version
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.5.0
JavaScript/TypeScript client
You can install for TypeScript or JavaScript via npm:
npm install weaviate-agents@latest
Questions and feedback
If you have any questions or feedback, let us know in the user forum.