@honua/sdk-js
    Preparing search index...

    Interface StudioAiChatEventExperimental

    One event in a streamed provider-neutral chat turn — a single flat shape (matches the server's StudioAiChatEvent, one C# class rather than a discriminated hierarchy). Unused fields for a given type are simply absent (the server omits nulls: DefaultIgnoreCondition = WhenWritingNull).

    interface StudioAiChatEvent {
        completionTokens?: number;
        errorCode?: string;
        errorMessage?: string;
        latencyMs?: number;
        model?: string;
        promptTokens?: number;
        provenance?: StudioAiSignedTranscript;
        stopReason?: StudioAiStopReason;
        text?: string;
        toolArguments?: unknown;
        toolArgumentsDelta?: string;
        toolCallId?: string;
        toolName?: string;
        type: StudioAiChatEventType;
    }
    Index

    Properties

    completionTokens? errorCode? errorMessage? latencyMs? model? promptTokens? provenance? stopReason? text? toolArguments? toolArgumentsDelta? toolCallId? toolName? type

    Properties

    completionTokens?: number
    errorCode?: string

    Stable non-secret failure code, set on error.

    errorMessage?: string

    Human-readable failure detail. Set on error.

    latencyMs?: number

    Wall-clock time from request dispatch to this event. Set on messageStop / error.

    model?: string

    Model id actually used. Set on messageStart.

    promptTokens?: number
    provenance?: StudioAiSignedTranscript

    Detached signed transcript, set only on transcriptProvenance.

    stopReason?: StudioAiStopReason

    Set on messageStop.

    Optional Readonly Experimentaltext

    text?: string

    Incremental assistant text. Set on textDelta.

    toolArguments?: unknown

    Full parsed arguments, when assembly succeeded. Set on toolCallStop.

    toolArgumentsDelta?: string

    Incremental JSON-argument text. Set on toolCallDelta.

    toolCallId?: string

    Tool call id. Set on toolCallStart / toolCallDelta / toolCallStop.

    toolName?: string

    Tool name. Set on toolCallStart.

    type: StudioAiChatEventType

    Settings

    Member Visibility

    On This Page

    Properties