openai 0.9.0 → 0.11.0

data/lib/openai/models/responses/response_create_params.rb

@@ -10,30 +10,6 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
-        # @!attribute input
-        #   Text, image, or file inputs to the model, used to generate a response.
-        #
-        #   Learn more:
-        #
-        #   - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        #   - [Image inputs](https://platform.openai.com/docs/guides/images)
-        #   - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
-        #   - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
-        #   - [Function calling](https://platform.openai.com/docs/guides/function-calling)
-        #
-        #   @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>]
-        required :input, union: -> { OpenAI::Responses::ResponseCreateParams::Input }
-
-        # @!attribute model
-        #   Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
-        #   wide range of models with different capabilities, performance characteristics,
-        #   and price points. Refer to the
-        #   [model guide](https://platform.openai.com/docs/models) to browse and compare
-        #   available models.
-        #
-        #   @return [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel]
-        required :model, union: -> { OpenAI::ResponsesModel }
-
         # @!attribute background
         #   Whether to run the model response in the background.
         #   [Learn more](https://platform.openai.com/docs/guides/background).
@@ -45,24 +21,39 @@ module OpenAI
         #   Specify additional output data to include in the model response. Currently
         #   supported values are:
         #
+        #   - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+        #     in code interpreter tool call items.
+        #   - `computer_call_output.output.image_url`: Include image urls from the computer
+        #     call output.
         #   - `file_search_call.results`: Include the search results of the file search tool
         #     call.
         #   - `message.input_image.image_url`: Include image urls from the input message.
-        #   - `computer_call_output.output.image_url`: Include image urls from the computer
-        #     call output.
+        #   - `message.output_text.logprobs`: Include logprobs with assistant messages.
         #   - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
         #     tokens in reasoning item outputs. This enables reasoning items to be used in
         #     multi-turn conversations when using the Responses API statelessly (like when
         #     the `store` parameter is set to `false`, or when an organization is enrolled
         #     in the zero data retention program).
-        #   - `code_interpreter_call.outputs`: Includes the outputs of python code execution
-        #     in code interpreter tool call items.
         #
         #   @return [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
         optional :include,
                  -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Responses::ResponseIncludable] },
                  nil?: true
 
+        # @!attribute input
+        #   Text, image, or file inputs to the model, used to generate a response.
+        #
+        #   Learn more:
+        #
+        #   - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+        #   - [Image inputs](https://platform.openai.com/docs/guides/images)
+        #   - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
+        #   - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
+        #   - [Function calling](https://platform.openai.com/docs/guides/function-calling)
+        #
+        #   @return [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil]
+        optional :input, union: -> { OpenAI::Responses::ResponseCreateParams::Input }
+
         # @!attribute instructions
         #   A system (or developer) message inserted into the model's context.
         #
@@ -81,6 +72,15 @@ module OpenAI
         #   @return [Integer, nil]
         optional :max_output_tokens, Integer, nil?: true
 
+        # @!attribute max_tool_calls
+        #   The maximum number of total calls to built-in tools that can be processed in a
+        #   response. This maximum number applies across all built-in tool calls, not per
+        #   individual tool. Any further attempts to call a tool by the model will be
+        #   ignored.
+        #
+        #   @return [Integer, nil]
+        optional :max_tool_calls, Integer, nil?: true
+
         # @!attribute metadata
         #   Set of 16 key-value pairs that can be attached to an object. This can be useful
         #   for storing additional information about the object in a structured format, and
@@ -92,6 +92,16 @@ module OpenAI
         #   @return [Hash{Symbol=>String}, nil]
         optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
 
+        # @!attribute model
+        #   Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
+        #   wide range of models with different capabilities, performance characteristics,
+        #   and price points. Refer to the
+        #   [model guide](https://platform.openai.com/docs/models) to browse and compare
+        #   available models.
+        #
+        #   @return [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel, nil]
+        optional :model, union: -> { OpenAI::ResponsesModel }
+
         # @!attribute parallel_tool_calls
         #   Whether to allow the model to run tool calls in parallel.
         #
@@ -123,23 +133,23 @@ module OpenAI
         optional :reasoning, -> { OpenAI::Reasoning }, nil?: true
 
         # @!attribute service_tier
