Skip to main content Module responses Copy item path Source CodeInterpreterTool ComparisonFilter Key/value comparison used by the eq/ne/gt/gte/lt/lte/in/nin filter variants. CompoundFilter Boolean composition over nested filters (used by and / or variants). ComputerCoordinate (x, y) coordinate pair used in Drag.path and Move/Click/Scroll actions.ComputerSafetyCheck One pending or acknowledged safety check attached to a computer-use call. ComputerUsePreviewTool Computer-use preview tool payload. ContainerAutoEnvironment Payload for ShellEnvironment::ContainerAuto ContainerDomainSecret Per-domain secret binding carried by
ContainerNetworkAllowlist::domain_secrets ContainerNetworkAllowlist Payload for ContainerNetworkPolicy::Allowlist ContainerReferenceEnvironment Payload for ShellEnvironment::ContainerReference CustomTool User-defined custom tool definition. CustomToolGrammar Grammar payload carried by CustomToolInputFormat::Grammar FileSearchRankingOptions Ranking options for file search results. FileSearchResult A result from file search. FileSearchTool File search tool configuration. FunctionTool HybridSearchOptions Weights combining embedding-based and text-based similarity. ImageGenerationTool Configuration payload for the image_generation built-in tool. ImageInputMask Mask reference for image-generation edit calls. Spec: { file_id?, image_url? }.
Reuses the same upload conventions as P1 InputImage. IncompleteDetails Structured detail attached to a response whose status is incomplete. InputTokensDetails LocalShellEnvironment Payload for ShellEnvironment::Local McpTool McpToolFilter Object filter selecting MCP tools by read-only flag and/or explicit names. McpToolInfo MCP Tool information for the mcp_list_tools output item NamespaceToolDef Payload carried by ResponseTool::Namespace OutputTokensDetails ReasoningInfo RequireApprovalFilter RequireApprovalRules ResponseLocalShellEnvironment Payload for ResponseShellCallEnvironment::Local ResponseReasoningParam ResponseToolEnvironment ResponseUsage OpenAI Responses API usage format (different from standard UsageInfo) ResponsesFunctionToolChoice Canonical payload for the Responses API Function tool-choice variant. ResponsesRequest ResponsesResponse ShellCallAction Action payload for ResponseInputOutputItem::ShellCallResponseOutputItem::ShellCall ShellExit Exit payload for ShellOutcome::Exit{ exit_code, type: "exit" }. ShellOutputChunk One entry of a shell_call_output.output array. ShellTool Containerized shell tool. Spec
(openai-responses-api-spec.md §tools, L463-470):
Shell { type: "shell", environment? }. TextConfig Text configuration for structured output requests WebSearchFilters Filters for the non-preview web_search tool. WebSearchPreviewTool WebSearchResult A single search result attached to a WebSearchCall when the caller
requested web_search_call.results via the top-level include[] array. WebSearchSource A source returned from web search. WebSearchTool Non-preview hosted web search tool configuration. WebSearchUserLocation Approximate user location for the non-preview web_search tool. AllowedToolsToolChoiceTag Tag enum forcing the "type": "allowed_tools" discriminator. Annotation Typed annotation attached to ResponseContentPart::OutputTextAnnotation union; a type discriminator selects
the variant on the wire. ApplyPatchCallOutputStatus Status for a ResponseInputOutputItem::ApplyPatchCallOutputResponseOutputItem::ApplyPatchCallOutput ApplyPatchCallStatus Status for a ResponseInputOutputItem::ApplyPatchCallResponseOutputItem::ApplyPatchCall ApplyPatchOperation File-edit operation payload carried by
ResponseInputOutputItem::ApplyPatchCallResponseOutputItem::ApplyPatchCall ApplyPatchToolChoiceTag Tag enum forcing the "type": "apply_patch" discriminator. BuiltInToolChoiceType Built-in (hosted) tool types that can be referenced directly by
tool_choice: {"type": "..."} in the Responses API. CodeInterpreterCallStatus Status for code interpreter tool calls. CodeInterpreterOutput Output from code interpreter execution. ComputerAction Discriminated union of computer-use actions the model may emit. ComputerCallOutputContent Output payload of a ResponseInputOutputItem::ComputerCallOutput ComputerCallStatus Status for a ResponseInputOutputItem::ComputerCallResponseOutputItem::ComputerCall ComputerEnvironment Environment selector for ComputerUsePreviewTool ContainerNetworkPolicy Network isolation policy for ContainerAutoEnvironment::network_policy CustomToolCallOutputContent Output payload variant accepted by custom_tool_call_output. CustomToolChoiceTag Tag enum forcing the "type": "custom" discriminator. CustomToolGrammarSyntax Grammar dialect for CustomToolGrammar::syntax CustomToolInputContentPart Input-only content part accepted inside a custom_tool_call_output array. CustomToolInputFormat Input-format constraint applied to a CustomTool FileDetail Detail level for ResponseContentPart::InputFile"low" | "high" (defaults to low); it is narrower than Detailauto / original. FileSearchCallStatus Status for file search tool calls. FileSearchFilter Filter expression for file search. FileSearchRanker Ranker selection for file search. FunctionToolChoiceTag Single-value tag used to force the "type": "function" discriminator on the
flat function-selection variant so the untagged outer enum can distinguish
Function from AllowedTools / Mcp / Custom / Types. ImageGenerationCallStatus Status values for an image_generation_call output item. IncludeField IncompleteReason Why a response stopped before producing complete output. ItemReferenceTypeTag Single-value tag enum pinning ResponseInputOutputItem::ItemReferencetype discriminator to the spec’s only permitted value,
"item_reference". Used because the outer enum is type-tagged and the
ItemReference variant is declared #[serde(untagged)] to accept payloads
that omit type entirely — without this pin the catch-all would silently
swallow payloads whose type discriminator is an unknown string. LocalShellCallStatus Status for local_shell tool calls. LocalShellExec action payload carried by a ResponseInputOutputItem::LocalShellCallResponseOutputItem::LocalShellCallMcpAllowedTools Allowed-tools filter for an MCP tool. McpConnectorId Service-connector identifier for hosted MCP tools. McpToolChoiceTag Tag enum forcing the "type": "mcp" discriminator. MessagePhase Phase label for assistant messages in the Responses API. MouseButton Mouse button used by the Click action. NamespaceTool Element type accepted inside a NamespaceToolDeftools array. ReasoningEffort ReasoningSummary RequireApproval require_approval values.RequireApprovalMode ResponseContentPart ResponseInput ResponseInputOutputItem ResponseOutputItem ResponseReasoningContent ResponseShellCallEnvironment Response-side environment union carried on
ResponseOutputItem::ShellCall ResponseStatus ResponseTool ResponsesToolChoice tool_choice accepted on the Responses API (POST /v1/responses).ResponsesUsage ServiceTier ShellCallEnvironment Input-side environment union carried on
ResponseInputOutputItem::ShellCall ShellCallStatus Status for ResponseInputOutputItem::ShellCallResponseOutputItem::ShellCall*_output siblings. ShellEnvironment Tool-side environment union carried on ShellTool::environment ShellOutcome Outcome of a shell call. Spec (openai-responses-api-spec.md
§ShellCallOutput, L235):
outcome: Timeout { type: "timeout" } | Exit { exit_code, type: "exit" }. ShellToolChoiceTag Tag enum forcing the "type": "shell" discriminator. SimpleInputMessageTypeTag Single-value tag enum pinning EasyInputMessage.type to the spec’s only
permitted value, "message". Used to keep ResponseInputOutputItem::SimpleInputMessage#[serde(untagged)] fallback in the outer type-tagged enum
— from silently swallowing payloads whose type discriminator is unknown
(P5 fail-fast contract). StringOrContentParts Content can be either a simple string or array of content parts (for SimpleInputMessage) SummaryTextContent Tagged content element carried in Reasoning.summary. TextFormat Text format: text (default), json_object (legacy), or json_schema (recommended) ToolChoiceOptions Simple tool-choice option strings supported by the Responses API. Truncation WebSearchAction Action performed during a web search. WebSearchCallStatus Status for web search tool calls. WebSearchContextSize Search context budget for the non-preview web_search tool. WebSearchReturnTokenBudget Search-result token budget for the non-preview web_search tool. generate_id normalize_input_item Normalize a SimpleInputMessage to a proper Message item validate_conversation_id Validate the conversation reference’s ID format.