Package com.openai.models.responses
See: Description
-
Class Summary Class Description Builder A builder for ComputerTool. Environment The type of computer environment to control. ComputerTool A tool that controls a virtual computer. Builder A builder for EasyInputMessage. Content Text, image, or audio input to the model, used to generate a response. Role The role of the message input. Type The type of the message input. EasyInputMessage A message input to the model with a role indicating instruction following hierarchy. Builder A builder for FileSearchTool. Filters A filter to apply based on file attributes. Builder A builder for RankingOptions. Ranker The ranker to use for the file search. RankingOptions Ranking options for search. FileSearchTool A tool that searches for relevant content from uploaded files. Builder A builder for FunctionTool. Builder A builder for Parameters. Parameters A JSON schema object describing the parameters of the function. FunctionTool Defines a function in your own code the model can choose to call. Builder A builder for Response. Builder A builder for IncompleteDetails. Reason The reason why the response is incomplete. IncompleteDetails Details about why the response is incomplete. Builder A builder for Metadata. Metadata Set of 16 key-value pairs that can be attached to an object. 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. Response Builder A builder for ResponseAudioDeltaEvent. ResponseAudioDeltaEvent Emitted when there is a partial audio response. Builder A builder for ResponseAudioDoneEvent. ResponseAudioDoneEvent Emitted when the audio response is complete. Builder A builder for ResponseAudioTranscriptDeltaEvent. ResponseAudioTranscriptDeltaEvent Emitted when there is a partial transcript of audio. Builder A builder for ResponseAudioTranscriptDoneEvent. ResponseAudioTranscriptDoneEvent Emitted when the full audio transcript is completed. Builder A builder for ResponseCodeInterpreterCallCodeDeltaEvent. ResponseCodeInterpreterCallCodeDeltaEvent Emitted when a partial code snippet is added by the code interpreter. Builder A builder for ResponseCodeInterpreterCallCodeDoneEvent. ResponseCodeInterpreterCallCodeDoneEvent Emitted when code snippet output is finalized by the code interpreter. Builder A builder for ResponseCodeInterpreterCallCompletedEvent. ResponseCodeInterpreterCallCompletedEvent Emitted when the code interpreter call is completed. Builder A builder for ResponseCodeInterpreterCallInProgressEvent. ResponseCodeInterpreterCallInProgressEvent Emitted when a code interpreter call is in progress. Builder A builder for ResponseCodeInterpreterCallInterpretingEvent. ResponseCodeInterpreterCallInterpretingEvent Emitted when the code interpreter is actively interpreting the code snippet. Builder A builder for ResponseCodeInterpreterToolCall. Builder A builder for Logs. Logs The output of a code interpreter tool call that is text. Builder A builder for Files. Builder A builder for File. File Files The output of a code interpreter tool call that is a file. Result The output of a code interpreter tool call that is text. Status The status of the code interpreter tool call. ResponseCodeInterpreterToolCall A tool call to run code. Builder A builder for ResponseCompletedEvent. ResponseCompletedEvent Emitted when the model response is complete. Builder A builder for ResponseComputerToolCall. 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 A series of x/y coordinate pairs in the drag path. 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. Action A click action. 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. ResponseComputerToolCall A tool call to a computer use tool. Builder A builder for ResponseComputerToolCallOutputItem. Builder A builder for AcknowledgedSafetyCheck. AcknowledgedSafetyCheck A pending safety check for the computer call. Status The status of the message input. ResponseComputerToolCallOutputItem Builder A builder for ResponseComputerToolCallOutputScreenshot. ResponseComputerToolCallOutputScreenshot A computer screenshot image used with the computer use tool. ResponseContent Multi-modal input and output contents. Builder A builder for ResponseContentPartAddedEvent. Part The content part that was added. ResponseContentPartAddedEvent Emitted when a new content part is added. Builder A builder for ResponseContentPartDoneEvent. Part The content part that is done. ResponseContentPartDoneEvent Emitted when a content part is done. Builder A builder for ResponseCreateParams. Builder A builder for Body. Body 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. 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. ResponseCreateParams Creates a model response. Builder A builder for ResponseCreatedEvent. ResponseCreatedEvent An event that is emitted when a response is created. Builder A builder for ResponseDeleteParams. ResponseDeleteParams Deletes a model response with the given ID. Builder A builder for ResponseError. Code The error code for the response. ResponseError An error object returned when the model fails to generate a Response. Builder A builder for ResponseErrorEvent. ResponseErrorEvent Emitted when an error occurs. Builder A builder for ResponseFailedEvent. ResponseFailedEvent An event that is emitted when a response fails. Builder A builder for ResponseFileSearchCallCompletedEvent. ResponseFileSearchCallCompletedEvent Emitted when a file search call is completed (results found). Builder A builder for ResponseFileSearchCallInProgressEvent. ResponseFileSearchCallInProgressEvent Emitted when a file search call is initiated. Builder A builder for ResponseFileSearchCallSearchingEvent. ResponseFileSearchCallSearchingEvent Emitted when a file search is currently searching. Builder A builder for ResponseFileSearchToolCall. Status The status of the file search tool call. 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 ResponseFileSearchToolCall The results of a file search tool call. ResponseFormatTextConfig An object specifying the format that the model must output. Builder A builder for ResponseFormatTextJsonSchemaConfig. Builder A builder for Schema. Schema The schema for the response format, described as a JSON Schema object. ResponseFormatTextJsonSchemaConfig JSON Schema response format. Builder A builder for ResponseFunctionCallArgumentsDeltaEvent. ResponseFunctionCallArgumentsDeltaEvent Emitted when there is a partial function-call arguments delta. Builder A builder for ResponseFunctionCallArgumentsDoneEvent. ResponseFunctionCallArgumentsDoneEvent Emitted when function-call arguments are finalized. Builder A builder for ResponseFunctionToolCall. Status The status of the item. ResponseFunctionToolCall A tool call to run a function. Builder A builder for ResponseFunctionToolCallItem. ResponseFunctionToolCallItem A tool call to run a function. Builder A builder for ResponseFunctionToolCallOutputItem. Status The status of the item. ResponseFunctionToolCallOutputItem Builder A builder for ResponseFunctionWebSearch. Status The status of the web search tool call. ResponseFunctionWebSearch The results of a web search tool call. Builder A builder for ResponseInProgressEvent. ResponseInProgressEvent Emitted when the response is in progress. ResponseIncludable Specify additional output data to include in the model response. Builder A builder for ResponseIncompleteEvent. ResponseIncompleteEvent An event that is emitted when a response finishes as incomplete. Builder A builder for ResponseInputAudio. Format The format of the audio data. ResponseInputAudio An audio input to the model. ResponseInputContent A text input to the model. Builder A builder for ResponseInputFile. ResponseInputFile A file input to the model. Builder A builder for ResponseInputImage. Detail The detail level of the image to be sent to the model. ResponseInputImage An image input to the model. Builder A builder for Message. Role The role of the message input. 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. Status The status of the message input. ComputerCallOutput The output of a computer tool call. Builder A builder for FunctionCallOutput. Status The status of the item. FunctionCallOutput The output of a function tool call. Builder A builder for ItemReference. ItemReference An internal identifier for an item to reference. ResponseInputItem A message input to the model with a role indicating instruction following hierarchy. Builder A builder for ResponseInputMessageItem. Role The role of the message input. Status The status of item. Type The type of the message input. ResponseInputMessageItem Builder A builder for ResponseInputText. ResponseInputText A text input to the model. ResponseItem Content item used to generate a response. Builder A builder for ResponseOutputAudio. ResponseOutputAudio An audio output from the model. ResponseOutputItem An output message from the model. Builder A builder for ResponseOutputItemAddedEvent. ResponseOutputItemAddedEvent Emitted when a new output item is added. Builder A builder for ResponseOutputItemDoneEvent. ResponseOutputItemDoneEvent Emitted when an output item is marked done. Builder A builder for ResponseOutputMessage. Content A text output from the model. Status The status of the message input. ResponseOutputMessage An output message from the model. Builder A builder for ResponseOutputRefusal. ResponseOutputRefusal A refusal from the model. Builder A builder for ResponseOutputText. 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 FilePath. FilePath A path to a file. Annotation A citation to a file. ResponseOutputText A text output from the model. Builder A builder for ResponseReasoningItem. Builder A builder for Summary. Summary Status The status of the item. ResponseReasoningItem A description of the chain of thought used by a reasoning model while generating a response. Builder A builder for ResponseRefusalDeltaEvent. ResponseRefusalDeltaEvent Emitted when there is a partial refusal text. Builder A builder for ResponseRefusalDoneEvent. ResponseRefusalDoneEvent Emitted when refusal text is finalized. Builder A builder for ResponseRetrieveParams. ResponseRetrieveParams Retrieves a model response with the given ID. ResponseStatus The status of the response generation. ResponseStreamEvent Emitted when there is a partial audio response. Builder A builder for ResponseTextAnnotationDeltaEvent. 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 FilePath. FilePath A path to a file. Annotation A citation to a file. ResponseTextAnnotationDeltaEvent Emitted when a text annotation is added. Builder A builder for ResponseTextConfig. ResponseTextConfig Configuration options for a text response from the model. Builder A builder for ResponseTextDeltaEvent. ResponseTextDeltaEvent Emitted when there is an additional text delta. Builder A builder for ResponseTextDoneEvent. ResponseTextDoneEvent Emitted when text content is finalized. Builder A builder for ResponseUsage. 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. ResponseUsage Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Builder A builder for ResponseWebSearchCallCompletedEvent. ResponseWebSearchCallCompletedEvent Emitted when a web search call is completed. Builder A builder for ResponseWebSearchCallInProgressEvent. ResponseWebSearchCallInProgressEvent Emitted when a web search call is initiated. Builder A builder for ResponseWebSearchCallSearchingEvent. ResponseWebSearchCallSearchingEvent Emitted when a web search call is executing. Tool A tool that searches for relevant content from uploaded files. Builder A builder for ToolChoiceFunction. ToolChoiceFunction Use this option to force the model to call a specific function. ToolChoiceOptions Controls which (if any) tool is called by the model. Builder A builder for ToolChoiceTypes. Type The type of hosted tool the model should to use. ToolChoiceTypes Indicates that the model should use a built-in tool to generate a response. Builder A builder for WebSearchTool. Type The type of the web search tool. SearchContextSize High level guidance for the amount of context window space to use for the search. Builder A builder for UserLocation. UserLocation WebSearchTool This tool searches the web for relevant results to use in a response. -
Enum Summary Enum Description 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 Role's known values. Value An enum containing Role'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 Reason's known values. Value An enum containing Reason'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 Button's known values. Value An enum containing Button'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 Truncation's known values. Value An enum containing Truncation'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 ResponseIncludable's known values. Value An enum containing ResponseIncludable'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 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 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 ResponseStatus's known values. Value An enum containing ResponseStatus's known values, as well as an _UNKNOWN member. Known An enum containing ToolChoiceOptions's known values. Value An enum containing ToolChoiceOptions'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 SearchContextSize's known values. Value An enum containing SearchContextSize's known values, as well as an _UNKNOWN member. -
Interface Summary Interface Description 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 ToolChoice to a value of type T. Visitor An interface that defines how to map each variant of Result 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 ResponseContent 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 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 ResponseFormatTextConfig to a value of type T. Visitor An interface that defines how to map each variant of ResponseInputContent to a value of type T. Visitor An interface that defines how to map each variant of ResponseInputItem to a value of type T. Visitor An interface that defines how to map each variant of ResponseItem to a value of type T. Visitor An interface that defines how to map each variant of ResponseOutputItem 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 ResponseStreamEvent 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 Tool to a value of type T.