Interface AgentChunk<State>

A streamed chunk. Mirrors GenerateResponseChunk and adds the agent fields (artifact, custom).

interface AgentChunk<State = unknown> {
    accumulatedText: string;
    artifact?: {
        metadata?: Record<string, any>;
        name?: string;
        parts: (
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text: string;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media: { contentType?: string; url: string };
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest: {
                    input?: unknown;
                    name: string;
                    partial?: boolean;
                    ref?: string;
                };
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse: { name: string; output?: unknown; ref?: string } & {
                    content?: (
                        | {
                            custom?: ...;
                            data?: ...;
                            media?: ...;
                            metadata?: ...;
                            reasoning?: ...;
                            resource?: ...;
                            text: ...;
                            toolRequest?: ...;
                            toolResponse?: ...;
                        }
                        | {
                            custom?: ...;
                            data?: ...;
                            media: ...;
                            metadata?: ...;
                            reasoning?: ...;
                            resource?: ...;
                            text?: ...;
                            toolRequest?: ...;
                            toolResponse?: ...;
                        }
                        | {
                            custom?: ...;
                            data?: ...;
                            media?: ...;
                            metadata?: ...;
                            reasoning?: ...;
                            resource?: ...;
                            text?: ...;
                            toolRequest: ...;
                            toolResponse?: ...;
                        }
                        | {
                            custom?: ...;
                            data?: ...;
                            media?: ...;
                            metadata?: ...;
                            reasoning?: ...;
                            resource?: ...;
                            text?: ...;
                            toolRequest?: ...;
                            toolResponse: ...;
                        }
                        | {
                            custom?: ...;
                            data?: ...;
                            media?: ...;
                            metadata?: ...;
                            reasoning?: ...;
                            resource?: ...;
                            text?: ...;
                            toolRequest?: ...;
                            toolResponse?: ...;
                        }
                        | {
                            custom: ...;
                            data?: ...;
                            media?: ...;
                            metadata?: ...;
                            reasoning?: ...;
                            resource?: ...;
                            text?: ...;
                            toolRequest?: ...;
                            toolResponse?: ...;
                        }
                        | {
                            custom?: ...;
                            data?: ...;
                            media?: ...;
                            metadata?: ...;
                            reasoning: ...;
                            resource?: ...;
                            text?: ...;
                            toolRequest?: ...;
                            toolResponse?: ...;
                        }
                        | {
                            custom?: ...;
                            data?: ...;
                            media?: ...;
                            metadata?: ...;
                            reasoning?: ...;
                            resource: ...;
                            text?: ...;
                            toolRequest?: ...;
                            toolResponse?: ...;
                        }
                    )[];
                };
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom: Record<string, any>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning: string;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource: { uri: string };
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
        )[];
    };
    custom?: State;
    data: unknown;
    media: { contentType?: string; url: string }
    | null;
    raw: {
        artifact?: {
            metadata?: Record<string, any>;
            name?: string;
            parts: (
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text: string;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media: { contentType?: string; url: string };
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest: {
                        input?: unknown;
                        name: string;
                        partial?: boolean;
                        ref?: string;
                    };
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse: { name: string; output?: unknown; ref?: string } & {
                        content?: (
                            (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                        )[];
                    };
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom: Record<string, any>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning: string;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource: { uri: string };
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
            )[];
        };
        customPatch?: {
            from?: string;
            op: "replace"
            | "add"
            | "remove"
            | "copy"
            | "move"
            | "test";
            path: string;
            value?: any;
        }[];
        modelChunk?: {
            aggregated?: boolean;
            content: (
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text: string;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media: { contentType?: string; url: string };
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest: {
                        input?: unknown;
                        name: string;
                        partial?: boolean;
                        ref?: string;
                    };
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse: { name: string; output?: unknown; ref?: string } & {
                        content?: (
                            (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                        )[];
                    };
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom: Record<string, any>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning: string;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource: { uri: string };
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
            )[];
            custom?: unknown;
            index?: number;
            role?: "user"
            | "model"
            | "tool"
            | "system";
        };
        turnEnd?: {
            finishReason?: | "length"
            | "stop"
            | "failed"
            | "other"
            | "unknown"
            | "interrupted"
            | "blocked"
            | "aborted"
            | "detached";
            snapshotId?: string;
        };
    };
    reasoning: string;
    text: string;
    toolRequests: {
        custom?: Record<string, unknown>;
        data?: unknown;
        media?: undefined;
        metadata?: Record<string, unknown>;
        reasoning?: undefined;
        resource?: undefined;
        text?: undefined;
        toolRequest: {
            input?: unknown;
            name: string;
            partial?: boolean;
            ref?: string;
        };
        toolResponse?: undefined;
    }[];
}

Type Parameters

State = unknown

Index

Properties

accumulatedText artifact? custom? data media raw reasoning text toolRequests

Properties

`Readonly`accumulatedText

accumulatedText: string

`Optional` `Readonly`artifact

artifact?: {
    metadata?: Record<string, any>;
    name?: string;
    parts: (
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text: string;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media: { contentType?: string; url: string };
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest: {
                input?: unknown;
                name: string;
                partial?: boolean;
                ref?: string;
            };
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse: { name: string; output?: unknown; ref?: string } & {
                content?: (
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                )[];
            };
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom: Record<string, any>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning: string;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource: { uri: string };
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
    )[];
}

`Optional` `Readonly`custom

custom?: State

The full, post-patch custom state. Present only on chunks that carry a custom-state update; undefined on text / model chunks. Each value is a fresh object reference (the client applies the streamed RFC 6902 JSON Patch onto a clone), so it is safe to use for === change detection in UI frameworks. Equivalent to the value AgentChat.state returns at the moment this chunk is yielded.

`Readonly`data

data: unknown

`Readonly`media

media: { contentType?: string; url: string } | null

`Readonly`raw

raw: {
    artifact?: {
        metadata?: Record<string, any>;
        name?: string;
        parts: (
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text: string;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media: { contentType?: string; url: string };
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest: {
                    input?: unknown;
                    name: string;
                    partial?: boolean;
                    ref?: string;
                };
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse: { name: string; output?: unknown; ref?: string } & {
                    content?: (
                        (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                    )[];
                };
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom: Record<string, any>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning: string;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource: { uri: string };
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
        )[];
    };
    customPatch?: {
        from?: string;
        op: "replace"
        | "add"
        | "remove"
        | "copy"
        | "move"
        | "test";
        path: string;
        value?: any;
    }[];
    modelChunk?: {
        aggregated?: boolean;
        content: (
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text: string;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media: { contentType?: string; url: string };
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest: {
                    input?: unknown;
                    name: string;
                    partial?: boolean;
                    ref?: string;
                };
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse: { name: string; output?: unknown; ref?: string } & {
                    content?: (
                        (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                        | (...)
                    )[];
                };
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom: Record<string, any>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning: string;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource: { uri: string };
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
        )[];
        custom?: unknown;
        index?: number;
        role?: "user"
        | "model"
        | "tool"
        | "system";
    };
    turnEnd?: {
        finishReason?: | "length"
        | "stop"
        | "failed"
        | "other"
        | "unknown"
        | "interrupted"
        | "blocked"
        | "aborted"
        | "detached";
        snapshotId?: string;
    };
}

`Readonly`reasoning

reasoning: string

`Readonly`text

text: string

`Readonly`toolRequests

toolRequests: {
    custom?: Record<string, unknown>;
    data?: unknown;
    media?: undefined;
    metadata?: Record<string, unknown>;
    reasoning?: undefined;
    resource?: undefined;
    text?: undefined;
    toolRequest: {
        input?: unknown;
        name: string;
        partial?: boolean;
        ref?: string;
    };
    toolResponse?: undefined;
}[]

Interface AgentChunk<State>

Type Parameters

Index

Properties

Properties

`Readonly`accumulatedText

`Optional` `Readonly`artifact

`Optional` `Readonly`custom

`Readonly`data

`Readonly`media

`Readonly`raw

`Readonly`reasoning

`Readonly`text

`Readonly`toolRequests

Settings

On This Page

Interface AgentChunk<State>

Type Parameters

Index

Properties

Properties

ReadonlyaccumulatedText

Optional Readonlyartifact

Optional Readonlycustom

Readonlydata

Readonlymedia

Readonlyraw

Readonlyreasoning

Readonlytext

ReadonlytoolRequests

Settings

On This Page

`Readonly`accumulatedText

`Optional` `Readonly`artifact

`Optional` `Readonly`custom

`Readonly`data

`Readonly`media

`Readonly`raw

`Readonly`reasoning

`Readonly`text

`Readonly`toolRequests