Interface GenieAgentColumnConfig

Settings for one column of a table or metric view.

interface GenieAgentColumnConfig {
    column?: string;
    description?: string;
    displayName?: string;
    enableEntityMatching?: boolean;
    enableFormatAssistance?: boolean;
    exclude?: boolean;
    synonyms?: string[];
}

Properties

column?: string

The name of the column. Must exist in the table or metric view.

description?: string

Description of the column, overriding its Unity Catalog comment.

displayName?: string

Display name of the column in the Genie Agent. Accepted only where column display names are enabled for the workspace.

enableEntityMatching?: boolean

Whether the Genie Agent indexes the column's values to match them in questions.

enableFormatAssistance?: boolean

Whether the Genie Agent samples example values from the column to learn its format.

exclude?: boolean

Whether the column is hidden from the Genie Agent.

synonyms?: string[]

Synonyms for the column name.