Skip to main content

Interface: ChatResult

Normalized chat response structure returned by engines.

Properties​

conversation?​

optional conversation: ConversationState;

Updated conversation state to persist for future calls.

finish_reason​

finish_reason: string;

Reason provided by the API for ending the completion.

message?​

optional message: ChatMessage;

Assistant message when no tool call was issued.

rawResponse?​

optional rawResponse: unknown;

Provider-specific payload for debugging or auditing.

toolCalls?​

optional toolCalls: ChatFunctionCall[];

Any tool calls emitted during the completion.

voice?​

optional voice: VoiceChatResult;

Voice response metadata, when applicable.