openai 0.9.0 → 0.11.0

data/rbi/openai/models/responses/response_create_params.rbi

@@ -15,36 +15,6 @@ module OpenAI
             )
           end
 
-        # 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)
-        sig do
-          returns(OpenAI::Responses::ResponseCreateParams::Input::Variants)
-        end
-        attr_accessor :input
-
-        # 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.
-        sig do
-          returns(
-            T.any(
-              String,
-              OpenAI::ChatModel::OrSymbol,
-              OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
-            )
-          )
-        end
-        attr_accessor :model
-
         # Whether to run the model response in the background.
         # [Learn more](https://platform.openai.com/docs/guides/background).
         sig { returns(T.nilable(T::Boolean)) }
@@ -53,18 +23,19 @@ 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.
         sig do
           returns(
             T.nilable(T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol])
@@ -72,6 +43,29 @@ module OpenAI
         end
         attr_accessor :include
 
+        # 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)
+        sig do
+          returns(
+            T.nilable(OpenAI::Responses::ResponseCreateParams::Input::Variants)
+          )
+        end
+        attr_reader :input
+
+        sig do
+          params(
+            input: OpenAI::Responses::ResponseCreateParams::Input::Variants
+          ).void
+        end
+        attr_writer :input
+
         # A system (or developer) message inserted into the model's context.
         #
         # When using along with `previous_response_id`, the instructions from a previous
@@ -86,6 +80,13 @@ module OpenAI
         sig { returns(T.nilable(Integer)) }
         attr_accessor :max_output_tokens
 
+        # 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.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :max_tool_calls
+
         # 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
         # querying for objects via API or the dashboard.
@@ -95,6 +96,36 @@ module OpenAI
         sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_accessor :metadata
 
+        # 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.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                String,
+                OpenAI::ChatModel::OrSymbol,
+                OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+              )
+            )
+          )
+        end
+        attr_reader :model
+
+        sig do
+          params(
+            model:
+              T.any(
+                String,
+                OpenAI::ChatModel::OrSymbol,
+                OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+              )
+          ).void
+        end
+        attr_writer :model
+
         # Whether to allow the model to run tool calls in parallel.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :parallel_tool_calls
@@ -127,23 +158,23 @@ module OpenAI
         sig { params(reasoning: T.nilable(OpenAI::Reasoning::OrHash)).void }
         attr_writer :reasoning
 
-        # Specifies the latency tier to use for processing the request. This parameter is
-        # relevant for customers subscribed to the scale tier service:
+        # Specifies the processing type used for serving the request.
         #
-        # - 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).
+        # - 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.
         sig do
           returns(
             T.nilable(
@@ -192,7 +223,8 @@ module OpenAI
               T.any(
                 OpenAI::Responses::ToolChoiceOptions::OrSymbol,
                 OpenAI::Responses::ToolChoiceTypes,
-                OpenAI::Responses::ToolChoiceFunction
+                OpenAI::Responses::ToolChoiceFunction,
+                OpenAI::Responses::ToolChoiceMcp
               )
             )
           )
@@ -205,7 +237,8 @@ module OpenAI
               T.any(
                 OpenAI::Responses::ToolChoiceOptions::OrSymbol,
                 OpenAI::Responses::ToolChoiceTypes::OrHash,
-                OpenAI::Responses::ToolChoiceFunction::OrHash
+                OpenAI::Responses::ToolChoiceFunction::OrHash,
+                OpenAI::Responses::ToolChoiceMcp::OrHash
               )
           ).void
         end
@@ -264,6 +297,11 @@ module OpenAI
         end
         attr_writer :tools
 
+        # 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.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :top_logprobs
+
         # 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
         # means only the tokens comprising the top 10% probability mass are considered.
@@ -299,21 +337,22 @@ module OpenAI
 
         sig do
           params(
-            input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
-            model:
-              T.any(
-                String,
-                OpenAI::ChatModel::OrSymbol,
-                OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
-              ),
             background: T.nilable(T::Boolean),
             include:
               T.nilable(
                 T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
               ),
+            input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
             instructions: T.nilable(String),
             max_output_tokens: T.nilable(Integer),
+            max_tool_calls: T.nilable(Integer),
             metadata: T.nilable(T::Hash[Symbol, String]),
+            model:
+              T.any(
+                String,
+                OpenAI::ChatModel::OrSymbol,
+                OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+              ),
             parallel_tool_calls: T.nilable(T::Boolean),
             previous_response_id: T.nilable(String),
             prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
@@ -329,7 +368,8 @@ module OpenAI
               T.any(
                 OpenAI::Responses::ToolChoiceOptions::OrSymbol,
                 OpenAI::Responses::ToolChoiceTypes::OrHash,
-                OpenAI::Responses::ToolChoiceFunction::OrHash
+                OpenAI::Responses::ToolChoiceFunction::OrHash,
+                OpenAI::Responses::ToolChoiceMcp::OrHash
               ),
             tools:
               T::Array[
@@ -344,6 +384,7 @@ module OpenAI
                   OpenAI::Responses::WebSearchTool::OrHash
                 )
               ],
