Type Alias AgentStreamChunk
AgentStreamChunk: {
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;
};
}
Type Declaration
Optionalartifact?: {
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;
}
)[];
}
OptionalcustomPatch?: {
from?: string;
op: "replace" | "add" | "remove" | "copy" | "move" | "test";
path: string;
value?: any;
}[]
OptionalmodelChunk?: {
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";
}
OptionalturnEnd?: {
finishReason?:
| "length"
| "stop"
| "failed"
| "other"
| "unknown"
| "interrupted"
| "blocked"
| "aborted"
| "detached";
snapshotId?: string;
}
Streamed chunk emitted during agent execution.