Type Alias QueryAgentCollectionConfig

Configuration for a collection to query.

type QueryAgentCollectionConfig = {
    additionalFilters?: FilterValue;
    name: string;
    targetVector?: string | string[];
    tenant?: string;
    viewProperties?: string[];
}

Properties

additionalFilters?: FilterValue

Filters to apply when query is executed, in addition to filters selected by the Query Agent.

name: string

The name of the collection to query.

targetVector?: string | string[]

Target vector for the query if a collection uses named vector.

tenant?: string

Tenant for the collection if multi-tenancy is enabled.

viewProperties?: string[]

List of of property names the agent has the ability to view for the collection.