+            top_logprobs: T.nilable(Integer),
             top_p: T.nilable(Float),
             truncation:
               T.nilable(
@@ -354,41 +395,36 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
-          # 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)
-          input:,
-          # 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.
-          model:,
           # Whether to run the model response in the background.
           # [Learn more](https://platform.openai.com/docs/guides/background).
           background: nil,
           # 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.
           include: nil,
+          # 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)
+          input: nil,
           # A system (or developer) message inserted into the model's context.
           #
           # When using along with `previous_response_id`, the instructions from a previous
@@ -399,6 +435,11 @@ module OpenAI
           # including visible output tokens and
           # [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
           max_output_tokens: nil,
+          # 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.
+          max_tool_calls: nil,
           # 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
           # querying for objects via API or the dashboard.
@@ -406,6 +447,12 @@ module OpenAI
           # Keys are strings with a maximum length of 64 characters. Values are strings with
           # a maximum length of 512 characters.
           metadata: nil,
+          # 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.
+          model: nil,
           # Whether to allow the model to run tool calls in parallel.
           parallel_tool_calls: nil,
           # The unique ID of the previous response to the model. Use this to create
@@ -420,23 +467,23 @@ module OpenAI
           # Configuration options for
           # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
           reasoning: nil,
-          # Specifies the latency tier to use for processing the request. This parameter is
-          # relevant for customers subscribed to the scale tier service:
+          # Specifies the processing type used for serving the request.
           #
-          # - 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).
+          # - 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.
           service_tier: nil,
           # Whether to store the generated model response for later retrieval via API.
           store: nil,
@@ -470,6 +517,9 @@ module OpenAI
           #   the model to call your own code. Learn more about
           #   [function calling](https://platform.openai.com/docs/guides/function-calling).
           tools: nil,
+          # 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.
+          top_logprobs: nil,
           # 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
           # means only the tokens comprising the top 10% probability mass are considered.
@@ -495,21 +545,22 @@ module OpenAI
         sig do
           override.returns(
             {
-              input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
-              model:
-                T.any(
-                  String,
-                  OpenAI::ChatModel::OrSymbol,
-                  OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
-                ),
               background: T.nilable(T::Boolean),
               include:
                 T.nilable(
                   T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
                 ),
+              input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
               instructions: T.nilable(String),
               max_output_tokens: T.nilable(Integer),
+              max_tool_calls: T.nilable(Integer),
               metadata: T.nilable(T::Hash[Symbol, String]),
+              model:
+                T.any(
+                  String,
+                  OpenAI::ChatModel::OrSymbol,
+                  OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+                ),
               parallel_tool_calls: T.nilable(T::Boolean),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
@@ -525,7 +576,8 @@ module OpenAI
                 T.any(
                   OpenAI::Responses::ToolChoiceOptions::OrSymbol,
                   OpenAI::Responses::ToolChoiceTypes,
-                  OpenAI::Responses::ToolChoiceFunction
+                  OpenAI::Responses::ToolChoiceFunction,
+                  OpenAI::Responses::ToolChoiceMcp
                 ),
               tools:
                 T::Array[
@@ -540,6 +592,7 @@ module OpenAI
                     OpenAI::Responses::WebSearchTool
                   )
                 ],
+              top_logprobs: T.nilable(Integer),
               top_p: T.nilable(Float),
               truncation:
                 T.nilable(
@@ -582,23 +635,23 @@ module OpenAI
           end
         end
 
-        # Specifies the latency tier to use for processing the request. This parameter is
-        # relevant for customers subscribed to the scale tier service:
+        # Specifies the processing type used for serving the request.
         #
-        # - 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).
+        # - 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
 
@@ -631,6 +684,11 @@ module OpenAI
               :scale,
               OpenAI::Responses::ResponseCreateParams::ServiceTier::TaggedSymbol
             )
+          PRIORITY =
+            T.let(
+              :priority,
+              OpenAI::Responses::ResponseCreateParams::ServiceTier::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -654,7 +712,8 @@ module OpenAI
               T.any(
                 OpenAI::Responses::ToolChoiceOptions::TaggedSymbol,
                 OpenAI::Responses::ToolChoiceTypes,
-                OpenAI::Responses::ToolChoiceFunction
+                OpenAI::Responses::ToolChoiceFunction,
+                OpenAI::Responses::ToolChoiceMcp
               )
             end