-        #   Specifies the latency tier to use for processing the request. This parameter is
-        #   relevant for customers subscribed to the scale tier service:
-        #
-        #   - If set to 'auto', and the Project is Scale tier enabled, the system will
-        #     utilize scale tier credits until they are exhausted.
-        #   - If set to 'auto', and the Project is not Scale tier enabled, the request will
-        #     be processed using the default service tier with a lower uptime SLA and no
-        #     latency guarantee.
-        #   - If set to 'default', the request will be processed using the default service
-        #     tier with a lower uptime SLA and no latency guarantee.
-        #   - If set to 'flex', the request will be processed with the Flex Processing
-        #     service tier.
-        #     [Learn more](https://platform.openai.com/docs/guides/flex-processing).
+        #   Specifies the processing type used for serving the request.
+        #
+        #   - If set to 'auto', then the request will be processed with the service tier
+        #     configured in the Project settings. Unless otherwise configured, the Project
+        #     will use 'default'.
+        #   - If set to 'default', then the requset will be processed with the standard
+        #     pricing and performance for the selected model.
+        #   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
+        #     'priority', then the request will be processed with the corresponding service
+        #     tier. [Contact sales](https://openai.com/contact-sales) to learn more about
+        #     Priority processing.
         #   - When not set, the default behavior is 'auto'.
         #
-        #   When this parameter is set, the response body will include the `service_tier`
-        #   utilized.
+        #   When the `service_tier` parameter is set, the response body will include the
+        #   `service_tier` value based on the processing mode actually used to serve the
+        #   request. This response value may be different from the value set in the
+        #   parameter.
         #
         #   @return [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil]
         optional :service_tier, enum: -> { OpenAI::Responses::ResponseCreateParams::ServiceTier }, nil?: true
@@ -180,7 +190,7 @@ module OpenAI
         #   response. See the `tools` parameter to see how to specify which tools the model
         #   can call.
         #
-        #   @return [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, nil]
+        #   @return [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, nil]
         optional :tool_choice, union: -> { OpenAI::Responses::ResponseCreateParams::ToolChoice }
 
         # @!attribute tools
@@ -202,6 +212,13 @@ module OpenAI
         #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>, nil]
         optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
+        # @!attribute top_logprobs
+        #   An integer between 0 and 20 specifying the number of most likely tokens to
+        #   return at each token position, each with an associated log probability.
+        #
+        #   @return [Integer, nil]
+        optional :top_logprobs, Integer, nil?: true
+
         # @!attribute top_p
         #   An alternative to sampling with temperature, called nucleus sampling, where the
         #   model considers the results of the tokens with top_p probability mass. So 0.1
@@ -232,24 +249,26 @@ module OpenAI
         #   @return [String, nil]
         optional :user, String
 
-        # @!method initialize(input:, model:, background: nil, include: nil, instructions: nil, max_output_tokens: nil, metadata: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
+        # @!method initialize(background: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, store: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseCreateParams} for more details.
         #
-        #   @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
-        #
-        #   @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
-        #
         #   @param background [Boolean, nil] Whether to run the model response in the background.
         #
         #   @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently
         #
+        #   @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
+        #
         #   @param instructions [String, nil] A system (or developer) message inserted into the model's context.
         #
         #   @param max_output_tokens [Integer, nil] An upper bound for the number of tokens that can be generated for a response, in
         #
+        #   @param max_tool_calls [Integer, nil] The maximum number of total calls to built-in tools that can be processed in a r
+        #
         #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
         #
+        #   @param model [String, Symbol, OpenAI::Models::ChatModel, OpenAI::Models::ResponsesModel::ResponsesOnlyModel] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI
+        #
         #   @param parallel_tool_calls [Boolean, nil] Whether to allow the model to run tool calls in parallel.
         #
         #   @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to
@@ -258,7 +277,7 @@ module OpenAI
         #
         #   @param reasoning [OpenAI::Models::Reasoning, nil] **o-series models only**
         #
-        #   @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the latency tier to use for processing the request. This parameter is
+        #   @param service_tier [Symbol, OpenAI::Models::Responses::ResponseCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
         #
         #   @param store [Boolean, nil] Whether to store the generated model response for later retrieval via
         #
@@ -266,10 +285,12 @@ module OpenAI
         #
         #   @param text [OpenAI::Models::Responses::ResponseTextConfig] Configuration options for a text response from the model. Can be plain
         #
-        #   @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction] How the model should select which tool (or tools) to use when generating
+        #   @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp] How the model should select which tool (or tools) to use when generating
         #
         #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
         #
+        #   @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
+        #
         #   @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
         #
         #   @param truncation [Symbol, OpenAI::Models::Responses::ResponseCreateParams::Truncation, nil] The truncation strategy to use for the model response.
@@ -302,23 +323,23 @@ module OpenAI
           #   @return [Array(String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>)]
         end
 
