Interface MessageStartChunk

Describes the start of a streamed message in a chat response.

interface MessageStartChunk {
    contentFilterResults?: ContentFilterResults;
    contextSnippetCount?: number;
    id: string;
    model: string;
    role: string;
    type: "message_start";
}

Hierarchy (View Summary)

Properties

contentFilterResults? contextSnippetCount? id model role type

Properties

OptionalcontentFilterResults

contentFilterResults?: ContentFilterResults

The results of any content filtering applied to the response.

OptionalcontextSnippetCount

contextSnippetCount?: number

The number of context snippets used to generate the response.

id

id: string

The unique identifier for the streaming response.

model

model: string

The model used to generate the response.

role

role: string

The role of the message sender. Either user or assistant.

type

type: "message_start"

The type of the chunk indicating the beginning of the stream.

Settings

Member Visibility

On This Page

Properties