openai 0.10.0 → 0.11.0

data/rbi/openai/models/chat/completion_create_params.rbi

@@ -270,23 +270,23 @@ module OpenAI
         sig { returns(T.nilable(Integer)) }
         attr_accessor :seed
 
-        # 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(
@@ -310,6 +310,8 @@ module OpenAI
         # Whether or not to store the output of this chat completion request for use in
         # our [model distillation](https://platform.openai.com/docs/guides/distillation)
         # or [evals](https://platform.openai.com/docs/guides/evals) products.
+        #
+        # Supports text and image inputs. Note: image inputs over 10MB will be dropped.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :store
 
@@ -625,23 +627,23 @@ module OpenAI
           # should refer to the `system_fingerprint` response parameter to monitor changes
           # in the backend.
           seed: 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,
           # Not supported with latest reasoning models `o3` and `o4-mini`.
           #
@@ -651,6 +653,8 @@ module OpenAI
           # Whether or not to store the output of this chat completion request for use in
           # our [model distillation](https://platform.openai.com/docs/guides/distillation)
           # or [evals](https://platform.openai.com/docs/guides/evals) products.
+          #
+          # Supports text and image inputs. Note: image inputs over 10MB will be dropped.
           store: nil,
           # Options for streaming response. Only set this when you set `stream: true`.
           stream_options: nil,
@@ -1008,23 +1012,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
 
@@ -1054,6 +1058,11 @@ module OpenAI
               :scale,
               OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
             )
+          PRIORITY =
+            T.let(
+              :priority,
+              OpenAI::Chat::CompletionCreateParams::ServiceTier::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/openai/models/images_response.rbi

@@ -12,6 +12,18 @@ module OpenAI
       sig { returns(Integer) }
       attr_accessor :created
 
+      # The background parameter used for the image generation. Either `transparent` or
+      # `opaque`.
+      sig do
+        returns(T.nilable(OpenAI::ImagesResponse::Background::TaggedSymbol))
+      end
+      attr_reader :background
+
+      sig do
+        params(background: OpenAI::ImagesResponse::Background::OrSymbol).void
+      end
+      attr_writer :background
+
       # The list of generated images.
       sig { returns(T.nilable(T::Array[OpenAI::Image])) }
       attr_reader :data
@@ -19,6 +31,34 @@ module OpenAI
       sig { params(data: T::Array[OpenAI::Image::OrHash]).void }
       attr_writer :data
 
+      # The output format of the image generation. Either `png`, `webp`, or `jpeg`.
+      sig do
+        returns(T.nilable(OpenAI::ImagesResponse::OutputFormat::TaggedSymbol))
+      end
+      attr_reader :output_format
+
+      sig do
+        params(
+          output_format: OpenAI::ImagesResponse::OutputFormat::OrSymbol
+        ).void
+      end
+      attr_writer :output_format
+
+      # The quality of the image generated. Either `low`, `medium`, or `high`.
+      sig { returns(T.nilable(OpenAI::ImagesResponse::Quality::TaggedSymbol)) }
+      attr_reader :quality
+
+      sig { params(quality: OpenAI::ImagesResponse::Quality::OrSymbol).void }
+      attr_writer :quality
+
+      # The size of the image generated. Either `1024x1024`, `1024x1536`, or
+      # `1536x1024`.
+      sig { returns(T.nilable(OpenAI::ImagesResponse::Size::TaggedSymbol)) }
+      attr_reader :size
+
+      sig { params(size: OpenAI::ImagesResponse::Size::OrSymbol).void }
+      attr_writer :size
+
       # For `gpt-image-1` only, the token usage information for the image generation.
       sig { returns(T.nilable(OpenAI::ImagesResponse::Usage)) }
       attr_reader :usage
@@ -30,15 +70,29 @@ module OpenAI
       sig do
         params(
           created: Integer,
+          background: OpenAI::ImagesResponse::Background::OrSymbol,
           data: T::Array[OpenAI::Image::OrHash],
+          output_format: OpenAI::ImagesResponse::OutputFormat::OrSymbol,
+          quality: OpenAI::ImagesResponse::Quality::OrSymbol,
+          size: OpenAI::ImagesResponse::Size::OrSymbol,
           usage: OpenAI::ImagesResponse::Usage::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # The Unix timestamp (in seconds) of when the image was created.
         created:,
+        # The background parameter used for the image generation. Either `transparent` or
+        # `opaque`.
+        background: nil,
         # The list of generated images.
         data: nil,
+        # The output format of the image generation. Either `png`, `webp`, or `jpeg`.
+        output_format: nil,
+        # The quality of the image generated. Either `low`, `medium`, or `high`.
+        quality: nil,
+        # The size of the image generated. Either `1024x1024`, `1024x1536`, or
+        # `1536x1024`.
+        size: nil,
         # For `gpt-image-1` only, the token usage information for the image generation.
         usage: nil
       )
@@ -48,7 +102,11 @@ module OpenAI
         override.returns(
           {
             created: Integer,
+            background: OpenAI::ImagesResponse::Background::TaggedSymbol,
             data: T::Array[OpenAI::Image],
+            output_format: OpenAI::ImagesResponse::OutputFormat::TaggedSymbol,
+            quality: OpenAI::ImagesResponse::Quality::TaggedSymbol,
+            size: OpenAI::ImagesResponse::Size::TaggedSymbol,
             usage: OpenAI::ImagesResponse::Usage
           }
         )
@@ -56,6 +114,94 @@ module OpenAI
       def to_hash
       end
 
+      # The background parameter used for the image generation. Either `transparent` or
+      # `opaque`.
+      module Background
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, OpenAI::ImagesResponse::Background) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRANSPARENT =
+          T.let(:transparent, OpenAI::ImagesResponse::Background::TaggedSymbol)
+        OPAQUE =
+          T.let(:opaque, OpenAI::ImagesResponse::Background::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::ImagesResponse::Background::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The output format of the image generation. Either `png`, `webp`, or `jpeg`.
+      module OutputFormat
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, OpenAI::ImagesResponse::OutputFormat) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PNG = T.let(:png, OpenAI::ImagesResponse::OutputFormat::TaggedSymbol)
+        WEBP = T.let(:webp, OpenAI::ImagesResponse::OutputFormat::TaggedSymbol)
+        JPEG = T.let(:jpeg, OpenAI::ImagesResponse::OutputFormat::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::ImagesResponse::OutputFormat::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The quality of the image generated. Either `low`, `medium`, or `high`.
+      module Quality
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, OpenAI::ImagesResponse::Quality) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOW = T.let(:low, OpenAI::ImagesResponse::Quality::TaggedSymbol)
+        MEDIUM = T.let(:medium, OpenAI::ImagesResponse::Quality::TaggedSymbol)
+        HIGH = T.let(:high, OpenAI::ImagesResponse::Quality::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::ImagesResponse::Quality::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The size of the image generated. Either `1024x1024`, `1024x1536`, or
+      # `1536x1024`.
+      module Size
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, OpenAI::ImagesResponse::Size) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SIZE_1024X1024 =
+          T.let(:"1024x1024", OpenAI::ImagesResponse::Size::TaggedSymbol)
+        SIZE_1024X1536 =
+          T.let(:"1024x1536", OpenAI::ImagesResponse::Size::TaggedSymbol)
+        SIZE_1536X1024 =
+          T.let(:"1536x1024", OpenAI::ImagesResponse::Size::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[OpenAI::ImagesResponse::Size::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
       class Usage < OpenAI::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

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(