-        # Specifies the latency tier to use for processing the request. This parameter is
-        # relevant for customers subscribed to the scale tier service:
-        #
-        # - If set to 'auto', and the Project is Scale tier enabled, the system will
-        #   utilize scale tier credits until they are exhausted.
-        # - If set to 'auto', and the Project is not Scale tier enabled, the request will
-        #   be processed using the default service tier with a lower uptime SLA and no
-        #   latency guarantee.
-        # - If set to 'default', the request will be processed using the default service
-        #   tier with a lower uptime SLA and no latency guarantee.
-        # - If set to 'flex', the request will be processed with the Flex Processing
-        #   service tier.
-        #   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
+        # Specifies the processing type used for serving the request.
+        #
+        # - If set to 'auto', then the request will be processed with the service tier
+        #   configured in the Project settings. Unless otherwise configured, the Project
+        #   will use 'default'.
+        # - If set to 'default', then the requset will be processed with the standard
+        #   pricing and performance for the selected model.
+        # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
+        #   'priority', then the request will be processed with the corresponding service
+        #   tier. [Contact sales](https://openai.com/contact-sales) to learn more about
+        #   Priority processing.
         # - When not set, the default behavior is 'auto'.
         #
-        # When this parameter is set, the response body will include the `service_tier`
-        # utilized.
+        # When the `service_tier` parameter is set, the response body will include the
+        # `service_tier` value based on the processing mode actually used to serve the
+        # request. This response value may be different from the value set in the
+        # parameter.
         module ServiceTier
           extend OpenAI::Internal::Type::Enum
 
@@ -326,6 +347,7 @@ module OpenAI
           DEFAULT = :default
           FLEX = :flex
           SCALE = :scale
+          PRIORITY = :priority
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -354,8 +376,11 @@ module OpenAI
           # Use this option to force the model to call a specific function.
           variant -> { OpenAI::Responses::ToolChoiceFunction }
 
+          # Use this option to force the model to call a specific tool on a remote MCP server.
+          variant -> { OpenAI::Responses::ToolChoiceMcp }
+
           # @!method self.variants
-          #   @return [Array(Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction)]
+          #   @return [Array(Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp)]
         end
 
         # The truncation strategy to use for the model response.

data/lib/openai/models/responses/response_function_web_search.rb

@@ -10,6 +10,13 @@ module OpenAI
         #   @return [String]
         required :id, String
 
+        # @!attribute action
+        #   An object describing the specific action taken in this web search call. Includes
+        #   details on how the model used the web (search, open_page, find).
+        #
+        #   @return [OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search, OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::OpenPage, OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Find]
+        required :action, union: -> { OpenAI::Responses::ResponseFunctionWebSearch::Action }
+
         # @!attribute status
         #   The status of the web search tool call.
         #
@@ -22,7 +29,7 @@ module OpenAI
         #   @return [Symbol, :web_search_call]
         required :type, const: :web_search_call
 
-        # @!method initialize(id:, status:, type: :web_search_call)
+        # @!method initialize(id:, action:, status:, type: :web_search_call)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseFunctionWebSearch} for more details.
         #
@@ -32,10 +39,117 @@ module OpenAI
         #
         #   @param id [String] The unique ID of the web search tool call.
         #
+        #   @param action [OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search, OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::OpenPage, OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Find] An object describing the specific action taken in this web search call.
+        #
         #   @param status [Symbol, OpenAI::Models::Responses::ResponseFunctionWebSearch::Status] The status of the web search tool call.
         #
         #   @param type [Symbol, :web_search_call] The type of the web search tool call. Always `web_search_call`.
 
