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

    Properties

    alwaysActive? classificationPrompt? description? examplePrompts? examples? rendersForm?

    Properties

    alwaysActive?: boolean

    Keep the tool active on every step regardless of the classifier (so the agent can always ask to clarify, even mid-task). Defaults to true; set false to leave 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

    Does your host render the clarifyIntent form? true → silent form contract; false (default) → the agent narrates the questions as prose so they reach a form-less UI.

    Settings

    Member Visibility

    On This Page

    Properties