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

    Interface ToolCallChatResponseContent

    interface ToolCallChatResponseContent {
        arguments?: string;
        confirmed: Promise<boolean>;
        data?: Record<string, string>;
        finished: boolean;
        id?: string;
        kind: "toolCall";
        name?: string;
        result?: ToolCallResult;
        whenFinished: Promise<void>;
        asDisplayString(): undefined | string;
        asString(): undefined | string;
        cancelConfirmation(reason?: unknown): void;
        complete(result: ToolCallResult): void;
        confirm(): void;
        deny(reason?: string): void;
        merge(nextChatResponseContent: ChatResponseContent): boolean;
        toLanguageModelMessage(): LanguageModelMessage | LanguageModelMessage[];
        toSerializable(): SerializableChatResponseContentData;
    }

    Hierarchy

    Implemented by

    Index

    Properties

    arguments? confirmed data? finished id? kind name? result? whenFinished

    Methods

    asDisplayString asString cancelConfirmation complete confirm deny merge toLanguageModelMessage toSerializable

    Properties

    arguments?: string
    confirmed: Promise<boolean>
    data?: Record<string, string>
    finished: boolean
    id?: string
    kind: "toolCall"
    name?: string
    result?: ToolCallResult
    whenFinished: 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 undefined | 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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods