InputGuardrailFunctionArgs
Arguments for an input guardrail function.
Type Parameters
Section titled “Type Parameters”Type Parameter | Default type |
---|---|
|
Properties
Section titled “Properties”agent: Agent<any, any>;
The agent that is being run.
context
Section titled “context”context: RunContext<TContext>;
The context of the agent run.
input: | string | ( | { content: | string | ( | { providerData: Record<string, any>; text: string; type: "input_text"; } | { image: | string | { id: string; }; providerData: Record<string, any>; type: "input_image"; } | { file: | string | { id: string; }; providerData: Record<string, any>; type: "input_file"; } | { audio: | string | { id: string; }; format: null | string; providerData: Record<string, any>; transcript: null | string; type: "audio"; })[]; id: string; providerData: Record<string, any>; role: "user"; type: "message"; } | { content: ( | { providerData: Record<string, any>; refusal: string; type: "refusal"; } | { providerData: Record<string, any>; text: string; type: "output_text"; } | { providerData: Record<string, any>; text: string; type: "input_text"; } | { audio: | string | { id: string; }; format: null | string; providerData: Record<string, any>; transcript: null | string; type: "audio"; } | { image: string; providerData: Record<string, any>; type: "image"; })[]; id: string; providerData: Record<string, any>; role: "assistant"; status: "in_progress" | "completed" | "incomplete"; type: "message"; } | { content: string; id: string; providerData: Record<string, any>; role: "system"; type: "message"; } | { id: string; name: string; output: string; providerData: Record<string, any>; status: string; type: "hosted_tool_call"; } | { arguments: string; callId: string; id: string; name: string; providerData: Record<string, any>; status: "in_progress" | "completed" | "incomplete"; type: "function_call"; } | { action: | { type: "screenshot"; } | { button: "left" | "right" | "wheel" | "back" | "forward"; type: "click"; x: number; y: number; } | { type: "double_click"; x: number; y: number; } | { scroll_x: number; scroll_y: number; type: "scroll"; x: number; y: number; } | { text: string; type: "type"; } | { type: "wait"; } | { type: "move"; x: number; y: number; } | { keys: string[]; type: "keypress"; } | { path: object[]; type: "drag"; }; callId: string; id: string; providerData: Record<string, any>; status: "in_progress" | "completed" | "incomplete"; type: "computer_call"; } | { callId: string; id: string; name: string; output: | { providerData: Record<string, any>; text: string; type: "text"; } | { data: string; mediaType: string; providerData: Record<string, any>; type: "image"; }; providerData: Record<string, any>; status: "in_progress" | "completed" | "incomplete"; type: "function_call_result"; } | { callId: string; id: string; output: { data: string; providerData: Record<string, any>; type: "computer_screenshot"; }; providerData: Record<string, any>; type: "computer_call_result"; } | { content: object[]; id: string; providerData: Record<string, any>; type: "reasoning"; } | { id: string; providerData: Record<string, any>; type: "unknown"; })[];
The input to the agent.