Interface GatheredAIAction`Alpha`

An AIAction as the AI sees it: plain data, without the functions that prepare and run it.

interface GatheredAIAction {
    description: string;
    id: string;
    inputSchema: JsonSchema;
    needsApproval: boolean;
}

Properties

description: string

Tells the AI what the action does and when to use it.

id: string

Identifies the action, e.g. 'limeobject.update' or 'explorer.filter'.

Use a stable id that is unique on the page. The AI asks for an action by this id.

inputSchema: JsonSchema

Describes the input the action takes, as a schema for a JSON object.

needsApproval: boolean

Whether the user approves the action before it runs.