Interface ChatStreamResult

Result of a completed or cancelled streaming chat request.

interface ChatStreamResult {
    aborted?: boolean;
    attachments?: StoredAttachment[];
    reply: string;
    sources?: Source[];
    toolUses?: ToolUse[];
}

Hierarchy (View Summary)

ChatResponse
- ChatStreamResult

Index

Properties

aborted? attachments? reply sources? toolUses?

Properties

`Optional`aborted

aborted?: boolean

true when the caller cancelled the stream before it finished.

`Optional`attachments

attachments?: StoredAttachment[]

Attachments the worker stored while handling this request, when any.

reply

reply: string

The assistant's reply text.

`Optional`sources

sources?: Source[]

Sources the assistant cited, when any.

`Optional`toolUses

toolUses?: ToolUse[]

Tools the assistant called while producing the reply, when any.