+        # An object describing the specific action taken in this web search call. Includes
+        # details on how the model used the web (search, open_page, find).
+        #
+        # @see OpenAI::Models::Responses::ResponseFunctionWebSearch#action
+        module Action
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # Action type "search" - Performs a web search query.
+          variant :search, -> { OpenAI::Responses::ResponseFunctionWebSearch::Action::Search }
+
+          # Action type "open_page" - Opens a specific URL from search results.
+          variant :open_page, -> { OpenAI::Responses::ResponseFunctionWebSearch::Action::OpenPage }
+
+          # Action type "find": Searches for a pattern within a loaded page.
+          variant :find, -> { OpenAI::Responses::ResponseFunctionWebSearch::Action::Find }
+
+          class Search < OpenAI::Internal::Type::BaseModel
+            # @!attribute query
+            #   The search query.
+            #
+            #   @return [String]
+            required :query, String
+
+            # @!attribute type
+            #   The action type.
+            #
+            #   @return [Symbol, :search]
+            required :type, const: :search
+
+            # @!method initialize(query:, type: :search)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search} for more
+            #   details.
+            #
+            #   Action type "search" - Performs a web search query.
+            #
+            #   @param query [String] The search query.
+            #
+            #   @param type [Symbol, :search] The action type.
+          end
+
+          class OpenPage < OpenAI::Internal::Type::BaseModel
+            # @!attribute type
+            #   The action type.
+            #
+            #   @return [Symbol, :open_page]
+            required :type, const: :open_page
+
+            # @!attribute url
+            #   The URL opened by the model.
+            #
+            #   @return [String]
+            required :url, String
+
+            # @!method initialize(url:, type: :open_page)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::OpenPage} for
+            #   more details.
+            #
+            #   Action type "open_page" - Opens a specific URL from search results.
+            #
+            #   @param url [String] The URL opened by the model.
+            #
+            #   @param type [Symbol, :open_page] The action type.
+          end
+
+          class Find < OpenAI::Internal::Type::BaseModel
+            # @!attribute pattern
+            #   The pattern or text to search for within the page.
+            #
+            #   @return [String]
+            required :pattern, String
+
+            # @!attribute type
+            #   The action type.
+            #
+            #   @return [Symbol, :find]
+            required :type, const: :find
+
+            # @!attribute url
+            #   The URL of the page searched for the pattern.
+            #
+            #   @return [String]
+            required :url, String
+
+            # @!method initialize(pattern:, url:, type: :find)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Find} for more
+            #   details.
+            #
+            #   Action type "find": Searches for a pattern within a loaded page.
+            #
+            #   @param pattern [String] The pattern or text to search for within the page.
+            #
+            #   @param url [String] The URL of the page searched for the pattern.
+            #
+            #   @param type [Symbol, :find] The action type.
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search, OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::OpenPage, OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Find)]
+        end
+
         # The status of the web search tool call.
         #
         # @see OpenAI::Models::Responses::ResponseFunctionWebSearch#status

data/lib/openai/models/responses/response_includable.rb

@@ -6,26 +6,28 @@ module OpenAI
       # Specify additional output data to include in the model response. Currently
       # supported values are:
       #
+      # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+      #   in code interpreter tool call items.
+      # - `computer_call_output.output.image_url`: Include image urls from the computer
+      #   call output.
       # - `file_search_call.results`: Include the search results of the file search tool
       #   call.
       # - `message.input_image.image_url`: Include image urls from the input message.
-      # - `computer_call_output.output.image_url`: Include image urls from the computer
-      #   call output.
+      # - `message.output_text.logprobs`: Include logprobs with assistant messages.
       # - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
       #   tokens in reasoning item outputs. This enables reasoning items to be used in
       #   multi-turn conversations when using the Responses API statelessly (like when
       #   the `store` parameter is set to `false`, or when an organization is enrolled
       #   in the zero data retention program).
-      # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
-      #   in code interpreter tool call items.
       module ResponseIncludable
         extend OpenAI::Internal::Type::Enum
 
+        CODE_INTERPRETER_CALL_OUTPUTS = :"code_interpreter_call.outputs"
+        COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL = :"computer_call_output.output.image_url"
         FILE_SEARCH_CALL_RESULTS = :"file_search_call.results"
         MESSAGE_INPUT_IMAGE_IMAGE_URL = :"message.input_image.image_url"
-        COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL = :"computer_call_output.output.image_url"
+        MESSAGE_OUTPUT_TEXT_LOGPROBS = :"message.output_text.logprobs"
         REASONING_ENCRYPTED_CONTENT = :"reasoning.encrypted_content"
-        CODE_INTERPRETER_CALL_OUTPUTS = :"code_interpreter_call.outputs"
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/openai/models/responses/response_output_text.rb

@@ -76,6 +76,12 @@ module OpenAI
             #   @return [String]
             required :file_id, String
 
+            # @!attribute filename
+            #   The filename of the file cited.
+            #
+            #   @return [String]
+            required :filename, String
+
             # @!attribute index
             #   The index of the file in the list of files.
             #
@@ -88,11 +94,13 @@ module OpenAI
             #   @return [Symbol, :file_citation]
             required :type, const: :file_citation
 
-            # @!method initialize(file_id:, index:, type: :file_citation)
+            # @!method initialize(file_id:, filename:, index:, type: :file_citation)
             #   A citation to a file.
             #
             #   @param file_id [String] The ID of the file.
             #
+            #   @param filename [String] The filename of the file cited.
+            #
             #   @param index [Integer] The index of the file in the list of files.
             #
             #   @param type [Symbol, :file_citation] The type of the file citation. Always `file_citation`.
@@ -162,6 +170,12 @@ module OpenAI
             #   @return [String]
             required :file_id, String
 
