openai 0.9.0 → 0.11.0

data/rbi/openai/models/responses/response.rbi

@@ -140,6 +140,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
+
         # The unique ID of the previous response to the model. Use this to create
         # multi-turn conversations. Learn more about
         # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
@@ -168,23 +175,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(OpenAI::Responses::Response::ServiceTier::TaggedSymbol)
@@ -213,6 +220,11 @@ module OpenAI
         sig { params(text: OpenAI::Responses::ResponseTextConfig::OrHash).void }
         attr_writer :text
 
+        # 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
+
         # The truncation strategy to use for the model response.
         #
         # - `auto`: If the context of this response and previous ones exceeds the model's
@@ -283,7 +295,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[
@@ -301,6 +314,7 @@ module OpenAI
             top_p: T.nilable(Float),
             background: T.nilable(T::Boolean),
             max_output_tokens: T.nilable(Integer),
+            max_tool_calls: T.nilable(Integer),
             previous_response_id: T.nilable(String),
             prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
             reasoning: T.nilable(OpenAI::Reasoning::OrHash),
@@ -308,6 +322,7 @@ module OpenAI
               T.nilable(OpenAI::Responses::Response::ServiceTier::OrSymbol),
             status: OpenAI::Responses::ResponseStatus::OrSymbol,
             text: OpenAI::Responses::ResponseTextConfig::OrHash,
+            top_logprobs: T.nilable(Integer),
             truncation:
               T.nilable(OpenAI::Responses::Response::Truncation::OrSymbol),
             usage: OpenAI::Responses::ResponseUsage::OrHash,
@@ -390,6 +405,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,
           # The unique ID of the previous response to the model. Use this to create
           # multi-turn conversations. Learn more about
           # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
@@ -402,23 +422,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,
           # The status of the response generation. One of `completed`, `failed`,
           # `in_progress`, `cancelled`, `queued`, or `incomplete`.
@@ -429,6 +449,9 @@ module OpenAI
           # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
           # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
           text: 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,
           # The truncation strategy to use for the model response.
           #
           # - `auto`: If the context of this response and previous ones exceeds the model's
@@ -470,6 +493,7 @@ module OpenAI
               top_p: T.nilable(Float),
               background: T.nilable(T::Boolean),
               max_output_tokens: T.nilable(Integer),
+              max_tool_calls: T.nilable(Integer),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
               reasoning: T.nilable(OpenAI::Reasoning),
@@ -479,6 +503,7 @@ module OpenAI
                 ),
               status: OpenAI::Responses::ResponseStatus::TaggedSymbol,
               text: OpenAI::Responses::ResponseTextConfig,
+              top_logprobs: T.nilable(Integer),
               truncation:
                 T.nilable(
                   OpenAI::Responses::Response::Truncation::TaggedSymbol
@@ -622,7 +647,8 @@ module OpenAI
               T.any(
                 OpenAI::Responses::ToolChoiceOptions::TaggedSymbol,
                 OpenAI::Responses::ToolChoiceTypes,
-                OpenAI::Responses::ToolChoiceFunction
+                OpenAI::Responses::ToolChoiceFunction,
+                OpenAI::Responses::ToolChoiceMcp
               )
             end
 
@@ -635,23 +661,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
 
@@ -675,6 +701,11 @@ module OpenAI
               :scale,
               OpenAI::Responses::Response::ServiceTier::TaggedSymbol
             )
+          PRIORITY =
+            T.let(
+              :priority,
+              OpenAI::Responses::Response::ServiceTier::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/openai/models/responses/response_code_interpreter_call_code_delta_event.rbi

@@ -12,15 +12,20 @@ module OpenAI
             )
           end
 
-        # The partial code snippet added by the code interpreter.
+        # The partial code snippet being streamed by the code interpreter.
         sig { returns(String) }
         attr_accessor :delta
 
-        # The index of the output item that the code interpreter call is in progress.
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item in the response for which the code is being
+        # streamed.
         sig { returns(Integer) }
         attr_accessor :output_index
 
