Package com.openai.models.beta.responses
See: Description
-
Class Summary Class Description Builder A builder for BetaApplyPatchTool. AllowedCaller BetaApplyPatchTool Allows the assistant to create, delete, or update files using unified diffs. Builder A builder for BetaCompactedResponse. BetaCompactedResponse Builder A builder for Click. Button Indicates which mouse button was pressed during the click. Click A click action. Builder A builder for DoubleClick. DoubleClick A double click action. Builder A builder for Drag. Builder A builder for Path. Path An x/y coordinate pair, e.g. Drag A drag action. Builder A builder for Keypress. Keypress A collection of keypresses the model would like to perform. Builder A builder for Move. Move A mouse move action. Builder A builder for Scroll. Scroll A scroll action. Builder A builder for Type. Type An action to type in text. BetaComputerAction A click action. Builder A builder for BetaComputerTool. BetaComputerTool A tool that controls a virtual computer. Builder A builder for BetaComputerUsePreviewTool. Environment The type of computer environment to control. BetaComputerUsePreviewTool A tool that controls a virtual computer. Builder A builder for BetaContainerAuto. MemoryLimit The memory limit for the container. NetworkPolicy Network access policy for the container. Skill BetaContainerAuto Builder A builder for BetaContainerNetworkPolicyAllowlist. BetaContainerNetworkPolicyAllowlist Builder A builder for BetaContainerNetworkPolicyDisabled. BetaContainerNetworkPolicyDisabled Builder A builder for BetaContainerNetworkPolicyDomainSecret. BetaContainerNetworkPolicyDomainSecret Builder A builder for BetaContainerReference. BetaContainerReference Builder A builder for BetaCustomTool. AllowedCaller Builder A builder for Grammar. Syntax The syntax of the grammar definition. Grammar A grammar defined by the user. Format The input format for the custom tool. BetaCustomTool A custom tool that processes input using a specified format. Builder A builder for BetaEasyInputMessage. Content Text, image, or audio input to the model, used to generate a response. Role The role of the message input. Phase Labels an assistantmessage as intermediate commentary (commentary) or the final answer (final_answer).Type The type of the message input. BetaEasyInputMessage A message input to the model with a role indicating instruction following hierarchy. Builder A builder for BetaFileSearchTool. Builder A builder for ComparisonFilter. Type Specifies the comparison operator: eq,ne,gt,gte,lt,lte,in,nin.ComparisonFilterValueItem Value The value to compare against the attribute key; supports string, number, or boolean types. ComparisonFilter A filter used to compare a specified attribute key to a given value using a defined comparison operation. Builder A builder for CompoundFilter. Builder A builder for ComparisonFilter. Type Specifies the comparison operator: eq,ne,gt,gte,lt,lte,in,nin.ComparisonFilterValueItem Value The value to compare against the attribute key; supports string, number, or boolean types. ComparisonFilter A filter used to compare a specified attribute key to a given value using a defined comparison operation. Filter A filter used to compare a specified attribute key to a given value using a defined comparison operation. Type Type of operation: andoror.CompoundFilter Combine multiple filters using andoror.Filters A filter to apply. Builder A builder for RankingOptions. Builder A builder for HybridSearch. HybridSearch Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled. Ranker The ranker to use for the file search. RankingOptions Ranking options for search. BetaFileSearchTool A tool that searches for relevant content from uploaded files. Builder A builder for BetaFunctionShellTool. AllowedCaller Environment BetaFunctionShellTool A tool that allows the model to execute shell commands. Builder A builder for BetaFunctionTool. Builder A builder for Parameters. Parameters A JSON schema object describing the parameters of the function. AllowedCaller Builder A builder for OutputSchema. OutputSchema A JSON schema object describing the JSON value encoded in string outputs for this function. BetaFunctionTool Defines a function in your own code the model can choose to call. Builder A builder for BetaInlineSkill. BetaInlineSkill Builder A builder for BetaInlineSkillSource. BetaInlineSkillSource Inline skill payload Builder A builder for BetaLocalEnvironment. BetaLocalEnvironment Builder A builder for BetaLocalSkill. BetaLocalSkill Builder A builder for BetaNamespaceTool. Builder A builder for Function. AllowedCaller Builder A builder for OutputSchema. OutputSchema A JSON Schema describing the JSON value encoded in string outputs for this function tool. Function Tool A function or custom tool that belongs to a namespace. BetaNamespaceTool Groups function/custom tools under a shared namespace. Builder A builder for BetaResponse. Builder A builder for IncompleteDetails. Reason The reason why the response is incomplete. IncompleteDetails Details about why the response is incomplete. Instructions A system (or developer) message inserted into the model's context. Builder A builder for Metadata. Metadata Set of 16 key-value pairs that can be attached to an object. Model Model ID used to generate the response, like gpt-4ooro3.ToolChoice How the model should select which tool (or tools) to use when generating a response. Builder A builder for Conversation. Conversation The conversation that this response belonged to. Builder A builder for Moderation. Builder A builder for ModerationResult. Builder A builder for Categories. Categories A dictionary of moderation categories to booleans, True if the input is flagged under this category. Builder A builder for CategoryAppliedInputTypes. CategoryAppliedInputTypes Which modalities of input are reflected by the score for each category. Builder A builder for CategoryScores. CategoryScores A dictionary of moderation categories to scores. ModerationResult A moderation result produced for the response input or output. Builder A builder for Error. Error An error produced while attempting moderation for the response input or output. Input Moderation for the response input. Builder A builder for ModerationResult. Builder A builder for Categories. Categories A dictionary of moderation categories to booleans, True if the input is flagged under this category. Builder A builder for CategoryAppliedInputTypes. CategoryAppliedInputTypes Which modalities of input are reflected by the score for each category. Builder A builder for CategoryScores. CategoryScores A dictionary of moderation categories to scores. ModerationResult A moderation result produced for the response input or output. Builder A builder for Error. Error An error produced while attempting moderation for the response input or output. Output Moderation for the response output. Moderation Moderation results for the response input and output, if moderated completions were requested. Builder A builder for PromptCacheOptions. Mode Whether implicit prompt-cache breakpoints were enabled. Ttl The minimum lifetime applied to each cache breakpoint. PromptCacheOptions The prompt-caching options that were applied to the response. PromptCacheRetention Deprecated. Builder A builder for Reasoning. Context Controls which reasoning items are rendered back to the model on later turns. Effort Constrains effort on reasoning for reasoning models. GenerateSummary Deprecated: use summaryinstead.Mode Controls the reasoning execution mode for the request. Summary A summary of the reasoning performed by the model. Reasoning gpt-5 and o-series models onlyConfiguration options for reasoning models. ServiceTier Specifies the processing type used for serving the request. Truncation The truncation strategy to use for the model response. BetaResponse Builder A builder for BetaResponseApplyPatchToolCall. Builder A builder for CreateFile. CreateFile Instruction describing how to create a file via the apply_patch tool. Builder A builder for DeleteFile. DeleteFile Instruction describing how to delete a file via the apply_patch tool. Builder A builder for UpdateFile. UpdateFile Instruction describing how to update a file via the apply_patch tool. Operation One of the create_file, delete_file, or update_file operations applied via apply_patch. Status The status of the apply patch tool call. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. BetaResponseApplyPatchToolCall A tool call that applies file diffs by creating, deleting, or updating files. Builder A builder for BetaResponseApplyPatchToolCallOutput. Status The status of the apply patch tool call output. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. BetaResponseApplyPatchToolCallOutput The output emitted by an apply patch tool call. Builder A builder for BetaResponseAudioDeltaEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseAudioDeltaEvent Emitted when there is a partial audio response. Builder A builder for BetaResponseAudioDoneEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseAudioDoneEvent Emitted when the audio response is complete. Builder A builder for BetaResponseAudioTranscriptDeltaEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseAudioTranscriptDeltaEvent Emitted when there is a partial transcript of audio. Builder A builder for BetaResponseAudioTranscriptDoneEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseAudioTranscriptDoneEvent Emitted when the full audio transcript is completed. Builder A builder for BetaResponseCodeInterpreterCallCodeDeltaEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseCodeInterpreterCallCodeDeltaEvent Emitted when a partial code snippet is streamed by the code interpreter. Builder A builder for BetaResponseCodeInterpreterCallCodeDoneEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseCodeInterpreterCallCodeDoneEvent Emitted when the code snippet is finalized by the code interpreter. Builder A builder for BetaResponseCodeInterpreterCallCompletedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseCodeInterpreterCallCompletedEvent Emitted when the code interpreter call is completed. Builder A builder for BetaResponseCodeInterpreterCallInProgressEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseCodeInterpreterCallInProgressEvent Emitted when a code interpreter call is in progress. Builder A builder for BetaResponseCodeInterpreterCallInterpretingEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseCodeInterpreterCallInterpretingEvent Emitted when the code interpreter is actively interpreting the code snippet. Builder A builder for BetaResponseCodeInterpreterToolCall. Builder A builder for Logs. Logs The logs output from the code interpreter. Builder A builder for Image. Image The image output from the code interpreter. Output The logs output from the code interpreter. Status The status of the code interpreter tool call. Builder A builder for Agent. Agent The agent that produced this item. BetaResponseCodeInterpreterToolCall A tool call to run code. Builder A builder for BetaResponseCompactionItem. Builder A builder for Agent. Agent The agent that produced this item. BetaResponseCompactionItem A compaction item generated by the v1/responses/compactAPI.Builder A builder for BetaResponseCompactionItemParam. Builder A builder for Agent. Agent The agent that produced this item. BetaResponseCompactionItemParam A compaction item generated by the v1/responses/compactAPI.Builder A builder for BetaResponseCompletedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseCompletedEvent Emitted when the model response is complete. Builder A builder for BetaResponseComputerToolCall. Builder A builder for PendingSafetyCheck. PendingSafetyCheck A pending safety check for the computer call. Status The status of the item. Type The type of the computer call. Builder A builder for Agent. Agent The agent that produced this item. BetaResponseComputerToolCall A tool call to a computer use tool. Builder A builder for BetaResponseComputerToolCallOutputItem. Status The status of the message input. Builder A builder for AcknowledgedSafetyCheck. AcknowledgedSafetyCheck A pending safety check for the computer call. Builder A builder for Agent. Agent The agent that produced this item. BetaResponseComputerToolCallOutputItem Builder A builder for BetaResponseComputerToolCallOutputScreenshot. BetaResponseComputerToolCallOutputScreenshot A computer screenshot image used with the computer use tool. Builder A builder for BetaResponseContainerReference. BetaResponseContainerReference Represents a container created with /v1/containers. Builder A builder for ReasoningText. ReasoningText Reasoning text from the model. BetaResponseContent Multi-modal input and output contents. Builder A builder for BetaResponseContentPartAddedEvent. Builder A builder for ReasoningText. ReasoningText Reasoning text from the model. Part The content part that was added. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseContentPartAddedEvent Emitted when a new content part is added. Builder A builder for BetaResponseContentPartDoneEvent. Builder A builder for ReasoningText. ReasoningText Reasoning text from the model. Part The content part that is done. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseContentPartDoneEvent Emitted when a content part is done. Builder A builder for BetaResponseConversationParam. BetaResponseConversationParam The conversation that this response belongs to. Builder A builder for BetaResponseCreatedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseCreatedEvent An event that is emitted when a response is created. Builder A builder for BetaResponseCustomToolCall. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. BetaResponseCustomToolCall A call to a custom tool created by the model. Builder A builder for BetaResponseCustomToolCallInputDeltaEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseCustomToolCallInputDeltaEvent Event representing a delta (partial update) to the input of a custom tool call. Builder A builder for BetaResponseCustomToolCallInputDoneEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseCustomToolCallInputDoneEvent Event indicating that input for a custom tool call is complete. Builder A builder for BetaResponseCustomToolCallItem. Status The status of the item. BetaResponseCustomToolCallItem A call to a custom tool created by the model. Builder A builder for BetaResponseCustomToolCallOutput. BetaFunctionAndCustomToolCallOutput A text input to the model. Output The output from the custom tool call generated by your code. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. BetaResponseCustomToolCallOutput The output of a custom tool call from your code, being sent back to the model. Builder A builder for BetaResponseCustomToolCallOutputItem. Status The status of the item. BetaResponseCustomToolCallOutputItem The output of a custom tool call from your code, being sent back to the model. Builder A builder for BetaResponseError. Code The error code for the response. BetaResponseError An error object returned when the model fails to generate a Response. Builder A builder for BetaResponseErrorEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseErrorEvent Emitted when an error occurs. Builder A builder for BetaResponseFailedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseFailedEvent An event that is emitted when a response fails. Builder A builder for BetaResponseFileSearchCallCompletedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseFileSearchCallCompletedEvent Emitted when a file search call is completed (results found). Builder A builder for BetaResponseFileSearchCallInProgressEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseFileSearchCallInProgressEvent Emitted when a file search call is initiated. Builder A builder for BetaResponseFileSearchCallSearchingEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseFileSearchCallSearchingEvent Emitted when a file search is currently searching. Builder A builder for BetaResponseFileSearchToolCall. Status The status of the file search tool call. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Result. Builder A builder for Attributes. Attributes Set of 16 key-value pairs that can be attached to an object. Result BetaResponseFileSearchToolCall The results of a file search tool call. BetaResponseFormatTextConfig An object specifying the format that the model must output. Builder A builder for BetaResponseFormatTextJsonSchemaConfig. Builder A builder for Schema. Schema The schema for the response format, described as a JSON Schema object. BetaResponseFormatTextJsonSchemaConfig JSON Schema response format. Builder A builder for BetaResponseFunctionCallArgumentsDeltaEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseFunctionCallArgumentsDeltaEvent Emitted when there is a partial function-call arguments delta. Builder A builder for BetaResponseFunctionCallArgumentsDoneEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseFunctionCallArgumentsDoneEvent Emitted when function-call arguments are finalized. BetaResponseFunctionCallOutputItem A piece of message content, such as text, an image, or a file. Builder A builder for BetaResponseFunctionShellCallOutputContent. Builder A builder for Exit. Exit Indicates that the shell commands finished and returned an exit code. Outcome The exit or timeout outcome associated with this shell call. BetaResponseFunctionShellCallOutputContent Captured stdout and stderr for a portion of a shell tool call output. Builder A builder for BetaResponseFunctionShellToolCall. Builder A builder for Action. Action The shell commands and limits that describe how to run the tool call. Environment Represents the use of a local environment to perform shell actions. Status The status of the shell call. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. BetaResponseFunctionShellToolCall A tool call that executes one or more shell commands in a managed environment. Builder A builder for BetaResponseFunctionShellToolCallOutput. Builder A builder for Output. Builder A builder for Exit. Exit Indicates that the shell commands finished and returned an exit code. Outcome Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk. Output The content of a shell tool call output that was emitted. Status The status of the shell call output. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. BetaResponseFunctionShellToolCallOutput The output of a shell tool call that was emitted. Builder A builder for BetaResponseFunctionToolCall. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. Status The status of the item. BetaResponseFunctionToolCall A tool call to run a function. Builder A builder for BetaResponseFunctionToolCallItem. Status The status of the item. BetaResponseFunctionToolCallItem A tool call to run a function. Builder A builder for BetaResponseFunctionToolCallOutputItem. BetaFunctionAndCustomToolCallOutput A text input to the model. Output The output from the function call generated by your code. Status The status of the item. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. BetaResponseFunctionToolCallOutputItem Builder A builder for BetaResponseFunctionWebSearch. Builder A builder for Search. Builder A builder for Source. Source A source used in the search. Search Action type "search" - Performs a web search query. Builder A builder for OpenPage. OpenPage Action type "open_page" - Opens a specific URL from search results. Builder A builder for FindInPage. FindInPage Action type "find_in_page": Searches for a pattern within a loaded page. Action An object describing the specific action taken in this web search call. Status The status of the web search tool call. Builder A builder for Agent. Agent The agent that produced this item. BetaResponseFunctionWebSearch The results of a web search tool call. Builder A builder for BetaResponseImageGenCallCompletedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseImageGenCallCompletedEvent Emitted when an image generation tool call has completed and the final image is available. Builder A builder for BetaResponseImageGenCallGeneratingEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseImageGenCallGeneratingEvent Emitted when an image generation tool call is actively generating an image (intermediate state). Builder A builder for BetaResponseImageGenCallInProgressEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseImageGenCallInProgressEvent Emitted when an image generation tool call is in progress. Builder A builder for BetaResponseImageGenCallPartialImageEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseImageGenCallPartialImageEvent Emitted when a partial image is available during image generation streaming. Builder A builder for BetaResponseInProgressEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseInProgressEvent Emitted when the response is in progress. BetaResponseIncludable Specify additional output data to include in the model response. Builder A builder for BetaResponseIncompleteEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseIncompleteEvent An event that is emitted when a response finishes as incomplete. Builder A builder for BetaResponseInjectCreatedEvent. BetaResponseInjectCreatedEvent Emitted when all injected input items were validated and committed to the active response. Builder A builder for BetaResponseInjectEvent. BetaResponseInjectEvent Injects input items into an active response over a WebSocket connection. Builder A builder for BetaResponseInjectFailedEvent. Builder A builder for Error. Code A machine-readable error code. Error Information about why the input was not committed. BetaResponseInjectFailedEvent Emitted when injected input could not be committed to a response. Builder A builder for BetaResponseInputAudio. Builder A builder for InputAudio. Format The format of the audio data. InputAudio BetaResponseInputAudio An audio input to the model. BetaResponseInputContent A text input to the model. Builder A builder for BetaResponseInputFile. Detail The detail level of the file to be sent to the model. Builder A builder for PromptCacheBreakpoint. PromptCacheBreakpoint Marks the exact end of a reusable prompt prefix. BetaResponseInputFile A file input to the model. Builder A builder for BetaResponseInputFileContent. Detail The detail level of the file to be sent to the model. Builder A builder for PromptCacheBreakpoint. PromptCacheBreakpoint Marks the exact end of a reusable prompt prefix. BetaResponseInputFileContent A file input to the model. Builder A builder for BetaResponseInputImage. Detail The detail level of the image to be sent to the model. Builder A builder for PromptCacheBreakpoint. PromptCacheBreakpoint Marks the exact end of a reusable prompt prefix. BetaResponseInputImage An image input to the model. Builder A builder for BetaResponseInputImageContent. Detail The detail level of the image to be sent to the model. Builder A builder for PromptCacheBreakpoint. PromptCacheBreakpoint Marks the exact end of a reusable prompt prefix. BetaResponseInputImageContent An image input to the model. Builder A builder for Message. Role The role of the message input. Builder A builder for Agent. Agent The agent that produced this item. Status The status of item. Type The type of the message input. Message A message input to the model with a role indicating instruction following hierarchy. Builder A builder for ComputerCallOutput. Builder A builder for AcknowledgedSafetyCheck. AcknowledgedSafetyCheck A pending safety check for the computer call. Builder A builder for Agent. Agent The agent that produced this item. Status The status of the message input. ComputerCallOutput The output of a computer tool call. Builder A builder for FunctionCallOutput. Output Text, image, or file output of the function tool call. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. Status The status of the item. FunctionCallOutput The output of a function tool call. Builder A builder for AgentMessage. Builder A builder for EncryptedContent. EncryptedContent Opaque encrypted content that Responses API decrypts inside trusted model execution. Content A plaintext, image, or encrypted agent message content part. Builder A builder for Agent. Agent The agent that produced this item. AgentMessage A message routed between agents. Builder A builder for MultiAgentCall. Action The multi-agent action that was executed. Builder A builder for Agent. Agent The agent that produced this item. MultiAgentCall Builder A builder for MultiAgentCallOutput. Action The multi-agent action that produced this result. Builder A builder for Output. Builder A builder for BetaFileCitationParam. BetaFileCitationParam Builder A builder for BetaUrlCitationParam. BetaUrlCitationParam Builder A builder for BetaContainerFileCitationParam. BetaContainerFileCitationParam Annotations Citations associated with the text content. Output Builder A builder for Agent. Agent The agent that produced this item. MultiAgentCallOutput Builder A builder for ToolSearchCall. Builder A builder for Agent. Agent The agent that produced this item. Execution Whether tool search was executed by the server or by the client. Status The status of the tool search call. ToolSearchCall Builder A builder for AdditionalTools. Builder A builder for Agent. Agent The agent that produced this item. AdditionalTools Builder A builder for ImageGenerationCall. Status The status of the image generation call. Builder A builder for Agent. Agent The agent that produced this item. ImageGenerationCall An image generation request made by the model. Builder A builder for LocalShellCall. Builder A builder for Action. Builder A builder for Env. Env Environment variables to set for the command. Action Execute a shell command on the server. Status The status of the local shell call. Builder A builder for Agent. Agent The agent that produced this item. LocalShellCall A tool call to run a command on the local shell. Builder A builder for LocalShellCallOutput. Builder A builder for Agent. Agent The agent that produced this item. Status The status of the item. LocalShellCallOutput The output of a local shell tool call. Builder A builder for ShellCall. Builder A builder for Action. Action The shell commands and limits that describe how to run the tool call. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. Environment The environment to execute the shell commands in. Status The status of the shell call. ShellCall A tool representing a request to execute one or more shell commands. Builder A builder for ShellCallOutput. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. Status The status of the shell call output. ShellCallOutput The streamed output items emitted by a shell tool call. Builder A builder for ApplyPatchCall. Builder A builder for CreateFile. CreateFile Instruction for creating a new file via the apply_patch tool. Builder A builder for DeleteFile. DeleteFile Instruction for deleting an existing file via the apply_patch tool. Builder A builder for UpdateFile. UpdateFile Instruction for updating an existing file via the apply_patch tool. Operation The specific create, delete, or update instruction for the apply_patch tool call. Status The status of the apply patch tool call. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. ApplyPatchCall A tool call representing a request to create, delete, or update files using diff patches. Builder A builder for ApplyPatchCallOutput. Status The status of the apply patch tool call output. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Program. Program Caller The execution context that produced this tool call. ApplyPatchCallOutput The streamed output emitted by an apply patch tool call. Builder A builder for McpListTools. Builder A builder for Tool. Tool A tool available on an MCP server. Builder A builder for Agent. Agent The agent that produced this item. McpListTools A list of tools available on an MCP server. Builder A builder for McpApprovalRequest. Builder A builder for Agent. Agent The agent that produced this item. McpApprovalRequest A request for human approval of a tool invocation. Builder A builder for McpApprovalResponse. Builder A builder for Agent. Agent The agent that produced this item. McpApprovalResponse A response to an MCP approval request. Builder A builder for McpCall. Builder A builder for Agent. Agent The agent that produced this item. Status The status of the tool call. McpCall An invocation of a tool on an MCP server. Builder A builder for CompactionTrigger. Builder A builder for Agent. Agent The agent that produced this item. CompactionTrigger Compacts the current context. Builder A builder for ItemReference. Builder A builder for Agent. Agent The agent that produced this item. Type The type of item to reference. ItemReference An internal identifier for an item to reference. Builder A builder for Program. Builder A builder for Agent. Agent The agent that produced this item. Program Builder A builder for ProgramOutput. Status The terminal status of the program output. Builder A builder for Agent. Agent The agent that produced this item. ProgramOutput BetaResponseInputItem A message input to the model with a role indicating instruction following hierarchy. Builder A builder for BetaResponseInputMessageItem. Role The role of the message input. Builder A builder for Agent. Agent The agent that produced this item. Status The status of item. BetaResponseInputMessageItem Builder A builder for BetaResponseInputText. Builder A builder for PromptCacheBreakpoint. PromptCacheBreakpoint Marks the exact end of a reusable prompt prefix. BetaResponseInputText A text input to the model. Builder A builder for BetaResponseInputTextContent. Builder A builder for PromptCacheBreakpoint. PromptCacheBreakpoint Marks the exact end of a reusable prompt prefix. BetaResponseInputTextContent A text input to the model. Builder A builder for AgentMessage. Builder A builder for Text. Text A text content. Builder A builder for SummaryText. SummaryText A summary text from the model. Builder A builder for ReasoningText. ReasoningText Reasoning text from the model. Builder A builder for ComputerScreenshot. Detail The detail level of the screenshot image to be sent to the model. Builder A builder for PromptCacheBreakpoint. PromptCacheBreakpoint Marks the exact end of a reusable prompt prefix. ComputerScreenshot A screenshot of a computer. Builder A builder for EncryptedContent. EncryptedContent Opaque encrypted content that Responses API decrypts inside trusted model execution. Content A content part that makes up an input or output item. Builder A builder for Agent. Agent The agent that produced this item. AgentMessage Builder A builder for MultiAgentCall. Action The multi-agent action to execute. Builder A builder for Agent. Agent The agent that produced this item. MultiAgentCall Builder A builder for MultiAgentCallOutput. Action The multi-agent action that produced this result. Builder A builder for Agent. Agent The agent that produced this item. MultiAgentCallOutput Builder A builder for AdditionalTools. Role The role that provided the additional tools. Builder A builder for Agent. Agent The agent that produced this item. AdditionalTools Builder A builder for Program. Builder A builder for Agent. Agent The agent that produced this item. Program Builder A builder for ProgramOutput. Status The terminal status of the program output item. Builder A builder for Agent. Agent The agent that produced this item. ProgramOutput Builder A builder for ImageGenerationCall. Status The status of the image generation call. Builder A builder for Agent. Agent The agent that produced this item. ImageGenerationCall An image generation request made by the model. Builder A builder for LocalShellCall. Builder A builder for Action. Builder A builder for Env. Env Environment variables to set for the command. Action Execute a shell command on the server. Status The status of the local shell call. Builder A builder for Agent. Agent The agent that produced this item. LocalShellCall A tool call to run a command on the local shell. Builder A builder for LocalShellCallOutput. Builder A builder for Agent. Agent The agent that produced this item. Status The status of the item. LocalShellCallOutput The output of a local shell tool call. Builder A builder for McpListTools. Builder A builder for Tool. Tool A tool available on an MCP server. Builder A builder for Agent. Agent The agent that produced this item. McpListTools A list of tools available on an MCP server. Builder A builder for McpApprovalRequest. Builder A builder for Agent. Agent The agent that produced this item. McpApprovalRequest A request for human approval of a tool invocation. Builder A builder for McpApprovalResponse. Builder A builder for Agent. Agent The agent that produced this item. McpApprovalResponse A response to an MCP approval request. Builder A builder for McpCall. Builder A builder for Agent. Agent The agent that produced this item. Status The status of the tool call. McpCall An invocation of a tool on an MCP server. BetaResponseItem Content item used to generate a response. Builder A builder for BetaResponseLocalEnvironment. BetaResponseLocalEnvironment Represents the use of a local environment to perform shell actions. Builder A builder for BetaResponseMcpCallArgumentsDeltaEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseMcpCallArgumentsDeltaEvent Emitted when there is a delta (partial update) to the arguments of an MCP tool call. Builder A builder for BetaResponseMcpCallArgumentsDoneEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseMcpCallArgumentsDoneEvent Emitted when the arguments for an MCP tool call are finalized. Builder A builder for BetaResponseMcpCallCompletedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseMcpCallCompletedEvent Emitted when an MCP tool call has completed successfully. Builder A builder for BetaResponseMcpCallFailedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseMcpCallFailedEvent Emitted when an MCP tool call has failed. Builder A builder for BetaResponseMcpCallInProgressEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseMcpCallInProgressEvent Emitted when an MCP tool call is in progress. Builder A builder for BetaResponseMcpListToolsCompletedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseMcpListToolsCompletedEvent Emitted when the list of available MCP tools has been successfully retrieved. Builder A builder for BetaResponseMcpListToolsFailedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseMcpListToolsFailedEvent Emitted when the attempt to list available MCP tools has failed. Builder A builder for BetaResponseMcpListToolsInProgressEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseMcpListToolsInProgressEvent Emitted when the system is in the process of retrieving the list of available MCP tools. Builder A builder for BetaResponseOutputAudio. BetaResponseOutputAudio An audio output from the model. Builder A builder for AgentMessage. Builder A builder for Text. Text A text content. Builder A builder for SummaryText. SummaryText A summary text from the model. Builder A builder for ReasoningText. ReasoningText Reasoning text from the model. Builder A builder for ComputerScreenshot. Detail The detail level of the screenshot image to be sent to the model. Builder A builder for PromptCacheBreakpoint. PromptCacheBreakpoint Marks the exact end of a reusable prompt prefix. ComputerScreenshot A screenshot of a computer. Builder A builder for EncryptedContent. EncryptedContent Opaque encrypted content that Responses API decrypts inside trusted model execution. Content A content part that makes up an input or output item. Builder A builder for Agent. Agent The agent that produced this item. AgentMessage Builder A builder for MultiAgentCall. Action The multi-agent action to execute. Builder A builder for Agent. Agent The agent that produced this item. MultiAgentCall Builder A builder for MultiAgentCallOutput. Action The multi-agent action that produced this result. Builder A builder for Agent. Agent The agent that produced this item. MultiAgentCallOutput Builder A builder for Program. Builder A builder for Agent. Agent The agent that produced this item. Program Builder A builder for ProgramOutput. Status The terminal status of the program output item. Builder A builder for Agent. Agent The agent that produced this item. ProgramOutput Builder A builder for AdditionalTools. Role The role that provided the additional tools. Builder A builder for Agent. Agent The agent that produced this item. AdditionalTools Builder A builder for ImageGenerationCall. Status The status of the image generation call. Builder A builder for Agent. Agent The agent that produced this item. ImageGenerationCall An image generation request made by the model. Builder A builder for LocalShellCall. Builder A builder for Action. Builder A builder for Env. Env Environment variables to set for the command. Action Execute a shell command on the server. Status The status of the local shell call. Builder A builder for Agent. Agent The agent that produced this item. LocalShellCall A tool call to run a command on the local shell. Builder A builder for LocalShellCallOutput. Builder A builder for Agent. Agent The agent that produced this item. Status The status of the item. LocalShellCallOutput The output of a local shell tool call. Builder A builder for McpCall. Builder A builder for Agent. Agent The agent that produced this item. Status The status of the tool call. McpCall An invocation of a tool on an MCP server. Builder A builder for McpListTools. Builder A builder for Tool. Tool A tool available on an MCP server. Builder A builder for Agent. Agent The agent that produced this item. McpListTools A list of tools available on an MCP server. Builder A builder for McpApprovalRequest. Builder A builder for Agent. Agent The agent that produced this item. McpApprovalRequest A request for human approval of a tool invocation. Builder A builder for McpApprovalResponse. Builder A builder for Agent. Agent The agent that produced this item. McpApprovalResponse A response to an MCP approval request. BetaResponseOutputItem An output message from the model. Builder A builder for BetaResponseOutputItemAddedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseOutputItemAddedEvent Emitted when a new output item is added. Builder A builder for BetaResponseOutputItemDoneEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseOutputItemDoneEvent Emitted when an output item is marked done. Builder A builder for BetaResponseOutputMessage. Content A text output from the model. Status The status of the message input. Builder A builder for Agent. Agent The agent that produced this item. Phase Labels an assistantmessage as intermediate commentary (commentary) or the final answer (final_answer).BetaResponseOutputMessage An output message from the model. Builder A builder for BetaResponseOutputRefusal. BetaResponseOutputRefusal A refusal from the model. Builder A builder for BetaResponseOutputText. Builder A builder for FileCitation. FileCitation A citation to a file. Builder A builder for UrlCitation. UrlCitation A citation for a web resource used to generate a model response. Builder A builder for ContainerFileCitation. ContainerFileCitation A citation for a container file used to generate a model response. Builder A builder for FilePath. FilePath A path to a file. Annotation An annotation that applies to a span of output text. Builder A builder for Logprob. Builder A builder for TopLogprob. TopLogprob The top log probability of a token. Logprob The log probability of a token. BetaResponseOutputText A text output from the model. Builder A builder for BetaResponseOutputTextAnnotationAddedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseOutputTextAnnotationAddedEvent Emitted when an annotation is added to output text content. Builder A builder for BetaResponsePrompt. Builder A builder for Variables. Variables Optional map of values to substitute in for variables in your prompt. BetaResponsePrompt Reference to a prompt template and its variables. Builder A builder for BetaResponseQueuedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseQueuedEvent Emitted when a response is queued and waiting to be processed. Builder A builder for BetaResponseReasoningItem. Builder A builder for Summary. Summary A summary text from the model. Builder A builder for Agent. Agent The agent that produced this item. Builder A builder for Content. Content Reasoning text from the model. Status The status of the item. BetaResponseReasoningItem A description of the chain of thought used by a reasoning model while generating a response. Builder A builder for BetaResponseReasoningSummaryPartAddedEvent. Builder A builder for Part. Part The summary part that was added. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseReasoningSummaryPartAddedEvent Emitted when a new reasoning summary part is added. Builder A builder for BetaResponseReasoningSummaryPartDoneEvent. Builder A builder for Part. Part The completed summary part. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. Status The completion status of the summary part. BetaResponseReasoningSummaryPartDoneEvent Emitted when a reasoning summary part is completed. Builder A builder for BetaResponseReasoningSummaryTextDeltaEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseReasoningSummaryTextDeltaEvent Emitted when a delta is added to a reasoning summary text. Builder A builder for BetaResponseReasoningSummaryTextDoneEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseReasoningSummaryTextDoneEvent Emitted when a reasoning summary text is completed. Builder A builder for BetaResponseReasoningTextDeltaEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseReasoningTextDeltaEvent Emitted when a delta is added to a reasoning text. Builder A builder for BetaResponseReasoningTextDoneEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseReasoningTextDoneEvent Emitted when a reasoning text is completed. Builder A builder for BetaResponseRefusalDeltaEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseRefusalDeltaEvent Emitted when there is a partial refusal text. Builder A builder for BetaResponseRefusalDoneEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseRefusalDoneEvent Emitted when refusal text is finalized. BetaResponseStatus The status of the response generation. BetaResponseStreamEvent Emitted when there is a partial audio response. Builder A builder for BetaResponseTextConfig. Verbosity Constrains the verbosity of the model's response. BetaResponseTextConfig Configuration options for a text response from the model. Builder A builder for BetaResponseTextDeltaEvent. Builder A builder for Logprob. Builder A builder for TopLogprob. TopLogprob Logprob A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseTextDeltaEvent Emitted when there is an additional text delta. Builder A builder for BetaResponseTextDoneEvent. Builder A builder for Logprob. Builder A builder for TopLogprob. TopLogprob Logprob A logprob is the logarithmic probability that the model assigns to producing a particular token at a given position in the sequence. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseTextDoneEvent Emitted when text content is finalized. Builder A builder for BetaResponseToolSearchCall. Execution Whether tool search was executed by the server or by the client. Status The status of the tool search call item that was recorded. Builder A builder for Agent. Agent The agent that produced this item. BetaResponseToolSearchCall Builder A builder for BetaResponseToolSearchOutputItem. Execution Whether tool search was executed by the server or by the client. Status The status of the tool search output item that was recorded. Builder A builder for Agent. Agent The agent that produced this item. BetaResponseToolSearchOutputItem Builder A builder for BetaResponseToolSearchOutputItemParam. Builder A builder for Agent. Agent The agent that produced this item. Execution Whether tool search was executed by the server or by the client. Status The status of the tool search output. BetaResponseToolSearchOutputItemParam Builder A builder for BetaResponseUsage. Builder A builder for InputTokensDetails. InputTokensDetails A detailed breakdown of the input tokens. Builder A builder for OutputTokensDetails. OutputTokensDetails A detailed breakdown of the output tokens. BetaResponseUsage Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Builder A builder for BetaResponseWebSearchCallCompletedEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseWebSearchCallCompletedEvent Emitted when a web search call is completed. Builder A builder for BetaResponseWebSearchCallInProgressEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseWebSearchCallInProgressEvent Emitted when a web search call is initiated. Builder A builder for BetaResponseWebSearchCallSearchingEvent. Builder A builder for Agent. Agent The agent that owns this multi-agent streaming event. BetaResponseWebSearchCallSearchingEvent Emitted when a web search call is executing. Builder A builder for ResponseCreate. Builder A builder for ContextManagement. ContextManagement Conversation The conversation that this response belongs to. Input Text, image, or file inputs to the model, used to generate a response. Builder A builder for Metadata. Metadata Set of 16 key-value pairs that can be attached to an object. Model Model ID used to generate the response, like gpt-4ooro3.Builder A builder for Moderation. Builder A builder for Policy. Builder A builder for Input. Mode Input The moderation policy for the response input. Builder A builder for Output. Mode Output The moderation policy for the response output. Policy The policy to apply to moderated response input and output. Moderation Configuration for running moderation on the input and output of this response. Builder A builder for MultiAgent. MultiAgent Configuration for server-hosted multi-agent execution. Builder A builder for PromptCacheOptions. Mode Controls whether OpenAI automatically creates an implicit cache breakpoint. Ttl The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. PromptCacheOptions Options for prompt caching. PromptCacheRetention Deprecated. Builder A builder for Reasoning. Context Controls which reasoning items are rendered back to the model on later turns. Effort Constrains effort on reasoning for reasoning models. GenerateSummary Deprecated: use summaryinstead.Mode Controls the reasoning execution mode for the request. Summary A summary of the reasoning performed by the model. Reasoning gpt-5 and o-series models onlyConfiguration options for reasoning models. ServiceTier Specifies the processing type used for serving the request. Builder A builder for StreamOptions. StreamOptions Options for streaming responses. ToolChoice How the model should select which tool (or tools) to use when generating a response. Truncation The truncation strategy to use for the model response. ResponseCreate Client event for creating a response over a persistent WebSocket connection. BetaResponsesClientEvent Client events accepted by the Responses WebSocket server. BetaResponsesServerEvent Server events emitted by the Responses WebSocket server. Builder A builder for BetaSkillReference. BetaSkillReference Builder A builder for Mcp. AllowedCaller Builder A builder for McpToolFilter. McpToolFilter A filter object to specify which tools are allowed. AllowedTools List of allowed tool names or a filter object. ConnectorId Identifier for service connectors, like those available in ChatGPT. Builder A builder for Headers. Headers Optional HTTP headers to send to the MCP server. Builder A builder for McpToolApprovalFilter. Builder A builder for Always. Always A filter object to specify which tools are allowed. Builder A builder for Never. Never A filter object to specify which tools are allowed. McpToolApprovalFilter Specify which of the MCP server's tools require approval. McpToolApprovalSetting Specify a single approval policy for all tools. RequireApproval Specify which of the MCP server's tools require approval. Mcp Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Builder A builder for CodeInterpreter. Builder A builder for CodeInterpreterToolAuto. MemoryLimit The memory limit for the code interpreter container. NetworkPolicy Network access policy for the container. CodeInterpreterToolAuto Configuration for a code interpreter container. Container The code interpreter container. AllowedCaller CodeInterpreter A tool that runs Python code to help generate a response to a prompt. Builder A builder for ImageGeneration. Action Whether to generate a new image or edit an existing image. Background Allows to set transparency for the background of the generated image(s). InputFidelity Control how much effort the model will exert to match the style and features, especially facial features, of input images. Builder A builder for InputImageMask. InputImageMask Optional mask for inpainting. Model The image generation model to use. Moderation Moderation level for the generated image. OutputFormat The output format of the generated image. Quality The quality of the generated image. Size The size of the generated images. ImageGeneration A tool that generates images using the GPT image models. BetaTool A tool that can be used to generate a response. Builder A builder for BetaToolChoiceAllowed. Mode Constrains the tools available to the model to a pre-defined set. Builder A builder for Tool. Tool A tool definition that the model should be allowed to call. BetaToolChoiceAllowed Constrains the tools available to the model to a pre-defined set. Builder A builder for BetaToolChoiceApplyPatch. BetaToolChoiceApplyPatch Forces the model to call the apply_patch tool when executing a tool call. Builder A builder for BetaToolChoiceCustom. BetaToolChoiceCustom Use this option to force the model to call a specific custom tool. Builder A builder for BetaToolChoiceFunction. BetaToolChoiceFunction Use this option to force the model to call a specific function. Builder A builder for BetaToolChoiceMcp. BetaToolChoiceMcp Use this option to force the model to call a specific tool on a remote MCP server. BetaToolChoiceOptions Controls which (if any) tool is called by the model. Builder A builder for BetaToolChoiceShell. BetaToolChoiceShell Forces the model to call the shell tool when a tool call is required. Builder A builder for BetaToolChoiceTypes. Type The type of hosted tool the model should to use. BetaToolChoiceTypes Indicates that the model should use a built-in tool to generate a response. Builder A builder for BetaToolSearchTool. Execution Whether tool search is executed by the server or by the client. BetaToolSearchTool Hosted or BYOT tool search configuration for deferred tools. Builder A builder for BetaWebSearchPreviewTool. Type The type of the web search tool. SearchContentType SearchContextSize High level guidance for the amount of context window space to use for the search. Builder A builder for UserLocation. UserLocation The user's location. BetaWebSearchPreviewTool This tool searches the web for relevant results to use in a response. Builder A builder for BetaWebSearchTool. Type The type of the web search tool. Builder A builder for Filters. Filters Filters for the search. SearchContextSize High level guidance for the amount of context window space to use for the search. Builder A builder for UserLocation. Type The type of location approximation. UserLocation The approximate location of the user. BetaWebSearchTool Search the Internet for sources related to the prompt. Builder A builder for ResponseCancelParams. Beta ResponseCancelParams Cancels a model response with the given ID. Builder A builder for ResponseCompactParams. Builder A builder for Body. Body Model Model ID used to generate the response, like gpt-5oro3.Input Text, image, or file inputs to the model, used to generate a response Builder A builder for PromptCacheOptions. Mode Controls whether OpenAI automatically creates an implicit cache breakpoint. Ttl The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. PromptCacheOptions Options for prompt caching. PromptCacheRetention How long to retain a prompt cache entry created by this request. ServiceTier The service tier to use for this request. Beta ResponseCompactParams Compact a conversation. Builder A builder for ResponseCreateParams. Builder A builder for Body. Body Builder A builder for ContextManagement. ContextManagement Conversation The conversation that this response belongs to. Input Text, image, or file inputs to the model, used to generate a response. Builder A builder for Metadata. Metadata Set of 16 key-value pairs that can be attached to an object. Model Model ID used to generate the response, like gpt-4ooro3.Builder A builder for Moderation. Builder A builder for Policy. Builder A builder for Input. Mode Input The moderation policy for the response input. Builder A builder for Output. Mode Output The moderation policy for the response output. Policy The policy to apply to moderated response input and output. Moderation Configuration for running moderation on the input and output of this response. Builder A builder for MultiAgent. MultiAgent Configuration for server-hosted multi-agent execution. Builder A builder for PromptCacheOptions. Mode Controls whether OpenAI automatically creates an implicit cache breakpoint. Ttl The minimum lifetime applied to every implicit and explicit cache breakpoint written by the request. PromptCacheOptions Options for prompt caching. PromptCacheRetention Deprecated. Builder A builder for Reasoning. Context Controls which reasoning items are rendered back to the model on later turns. Effort Constrains effort on reasoning for reasoning models. GenerateSummary Deprecated: use summaryinstead.Mode Controls the reasoning execution mode for the request. Summary A summary of the reasoning performed by the model. Reasoning gpt-5 and o-series models onlyConfiguration options for reasoning models. ServiceTier Specifies the processing type used for serving the request. Builder A builder for StreamOptions. StreamOptions Options for streaming responses. ToolChoice How the model should select which tool (or tools) to use when generating a response. Truncation The truncation strategy to use for the model response. Beta ResponseCreateParams Creates a model response. Builder A builder for ResponseDeleteParams. Beta ResponseDeleteParams Deletes a model response with the given ID. Builder A builder for ResponseRetrieveParams. Beta ResponseRetrieveParams Retrieves a model response with the given ID. -
Enum Summary Enum Description Known An enum containing AllowedCaller's known values. Value An enum containing AllowedCaller's known values, as well as an _UNKNOWN member. Known An enum containing Button's known values. Value An enum containing Button's known values, as well as an _UNKNOWN member. Known An enum containing Environment's known values. Value An enum containing Environment's known values, as well as an _UNKNOWN member. Known An enum containing MemoryLimit's known values. Value An enum containing MemoryLimit's known values, as well as an _UNKNOWN member. Known An enum containing AllowedCaller's known values. Value An enum containing AllowedCaller's known values, as well as an _UNKNOWN member. Known An enum containing Syntax's known values. Value An enum containing Syntax's known values, as well as an _UNKNOWN member. Known An enum containing Role's known values. Value An enum containing Role's known values, as well as an _UNKNOWN member. Known An enum containing Phase's known values. Value An enum containing Phase's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Ranker's known values. Value An enum containing Ranker's known values, as well as an _UNKNOWN member. Known An enum containing AllowedCaller's known values. Value An enum containing AllowedCaller's known values, as well as an _UNKNOWN member. Known An enum containing AllowedCaller's known values. Value An enum containing AllowedCaller's known values, as well as an _UNKNOWN member. Known An enum containing AllowedCaller's known values. Value An enum containing AllowedCaller's known values, as well as an _UNKNOWN member. Known An enum containing Reason's known values. Value An enum containing Reason's known values, as well as an _UNKNOWN member. Known An enum containing Model's known values. Value An enum containing Model's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Ttl's known values. Value An enum containing Ttl's known values, as well as an _UNKNOWN member. Known An enum containing PromptCacheRetention's known values. Value An enum containing PromptCacheRetention's known values, as well as an _UNKNOWN member. Known An enum containing Context's known values. Value An enum containing Context's known values, as well as an _UNKNOWN member. Known An enum containing Effort's known values. Value An enum containing Effort's known values, as well as an _UNKNOWN member. Known An enum containing GenerateSummary's known values. Value An enum containing GenerateSummary's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Summary's known values. Value An enum containing Summary's known values, as well as an _UNKNOWN member. Known An enum containing ServiceTier's known values. Value An enum containing ServiceTier's known values, as well as an _UNKNOWN member. Known An enum containing Truncation's known values. Value An enum containing Truncation's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Code's known values. Value An enum containing Code's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing BetaResponseIncludable's known values. Value An enum containing BetaResponseIncludable's known values, as well as an _UNKNOWN member. Known An enum containing Code's known values. Value An enum containing Code's known values, as well as an _UNKNOWN member. Known An enum containing Format's known values. Value An enum containing Format's known values, as well as an _UNKNOWN member. Known An enum containing Detail's known values. Value An enum containing Detail's known values, as well as an _UNKNOWN member. Known An enum containing Detail's known values. Value An enum containing Detail's known values, as well as an _UNKNOWN member. Known An enum containing Detail's known values. Value An enum containing Detail's known values, as well as an _UNKNOWN member. Known An enum containing Detail's known values. Value An enum containing Detail's known values, as well as an _UNKNOWN member. Known An enum containing Role's known values. Value An enum containing Role's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Action's known values. Value An enum containing Action's known values, as well as an _UNKNOWN member. Known An enum containing Action's known values. Value An enum containing Action's known values, as well as an _UNKNOWN member. Known An enum containing Execution's known values. Value An enum containing Execution's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Role's known values. Value An enum containing Role's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Detail's known values. Value An enum containing Detail's known values, as well as an _UNKNOWN member. Known An enum containing Action's known values. Value An enum containing Action's known values, as well as an _UNKNOWN member. Known An enum containing Action's known values. Value An enum containing Action's known values, as well as an _UNKNOWN member. Known An enum containing Role's known values. Value An enum containing Role's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Detail's known values. Value An enum containing Detail's known values, as well as an _UNKNOWN member. Known An enum containing Action's known values. Value An enum containing Action's known values, as well as an _UNKNOWN member. Known An enum containing Action's known values. Value An enum containing Action's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Role's known values. Value An enum containing Role's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Phase's known values. Value An enum containing Phase's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing BetaResponseStatus's known values. Value An enum containing BetaResponseStatus's known values, as well as an _UNKNOWN member. Known An enum containing Verbosity's known values. Value An enum containing Verbosity's known values, as well as an _UNKNOWN member. Known An enum containing Execution's known values. Value An enum containing Execution's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Execution's known values. Value An enum containing Execution's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Execution's known values. Value An enum containing Execution's known values, as well as an _UNKNOWN member. Known An enum containing Status's known values. Value An enum containing Status's known values, as well as an _UNKNOWN member. Known An enum containing Model's known values. Value An enum containing Model's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Ttl's known values. Value An enum containing Ttl's known values, as well as an _UNKNOWN member. Known An enum containing PromptCacheRetention's known values. Value An enum containing PromptCacheRetention's known values, as well as an _UNKNOWN member. Known An enum containing Context's known values. Value An enum containing Context's known values, as well as an _UNKNOWN member. Known An enum containing Effort's known values. Value An enum containing Effort's known values, as well as an _UNKNOWN member. Known An enum containing GenerateSummary's known values. Value An enum containing GenerateSummary's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Summary's known values. Value An enum containing Summary's known values, as well as an _UNKNOWN member. Known An enum containing ServiceTier's known values. Value An enum containing ServiceTier's known values, as well as an _UNKNOWN member. Known An enum containing Truncation's known values. Value An enum containing Truncation's known values, as well as an _UNKNOWN member. Known An enum containing AllowedCaller's known values. Value An enum containing AllowedCaller's known values, as well as an _UNKNOWN member. Known An enum containing ConnectorId's known values. Value An enum containing ConnectorId's known values, as well as an _UNKNOWN member. Known An enum containing McpToolApprovalSetting's known values. Value An enum containing McpToolApprovalSetting's known values, as well as an _UNKNOWN member. Known An enum containing MemoryLimit's known values. Value An enum containing MemoryLimit's known values, as well as an _UNKNOWN member. Known An enum containing AllowedCaller's known values. Value An enum containing AllowedCaller's known values, as well as an _UNKNOWN member. Known An enum containing Action's known values. Value An enum containing Action's known values, as well as an _UNKNOWN member. Known An enum containing Background's known values. Value An enum containing Background's known values, as well as an _UNKNOWN member. Known An enum containing InputFidelity's known values. Value An enum containing InputFidelity's known values, as well as an _UNKNOWN member. Known An enum containing Model's known values. Value An enum containing Model's known values, as well as an _UNKNOWN member. Known An enum containing Moderation's known values. Value An enum containing Moderation's known values, as well as an _UNKNOWN member. Known An enum containing OutputFormat's known values. Value An enum containing OutputFormat's known values, as well as an _UNKNOWN member. Known An enum containing Quality's known values. Value An enum containing Quality's known values, as well as an _UNKNOWN member. Known An enum containing Size's known values. Value An enum containing Size's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing BetaToolChoiceOptions's known values. Value An enum containing BetaToolChoiceOptions's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Execution's known values. Value An enum containing Execution's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing SearchContentType's known values. Value An enum containing SearchContentType's known values, as well as an _UNKNOWN member. Known An enum containing SearchContextSize's known values. Value An enum containing SearchContextSize's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing SearchContextSize's known values. Value An enum containing SearchContextSize's known values, as well as an _UNKNOWN member. Known An enum containing Type's known values. Value An enum containing Type's known values, as well as an _UNKNOWN member. Known An enum containing Beta's known values. Value An enum containing Beta's known values, as well as an _UNKNOWN member. Known An enum containing Model's known values. Value An enum containing Model's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Ttl's known values. Value An enum containing Ttl's known values, as well as an _UNKNOWN member. Known An enum containing PromptCacheRetention's known values. Value An enum containing PromptCacheRetention's known values, as well as an _UNKNOWN member. Known An enum containing ServiceTier's known values. Value An enum containing ServiceTier's known values, as well as an _UNKNOWN member. Known An enum containing Beta's known values. Value An enum containing Beta's known values, as well as an _UNKNOWN member. Known An enum containing Model's known values. Value An enum containing Model's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Ttl's known values. Value An enum containing Ttl's known values, as well as an _UNKNOWN member. Known An enum containing PromptCacheRetention's known values. Value An enum containing PromptCacheRetention's known values, as well as an _UNKNOWN member. Known An enum containing Context's known values. Value An enum containing Context's known values, as well as an _UNKNOWN member. Known An enum containing Effort's known values. Value An enum containing Effort's known values, as well as an _UNKNOWN member. Known An enum containing GenerateSummary's known values. Value An enum containing GenerateSummary's known values, as well as an _UNKNOWN member. Known An enum containing Mode's known values. Value An enum containing Mode's known values, as well as an _UNKNOWN member. Known An enum containing Summary's known values. Value An enum containing Summary's known values, as well as an _UNKNOWN member. Known An enum containing ServiceTier's known values. Value An enum containing ServiceTier's known values, as well as an _UNKNOWN member. Known An enum containing Truncation's known values. Value An enum containing Truncation's known values, as well as an _UNKNOWN member. Known An enum containing Beta's known values. Value An enum containing Beta's known values, as well as an _UNKNOWN member. Known An enum containing Beta's known values. Value An enum containing Beta's known values, as well as an _UNKNOWN member. Known An enum containing Beta's known values. Value An enum containing Beta's known values, as well as an _UNKNOWN member. -
Interface Summary Interface Description Visitor An interface that defines how to map each variant of BetaComputerAction to a value of type T. Visitor An interface that defines how to map each variant of NetworkPolicy to a value of type T. Visitor An interface that defines how to map each variant of Skill to a value of type T. Visitor An interface that defines how to map each variant of Format to a value of type T. Visitor An interface that defines how to map each variant of Content to a value of type T. Visitor An interface that defines how to map each variant of Filters to a value of type T. Visitor An interface that defines how to map each variant of Value to a value of type T. Visitor An interface that defines how to map each variant of ComparisonFilterValueItem to a value of type T. Visitor An interface that defines how to map each variant of Filter to a value of type T. Visitor An interface that defines how to map each variant of Value to a value of type T. Visitor An interface that defines how to map each variant of ComparisonFilterValueItem to a value of type T. Visitor An interface that defines how to map each variant of Environment to a value of type T. Visitor An interface that defines how to map each variant of Tool to a value of type T. Visitor An interface that defines how to map each variant of Instructions to a value of type T. Visitor An interface that defines how to map each variant of ToolChoice to a value of type T. Visitor An interface that defines how to map each variant of Input to a value of type T. Visitor An interface that defines how to map each variant of Output to a value of type T. Visitor An interface that defines how to map each variant of Operation to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Output to a value of type T. Visitor An interface that defines how to map each variant of BetaResponseContent to a value of type T. Visitor An interface that defines how to map each variant of Part to a value of type T. Visitor An interface that defines how to map each variant of Part to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Output to a value of type T. Visitor An interface that defines how to map each variant of BetaFunctionAndCustomToolCallOutput to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of BetaResponseFormatTextConfig to a value of type T. Visitor An interface that defines how to map each variant of BetaResponseFunctionCallOutputItem to a value of type T. Visitor An interface that defines how to map each variant of Outcome to a value of type T. Visitor An interface that defines how to map each variant of Environment to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Outcome to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Output to a value of type T. Visitor An interface that defines how to map each variant of BetaFunctionAndCustomToolCallOutput to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Action to a value of type T. Visitor An interface that defines how to map each variant of BetaResponseInputContent to a value of type T. Visitor An interface that defines how to map each variant of BetaResponseInputItem to a value of type T. Visitor An interface that defines how to map each variant of Output to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Content to a value of type T. Visitor An interface that defines how to map each variant of Annotations to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Environment to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Operation to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of Caller to a value of type T. Visitor An interface that defines how to map each variant of BetaResponseItem to a value of type T. Visitor An interface that defines how to map each variant of Content to a value of type T. Visitor An interface that defines how to map each variant of BetaResponseOutputItem to a value of type T. Visitor An interface that defines how to map each variant of Content to a value of type T. Visitor An interface that defines how to map each variant of Content to a value of type T. Visitor An interface that defines how to map each variant of Annotation to a value of type T. Visitor An interface that defines how to map each variant of BetaResponseStreamEvent to a value of type T. Visitor An interface that defines how to map each variant of BetaResponsesClientEvent to a value of type T. Visitor An interface that defines how to map each variant of Conversation to a value of type T. Visitor An interface that defines how to map each variant of Input to a value of type T. Visitor An interface that defines how to map each variant of ToolChoice to a value of type T. Visitor An interface that defines how to map each variant of BetaResponsesServerEvent to a value of type T. Visitor An interface that defines how to map each variant of BetaTool to a value of type T. Visitor An interface that defines how to map each variant of AllowedTools to a value of type T. Visitor An interface that defines how to map each variant of RequireApproval to a value of type T. Visitor An interface that defines how to map each variant of Container to a value of type T. Visitor An interface that defines how to map each variant of NetworkPolicy to a value of type T. Visitor An interface that defines how to map each variant of Input to a value of type T. Visitor An interface that defines how to map each variant of Conversation to a value of type T. Visitor An interface that defines how to map each variant of Input to a value of type T. Visitor An interface that defines how to map each variant of ToolChoice to a value of type T.