TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ClarifyIntentToolOptions

    Per-call overrides accepted by createClarifyIntentTool.

    type ClarifyIntentToolOptions = {
        alwaysActive?: boolean;
        classificationPrompt?: string;
        description?: string;
        examplePrompts?: string[];
        examples?: string[];
        rendersForm?: boolean;
    }
    Index
    alwaysActive? classificationPrompt? description? examplePrompts? examples? rendersForm?
    alwaysActive?: boolean

    Whether the tool stays active on every step regardless of the classifier, so the agent can always ask to clarify, even mid-task. Defaults to true. false leaves activation to the classifier.

    classificationPrompt?: string

    Replace the default classifier hint.

    description?: string

    Replace the default tool description (e.g. add domain-specific guidance).

    examplePrompts?: string[]

    Replace the default natural-language example prompts.

    examples?: string[]

    Replace the default usage examples.

    rendersForm?: boolean

    Whether your host renders the clarifyIntent form. true uses the silent form contract. With false (default), the agent narrates the questions as prose so they reach a form-less UI.

    Settings
    Member Visibility

    On This Page
    Properties