+            # @!attribute filename
+            #   The filename of the container file cited.
+            #
+            #   @return [String]
+            required :filename, String
+
             # @!attribute start_index
             #   The index of the first character of the container file citation in the message.
             #
@@ -174,7 +188,7 @@ module OpenAI
             #   @return [Symbol, :container_file_citation]
             required :type, const: :container_file_citation
 
-            # @!method initialize(container_id:, end_index:, file_id:, start_index:, type: :container_file_citation)
+            # @!method initialize(container_id:, end_index:, file_id:, filename:, start_index:, type: :container_file_citation)
             #   A citation for a container file used to generate a model response.
             #
             #   @param container_id [String] The ID of the container file.
@@ -183,6 +197,8 @@ module OpenAI
             #
             #   @param file_id [String] The ID of the file.
             #
+            #   @param filename [String] The filename of the container file cited.
+            #
             #   @param start_index [Integer] The index of the first character of the container file citation in the message.
             #
             #   @param type [Symbol, :container_file_citation] The type of the container file citation. Always `container_file_citation`.

data/lib/openai/models/responses/response_stream_event.rb

@@ -24,11 +24,11 @@ module OpenAI
         # Emitted when the full audio transcript is completed.
         variant :"response.audio.transcript.done", -> { OpenAI::Responses::ResponseAudioTranscriptDoneEvent }
 
-        # Emitted when a partial code snippet is added by the code interpreter.
+        # Emitted when a partial code snippet is streamed by the code interpreter.
         variant :"response.code_interpreter_call_code.delta",
                 -> { OpenAI::Responses::ResponseCodeInterpreterCallCodeDeltaEvent }
 
-        # Emitted when code snippet output is finalized by the code interpreter.
+        # Emitted when the code snippet is finalized by the code interpreter.
         variant :"response.code_interpreter_call_code.done",
                 -> { OpenAI::Responses::ResponseCodeInterpreterCallCodeDoneEvent }
 

data/lib/openai/models/responses/tool_choice_mcp.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ToolChoiceMcp < OpenAI::Internal::Type::BaseModel
+        # @!attribute server_label
+        #   The label of the MCP server to use.
+        #
+        #   @return [String]
+        required :server_label, String
+
+        # @!attribute type
+        #   For MCP tools, the type is always `mcp`.
+        #
+        #   @return [Symbol, :mcp]
+        required :type, const: :mcp
+
+        # @!attribute name
+        #   The name of the tool to call on the server.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(server_label:, name: nil, type: :mcp)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::ToolChoiceMcp} for more details.
+        #
+        #   Use this option to force the model to call a specific tool on a remote MCP
+        #   server.
+        #
+        #   @param server_label [String] The label of the MCP server to use.
+        #
+        #   @param name [String, nil] The name of the tool to call on the server.
+        #
+        #   @param type [Symbol, :mcp] For MCP tools, the type is always `mcp`.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/tool_choice_types.rb

@@ -14,7 +14,6 @@ module OpenAI
         #   - `web_search_preview`
         #   - `computer_use_preview`
         #   - `code_interpreter`
-        #   - `mcp`
         #   - `image_generation`
         #
         #   @return [Symbol, OpenAI::Models::Responses::ToolChoiceTypes::Type]
@@ -38,7 +37,6 @@ module OpenAI
         # - `web_search_preview`
         # - `computer_use_preview`
         # - `code_interpreter`
-        # - `mcp`
         # - `image_generation`
         #
         # @see OpenAI::Models::Responses::ToolChoiceTypes#type
@@ -51,7 +49,6 @@ module OpenAI
           WEB_SEARCH_PREVIEW_2025_03_11 = :web_search_preview_2025_03_11
           IMAGE_GENERATION = :image_generation
           CODE_INTERPRETER = :code_interpreter
-          MCP = :mcp
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/openai/models/responses_model.rb

@@ -18,6 +18,10 @@ module OpenAI
         O1_PRO_2025_03_19 = :"o1-pro-2025-03-19"
         O3_PRO = :"o3-pro"
         O3_PRO_2025_06_10 = :"o3-pro-2025-06-10"
+        O3_DEEP_RESEARCH = :"o3-deep-research"
+        O3_DEEP_RESEARCH_2025_06_26 = :"o3-deep-research-2025-06-26"
+        O4_MINI_DEEP_RESEARCH = :"o4-mini-deep-research"
+        O4_MINI_DEEP_RESEARCH_2025_06_26 = :"o4-mini-deep-research-2025-06-26"
         COMPUTER_USE_PREVIEW = :"computer-use-preview"
         COMPUTER_USE_PREVIEW_2025_03_11 = :"computer-use-preview-2025-03-11"