Theia API Documentation v1.72.1
    Preparing search index...

    Class CodexToolCallChatResponseContent

    Interface for ChatResponseContent parts that require user interaction. Content parts that implement this interface can be tracked by the delegation renderer without content-type-specific checks.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _arguments? _confirmationRejecter? _confirmationResolver? _confirmationTimeout? _confirmed _data? _finished? _finishedResolver? _id? _name? _needsUserConfirmation _needsUserConfirmationResolver? _onDidChangeEmitter _result? _whenFinished kind onDidChange type

    Accessors

    arguments confirmationTimeout confirmed data finished id interactionId isResolved name needsUserConfirmation result whenFinished whenResolved

    Methods

    asDisplayString asString cancelConfirmation complete confirm createConfirmationPromise createFinishedPromise deny merge parseArgumentsSafe requestUserConfirmation resolveFinished toLanguageModelMessage toSerializable update updateResult is

    Constructors

    Properties

    Protected Optional_arguments

    _arguments?: string

    Protected Optional_confirmationRejecter

    _confirmationRejecter?: (reason?: unknown) => void

    Protected Optional_confirmationResolver

    _confirmationResolver?: (value: boolean) => void

    Protected Optional_confirmationTimeout

    _confirmationTimeout?: number

    Protected_confirmed

    _confirmed: Promise<boolean>

    Protected Optional_data

    _data?: Record<string, string>

    Protected Optional_finished

    _finished?: boolean

    Protected Optional_finishedResolver

    _finishedResolver?: () => void

    Protected Optional_id

    _id?: string

    Protected Optional_name

    _name?: string

    Protected_needsUserConfirmation

    _needsUserConfirmation: Promise<void>

    Protected Optional_needsUserConfirmationResolver

    _needsUserConfirmationResolver?: () => void

    Protected Readonly_onDidChangeEmitter

    _onDidChangeEmitter: Emitter<void>

    Protected Optional_result

    _result?: ToolCallResult

    Protected_whenFinished

    _whenFinished: Promise<void>
    kind: "toolCall"
    onDidChange: Event<void>

    Fires when the serialized form of this tool call changes outside of the agent's stream (e.g. after a renderer persists intermediate state via updateResult). The parent ChatResponse forwards this event so chat-session auto-save picks up the change.

    type: "codex-tool-call" = 'codex-tool-call'

    Accessors

    • get arguments(): undefined | string

      Returns undefined | string

    • get confirmationTimeout(): undefined | number

      Timeout in seconds for confirmation dialogs. 0 means no timeout.

      Returns undefined | number

    • set confirmationTimeout(value: undefined | number): void

      Timeout in seconds for confirmation dialogs. 0 means no timeout.

      Parameters

      • value: undefined | number

      Returns void

    • get confirmed(): Promise<boolean>

      Returns Promise<boolean>

    • get data(): undefined | Record<string, string>

      Provider-specific metadata about the tool call that the language model needs back on subsequent turns (e.g. Google's thoughtSignature, cache pointers). The full record is passed to the model via toLanguageModelMessage as ToolUseMessage.data.

      Returns undefined | Record<string, string>

    • get finished(): boolean

      Returns boolean

    • get id(): undefined | string

      Returns undefined | string

    • get interactionId(): undefined | string

      Stable identifier for deduplication in pending interaction tracking.

      Returns undefined | string

    • get isResolved(): boolean

      Whether the interaction has been resolved (e.g., confirmed/denied, option selected).

      Returns boolean

    • get name(): undefined | string

      Returns undefined | string

    • get needsUserConfirmation(): Promise<void>

      Resolves when the tool call requires user confirmation (show Allow/Deny UI).

      Returns Promise<void>

    • get result(): ToolCallResult

      Returns ToolCallResult

    • get whenFinished(): Promise<void>

      Returns Promise<void>

    • get whenResolved(): Promise<void>

      Resolves when the interaction is resolved. Used for cleanup in delegation chains.

      Returns Promise<void>

    Methods

    • Represents the content as a string. Returns undefined if the content is purely informational and/or visual and should not be included in the overall representation of the response.

      Returns string

    • Mark the tool call as completed with the given result.

      This is used to update the UI immediately when a tool finishes execution, without waiting for all parallel tool calls to complete. The language model batches tool results (via Promise.all) before yielding them to the stream, so without this early completion signal, the UI wouldn't update until all tools finish. The values set here will be overwritten by merge() when the language model eventually yields the results, but they should be identical.

      Parameters

      Returns void

    • Update the tool call's result without marking it finished. Use this to persist intermediate state for long-running tools (e.g. the user-interaction wizard) so progress survives chat-session reloads. On restore the tool call is always marked finished (no live handler exists anymore), so a partial result must be self-describing; consumers should not rely on finished to tell partial from final.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods