@openai/agents-core
Version:
The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows.
5,178 lines • 179 kB
TypeScript
import { Agent } from './agent';
import * as protocol from './types/protocol';
import type { ToolOutputCustomData } from './utils/customData';
export declare class RunItemBase {
readonly type: string;
rawItem?: protocol.ModelItem;
toJSON(): {
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
}
/**
* An input item admitted while resuming a run.
*/
export declare class RunInputItem extends RunItemBase {
rawItem: protocol.ModelItem;
agent: Agent<any, any>;
inputId: string;
readonly type: "input_item";
constructor(rawItem: protocol.ModelItem, agent: Agent<any, any>, inputId?: string);
toJSON(): {
agent: {
name: string;
};
inputId: string;
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
}
export declare class RunMessageOutputItem extends RunItemBase {
rawItem: protocol.AssistantMessageItem;
agent: Agent;
readonly type: "message_output_item";
constructor(rawItem: protocol.AssistantMessageItem, agent: Agent);
toJSON(): {
agent: {
name: string;
};
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
get content(): string;
}
export declare class RunToolCallItem extends RunItemBase {
rawItem: protocol.ToolCallItem;
agent: Agent;
readonly type: "tool_call_item";
constructor(rawItem: protocol.ToolCallItem, agent: Agent,
/** @internal Execution-time identity for an unqualified deferred function call. */
functionToolStateKey?: string | undefined);
toJSON(): {
functionToolStateKey?: string | undefined;
agent: {
name: string;
};
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
get toolName(): string | undefined;
get callId(): string | undefined;
}
export declare class RunToolSearchCallItem extends RunItemBase {
rawItem: protocol.ToolSearchCallItem;
agent: Agent;
readonly type: "tool_search_call_item";
constructor(rawItem: protocol.ToolSearchCallItem, agent: Agent);
toJSON(): {
agent: {
name: string;
};
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
}
export declare class RunToolSearchOutputItem extends RunItemBase {
rawItem: protocol.ToolSearchOutputItem;
agent: Agent;
readonly type: "tool_search_output_item";
constructor(rawItem: protocol.ToolSearchOutputItem, agent: Agent);
toJSON(): {
agent: {
name: string;
};
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
}
export declare class RunToolCallOutputItem extends RunItemBase {
rawItem: protocol.FunctionCallResultItem | protocol.ComputerCallResultItem | protocol.ShellCallResultItem | protocol.ApplyPatchCallResultItem | protocol.ProgramCallResultItem;
agent: Agent<any, any>;
output: string | unknown;
customData?: ToolOutputCustomData | undefined;
executionStatus?: "executed" | undefined;
readonly type: "tool_call_output_item";
constructor(rawItem: protocol.FunctionCallResultItem | protocol.ComputerCallResultItem | protocol.ShellCallResultItem | protocol.ApplyPatchCallResultItem | protocol.ProgramCallResultItem, agent: Agent<any, any>, output: string | unknown, customData?: ToolOutputCustomData | undefined, executionStatus?: "executed" | undefined);
toJSON(): {
agent: {
name: string;
};
output: string;
customData: ToolOutputCustomData | undefined;
executionStatus: "executed" | undefined;
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
get callId(): string | undefined;
}
export declare class RunReasoningItem extends RunItemBase {
rawItem: protocol.ReasoningItem;
agent: Agent;
readonly type: "reasoning_item";
constructor(rawItem: protocol.ReasoningItem, agent: Agent);
toJSON(): {
agent: {
name: string;
};
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
}
/**
* A compaction marker returned by a model.
*/
export declare class RunCompactionItem extends RunItemBase {
rawItem: protocol.CompactionItem;
agent: Agent;
readonly type: "compaction_item";
constructor(rawItem: protocol.CompactionItem, agent: Agent);
toJSON(): {
agent: {
name: string;
};
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
}
export declare class RunHandoffCallItem extends RunItemBase {
rawItem: protocol.FunctionCallItem;
agent: Agent;
readonly type: "handoff_call_item";
constructor(rawItem: protocol.FunctionCallItem, agent: Agent);
toJSON(): {
agent: {
name: string;
};
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
}
export declare class RunHandoffOutputItem extends RunItemBase {
rawItem: protocol.FunctionCallResultItem;
sourceAgent: Agent<any, any>;
targetAgent: Agent<any, any>;
readonly type: "handoff_output_item";
constructor(rawItem: protocol.FunctionCallResultItem, sourceAgent: Agent<any, any>, targetAgent: Agent<any, any>);
toJSON(): {
sourceAgent: {
name: string;
};
targetAgent: {
name: string;
};
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
}
export declare class RunToolApprovalItem extends RunItemBase {
rawItem: protocol.FunctionCallItem | protocol.HostedToolCallItem | protocol.ComputerUseCallItem | protocol.ShellCallItem | protocol.ApplyPatchCallItem;
agent: Agent<any, any>;
/**
* Explicit tool name to use for approval tracking when not present on the raw item.
*/
toolName?: string | undefined;
readonly type: "tool_approval_item";
constructor(rawItem: protocol.FunctionCallItem | protocol.HostedToolCallItem | protocol.ComputerUseCallItem | protocol.ShellCallItem | protocol.ApplyPatchCallItem, agent: Agent<any, any>,
/**
* Explicit tool name to use for approval tracking when not present on the raw item.
*/
toolName?: string | undefined,
/** @internal Canonical function-tool key used by approval and resume state. */
functionToolStateKey?: string | undefined);
/**
* Returns the tool name if available on the raw item or provided explicitly.
* Kept for backwards compatibility with code that previously relied on `rawItem.name`.
*/
get name(): string | undefined;
/**
* Returns the arguments if the raw item has an arguments property otherwise this will be undefined.
*/
get arguments(): string | undefined;
toJSON(): {
agent: {
name: string;
};
toolName: string | undefined;
functionToolStateKey: string | undefined;
type: string;
rawItem: {
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
content: ({
type: "refusal";
refusal: string;
providerData?: Record<string, any> | undefined;
} | {
type: "output_text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "image";
image: string;
providerData?: Record<string, any> | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
phase?: "commentary" | "final_answer" | undefined;
} | {
role: "user";
content: string | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "audio";
audio: string | {
id: string;
};
providerData?: Record<string, any> | undefined;
format?: string | null | undefined;
transcript?: string | null | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
role: "system";
content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
type?: "message" | undefined;
} | {
type: "program";
callId: string;
code: string;
fingerprint: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "program_output";
callId: string;
output: string;
status: "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "hosted_tool_call";
name: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
arguments?: string | undefined;
status?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "function_call";
callId: string;
name: string;
arguments: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "tool_search_call";
arguments: unknown;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "tool_search_output";
tools: Record<string, any>[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
toolSearchAgentName?: string | undefined;
toolSearchMcpToolNames?: string[] | undefined;
call_id?: string | null | undefined;
callId?: string | null | undefined;
execution?: "client" | "server" | undefined;
status?: string | undefined;
} | {
type: "function_call_result";
name: string;
callId: string;
status: "in_progress" | "completed" | "incomplete";
output: string | {
type: "text";
text: string;
providerData?: Record<string, any> | undefined;
} | {
type: "image";
providerData?: Record<string, any> | undefined;
image?: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType?: string | undefined;
} | {
url: string;
} | {
fileId: string;
} | undefined;
detail?: "low" | "high" | "auto" | (string & {}) | undefined;
} | {
type: "file";
file: string | {
data: string | Uint8Array<ArrayBuffer>;
mediaType: string;
filename: string;
} | {
url: string;
filename?: string | undefined;
} | {
id: string;
filename?: string | undefined;
};
providerData?: Record<string, any> | undefined;
} | ({
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_image";
providerData?: Record<string, any> | undefined;
image?: string | {
id: string;
} | undefined;
detail?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
} | {
type: "input_file";
providerData?: Record<string, any> | undefined;
file?: string | {
id: string;
} | {
url: string;
} | undefined;
filename?: string | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
})[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
namespace?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "computer_call";
callId: string;
status: "in_progress" | "completed" | "incomplete";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
action?: {
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
} | undefined;
actions?: ({
type: "screenshot";
} | {
type: "click";
x: number;
y: number;
button: "left" | "right" | "wheel" | "back" | "forward";
} | {
type: "double_click";
x: number;
y: number;
} | {
type: "scroll";
x: number;
y: number;
scroll_x: number;
scroll_y: number;
} | {
type: "type";
text: string;
} | {
type: "wait";
} | {
type: "move";
x: number;
y: number;
} | {
type: "keypress";
keys: string[];
} | {
type: "drag";
path: {
x: number;
y: number;
}[];
})[] | undefined;
} | {
type: "computer_call_result";
callId: string;
output: {
type: "computer_screenshot";
data: string;
providerData?: Record<string, any> | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | {
type: "shell_call";
callId: string;
action: {
commands: string[];
timeoutMs?: number | undefined;
maxOutputLength?: number | undefined;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "shell_call_output";
callId: string;
output: {
[x: string]: unknown;
stdout: string;
stderr: string;
outcome: {
type: "timeout";
} | {
type: "exit";
exitCode: number | null;
};
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
status?: "in_progress" | "completed" | "incomplete" | undefined;
maxOutputLength?: number | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call";
callId: string;
status: "in_progress" | "completed";
operation: {
type: "create_file";
path: string;
diff: string;
} | {
type: "update_file";
path: string;
diff: string;
moveTo?: string | undefined;
} | {
type: "delete_file";
path: string;
};
providerData?: Record<string, any> | undefined;
id?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "apply_patch_call_output";
callId: string;
status: "completed" | "failed";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
output?: string | undefined;
caller?: {
type: "direct";
} | {
type: "program";
callerId: string;
} | undefined;
} | {
type: "reasoning";
content: {
type: "input_text";
text: string;
providerData?: Record<string, any> | undefined;
promptCacheBreakpoint?: {
mode: "explicit";
} | undefined;
}[];
providerData?: Record<string, any> | undefined;
id?: string | undefined;
rawContent?: {
type: "reasoning_text";
text: string;
providerData?: Record<string, any> | undefined;
}[] | undefined;
} | {
type: "compaction";
encrypted_content: string;
providerData?: Record<string, any> | undefined;
id?: string | undefined;
created_by?: string | undefined;
} | {
type: "unknown";
providerData?: Record<string, any> | undefined;
id?: string | undefined;
} | undefined;
};
}
export type RunItem = RunInputItem | RunMessageOutputItem | RunToolCallItem | RunToolSearchCallItem | RunToolSearchOutputItem | RunReasoningItem | RunCompactionItem | RunHandoffCallItem | RunToolCallOutputItem | RunHandoffOutputItem | RunToolApprovalItem;
/**
* Extract all text output from a list of run items by concatenating the content of all
* message output items.
*
* @param items - The list of run items to extract text from.
* @returns A string of all the text output from the run items.
*/
export declare function extractAllTextOutput(items: RunItem[]): string;