Collection configuration

The Query Agent, in Ask Mode or Search Mode, has the option to search one or more of any collections that are provided to it.

These collections can either be specified by a string (the name of the collection) or via a more advanced configuration.

To give your collections without any advanced configuration, you can just pass strings of the collection names to the Query Agent.

from weaviate.agents.query import QueryAgent

qa = QueryAgent(
    client=client,
    collections=["ECommerce", "FinancialContracts"],
)

import { QueryAgent } from 'weaviate-agents';

const qaSimple = new QueryAgent(client, {
    collections: ['ECommerce', 'FinancialContracts'],
});

You can provide a more detailed configuration on how you want the agents to interact with your collections to define the tenant names (for a multi-tenant collection), target vector(s), property names and any additional filters.

from weaviate.agents.classes import QueryAgentCollectionConfig

qa = QueryAgent(
    client=client,
    collections=[
        # Use QueryAgentCollectionConfig class to provide further collection configuration
        QueryAgentCollectionConfig(
            name="ECommerce", 
            target_vector=[
                "name_description_brand_vector"
            ], 
            view_properties=[
                "name",
                "description",
                "category",
                "brand",
            ],  
        ),
        QueryAgentCollectionConfig(
            name="FinancialContracts"
        ),
    ],
)

const qa = new QueryAgent(client, {
    collections: [
        // Provide an object to specify further collection configuration
        {
            name: 'ECommerce',
            targetVector: [
                'name_description_brand_vector'
            ],
            viewProperties: [
                'name',
                'description',
                'category',
                'brand',
            ],
        },
        {
            name: 'FinancialContracts'
        },
    ],
});

The examples above show configuring collections at instantiation of the Query Agent. This defines the default collections which will be used automatically when running Ask Mode or Search Mode.

You can instead or additionally provide collection information at runtime of the Query Agent, which will override any default collections set at instantiation.

response = qa.ask(
    "Recommend some shoes below $60.",
    collections=[
        QueryAgentCollectionConfig(
            name="ECommerce",
            target_vector=[
                "name_description_brand_vector"
            ],
        ),
    ],
)

const response = await qa.ask(
    "Recommend some shoes below $60.", {
    collections: [
        {
            name: 'ECommerce',
            targetVector: [
                'name_description_brand_vector'
            ],
        }
    ],
});

Similarly to above, this collection can also be either string(s) of the collection name(s), or a set of configurations.

This is possible in both Ask and Search Mode.

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