Interface AgentInterrupt<Input, Output>
interface AgentInterrupt<Input = unknown, Output = unknown> { input: Input; name: string; ref?: string; respond( output: Output, ): { 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: 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?: ({ text: string; custom?: Record<string, unknown> | undefined; media?: undefined; toolRequest?: undefined; toolResponse?: undefined; data?: unknown; metadata?: Record<string, unknown> | undefined; reasoning?: undefined; resource?: undefined; } | ... 6 more ... | { ...; })[] | undefined
; }; } | { 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; } )
[]; }; }; restart(): { 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
- Input = unknown
- Output = unknown
Properties
name
name: string
Optionalref
ref?: string
Methods
respond
respond( output: Output,): { 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: 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?: ({ text: string; custom?: Record<string, unknown> | undefined; media?: undefined; toolRequest?: undefined; toolResponse?: undefined; data?: unknown; metadata?: Record<string, unknown> | undefined; reasoning?: undefined; resource?: undefined; } | ... 6 more ... | { ...; })[] | undefined
; }; } | { 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; } )
[]; };} Returns {
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: 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?: ({ text: string; custom?: Record<string, unknown> | undefined; media?: undefined; toolRequest?: undefined; toolResponse?: undefined; data?: unknown; metadata?: Record<string, unknown> | undefined; reasoning?: undefined; resource?: undefined; } | ... 6 more ... | { ...; })[] | undefined;
};
}
| {
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;
}
)[];
};
}
restart
restart(): { 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;} Returns {
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;
}
A single tool request a turn paused on.
respond/restartare builders: they return the part to put into aresumepayload, they do not send.