Skip to content

FilterableFieldDescriptor

Description of a filterable metadata field, provided to the LLM so it knows which fields exist and what values they accept.

description: string;

Human-readable description of what this field represents.


optional examples?: (string | number | boolean)[];

Example values, if useful for guiding the LLM.


field: string;

The metadata field name as stored in the vector index.


type: "string" | "number" | "boolean" | "string[]";

The value type. Helps the LLM construct valid filter values.