-        # The sequence number of this event.
+        # The sequence number of this event, used to order streaming events.
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
@@ -28,21 +33,25 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # Emitted when a partial code snippet is added by the code interpreter.
+        # Emitted when a partial code snippet is streamed by the code interpreter.
         sig do
           params(
             delta: String,
+            item_id: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
-          # The partial code snippet added by the code interpreter.
+          # The partial code snippet being streamed by the code interpreter.
           delta:,
-          # The index of the output item that the code interpreter call is in progress.
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code is being
+          # streamed.
           output_index:,
-          # The sequence number of this event.
+          # The sequence number of this event, used to order streaming events.
           sequence_number:,
           # The type of the event. Always `response.code_interpreter_call_code.delta`.
           type: :"response.code_interpreter_call_code.delta"
@@ -53,6 +62,7 @@ module OpenAI
           override.returns(
             {
               delta: String,
+              item_id: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol

data/rbi/openai/models/responses/response_code_interpreter_call_code_done_event.rbi

@@ -16,11 +16,15 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :code
 
-        # The index of the output item that the code interpreter call is in progress.
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item in the response for which the code is finalized.
         sig { returns(Integer) }
         attr_accessor :output_index
 
-        # The sequence number of this event.
+        # The sequence number of this event, used to order streaming events.
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
@@ -28,10 +32,11 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # Emitted when code snippet output is finalized by the code interpreter.
+        # Emitted when the code snippet is finalized by the code interpreter.
         sig do
           params(
             code: String,
+            item_id: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
@@ -40,9 +45,11 @@ module OpenAI
         def self.new(
           # The final code snippet output by the code interpreter.
           code:,
-          # The index of the output item that the code interpreter call is in progress.
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code is finalized.
           output_index:,
-          # The sequence number of this event.
+          # The sequence number of this event, used to order streaming events.
           sequence_number:,
           # The type of the event. Always `response.code_interpreter_call_code.done`.
           type: :"response.code_interpreter_call_code.done"
@@ -53,6 +60,7 @@ module OpenAI
           override.returns(
             {
               code: String,
+              item_id: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol

data/rbi/openai/models/responses/response_code_interpreter_call_completed_event.rbi

@@ -12,23 +12,16 @@ module OpenAI
             )
           end
 
-        # A tool call to run code.
-        sig { returns(OpenAI::Responses::ResponseCodeInterpreterToolCall) }
-        attr_reader :code_interpreter_call
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
 
-        sig do
-          params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash
-          ).void
-        end
-        attr_writer :code_interpreter_call
-
-        # The index of the output item that the code interpreter call is in progress.
+        # The index of the output item in the response for which the code interpreter call
+        # is completed.
         sig { returns(Integer) }
         attr_accessor :output_index
 
-        # The sequence number of this event.
+        # The sequence number of this event, used to order streaming events.
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
@@ -39,19 +32,19 @@ module OpenAI
         # Emitted when the code interpreter call is completed.
         sig do
           params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
+            item_id: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
-          # A tool call to run code.
-          code_interpreter_call:,
-          # The index of the output item that the code interpreter call is in progress.
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code interpreter call
+          # is completed.
           output_index:,
-          # The sequence number of this event.
+          # The sequence number of this event, used to order streaming events.
           sequence_number:,
           # The type of the event. Always `response.code_interpreter_call.completed`.
           type: :"response.code_interpreter_call.completed"
@@ -61,8 +54,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              code_interpreter_call:
-                OpenAI::Responses::ResponseCodeInterpreterToolCall,
+              item_id: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol

data/rbi/openai/models/responses/response_code_interpreter_call_in_progress_event.rbi

@@ -12,23 +12,16 @@ module OpenAI
             )
           end
 
-        # A tool call to run code.
-        sig { returns(OpenAI::Responses::ResponseCodeInterpreterToolCall) }
-        attr_reader :code_interpreter_call
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
 
-        sig do
-          params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash
-          ).void
-        end
-        attr_writer :code_interpreter_call
-
-        # The index of the output item that the code interpreter call is in progress.
+        # The index of the output item in the response for which the code interpreter call
+        # is in progress.
         sig { returns(Integer) }
         attr_accessor :output_index
 
-        # The sequence number of this event.
+        # The sequence number of this event, used to order streaming events.
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
@@ -39,19 +32,19 @@ module OpenAI
         # Emitted when a code interpreter call is in progress.
         sig do
           params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
+            item_id: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
-          # A tool call to run code.
-          code_interpreter_call:,
-          # The index of the output item that the code interpreter call is in progress.
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code interpreter call
+          # is in progress.
           output_index:,
-          # The sequence number of this event.
+          # The sequence number of this event, used to order streaming events.
           sequence_number:,
           # The type of the event. Always `response.code_interpreter_call.in_progress`.
           type: :"response.code_interpreter_call.in_progress"
@@ -61,8 +54,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              code_interpreter_call:
-                OpenAI::Responses::ResponseCodeInterpreterToolCall,
+              item_id: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol

data/rbi/openai/models/responses/response_code_interpreter_call_interpreting_event.rbi

@@ -12,23 +12,16 @@ module OpenAI
             )
           end
 
-        # A tool call to run code.
-        sig { returns(OpenAI::Responses::ResponseCodeInterpreterToolCall) }
-        attr_reader :code_interpreter_call
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
 
-        sig do
-          params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash
-          ).void
-        end
-        attr_writer :code_interpreter_call
-
-        # The index of the output item that the code interpreter call is in progress.
+        # The index of the output item in the response for which the code interpreter is
+        # interpreting code.
         sig { returns(Integer) }
         attr_accessor :output_index
 
-        # The sequence number of this event.
+        # The sequence number of this event, used to order streaming events.
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
@@ -39,19 +32,19 @@ module OpenAI
         # Emitted when the code interpreter is actively interpreting the code snippet.
         sig do
           params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
+            item_id: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
-          # A tool call to run code.
-          code_interpreter_call:,
-          # The index of the output item that the code interpreter call is in progress.
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code interpreter is
+          # interpreting code.
           output_index:,
-          # The sequence number of this event.
+          # The sequence number of this event, used to order streaming events.
           sequence_number:,
           # The type of the event. Always `response.code_interpreter_call.interpreting`.
           type: :"response.code_interpreter_call.interpreting"
@@ -61,8 +54,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              code_interpreter_call:
-                OpenAI::Responses::ResponseCodeInterpreterToolCall,
+              item_id: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol