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;
    errorMessage?: string;
    latencyMs?: number;
    model?: string;
    promptTokens?: number;
    stopReason?: StudioAiStopReason;
    text?: string;
    toolArguments?: unknown;
    toolArgumentsDelta?: string;
    toolCallId?: string;
    toolName?: string;
    type: StudioAiChatEventType;
}

Properties

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

Properties

Optional Readonly ExperimentalcompletionTokens

completionTokens?: number

Optional Readonly ExperimentalerrorMessage

errorMessage?: string

Human-readable failure detail. Set on error.

Optional Readonly ExperimentallatencyMs

latencyMs?: number

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

Optional Readonly Experimentalmodel

model?: string

Model id actually used. Set on messageStart.

Optional Readonly ExperimentalpromptTokens

promptTokens?: number

Optional Readonly ExperimentalstopReason

stopReason?: StudioAiStopReason

Set on messageStop.

Optional Readonly Experimentaltext

text?: string

Incremental assistant text. Set on textDelta.

Optional Readonly ExperimentaltoolArguments

toolArguments?: unknown

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

Optional Readonly ExperimentaltoolArgumentsDelta

toolArgumentsDelta?: string

Incremental JSON-argument text. Set on toolCallDelta.

Optional Readonly ExperimentaltoolCallId

toolCallId?: string

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

Optional Readonly ExperimentaltoolName

toolName?: string

Tool name. Set on toolCallStart.

Readonly Experimentaltype

type: StudioAiChatEventType

Settings

Member Visibility

On This Page

Properties