Interface AIVariable

A variable is a short string that is used to reference a value that is resolved and replaced in the user prompt at request-time.

interface AIVariable {
    args?: AIVariableDescription[];
    description: string;
    iconClasses?: string[];
    id: string;
    isContextVariable?: boolean;
    label?: string;
    name: string;
}

Hierarchy (view full)

Properties

args? description iconClasses? id isContextVariable? label? name

Properties

Optional args

args?: AIVariableDescription[]

optional arguments for resolving the variable into a value

description

description: string

variable description

Optional iconClasses

iconClasses?: string[]

optional icon classes, used for showing the variable in the UI.

id

id: string

provider id

Optional isContextVariable

isContextVariable?: boolean

specifies whether this variable contributes to the context --

See

ResolvedAIContextVariable

Optional label

label?: string

optional label, used for showing the variable in the UI. If not provided, the variable name is used

name

name: string

variable name, used for referencing variables in the chat

Settings

Member Visibility

Theme

On This Page

argsdescriptioniconClassesidisContextVariablelabelname