openai 0.9.0 → 0.11.0

data/rbi/openai/models/chat/chat_completion_chunk.rbi

@@ -34,23 +34,23 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :object
 
-        # 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(
@@ -113,23 +113,23 @@ module OpenAI
           created:,
           # The model to generate the completion.
           model:,
-          # 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,
           # This fingerprint represents the backend configuration that the model runs with.
           # Can be used in conjunction with the `seed` request parameter to understand when
@@ -783,23 +783,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
 
@@ -829,6 +829,11 @@ module OpenAI
               :scale,
               OpenAI::Chat::ChatCompletionChunk::ServiceTier::TaggedSymbol
             )
+          PRIORITY =
+            T.let(
+              :priority,
+              OpenAI::Chat::ChatCompletionChunk::ServiceTier::TaggedSymbol
+            )
 
           sig do
             override.returns(

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/fine_tuning/checkpoints/permission_retrieve_response.rbi

@@ -13,56 +13,125 @@ module OpenAI
               )
             end
 
-          # The permission identifier, which can be referenced in the API endpoints.
-          sig { returns(String) }
-          attr_accessor :id
+          sig do
+            returns(
+              T::Array[
+                OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse::Data
+              ]
+            )
+          end
+          attr_accessor :data
 
-          # The Unix timestamp (in seconds) for when the permission was created.
-          sig { returns(Integer) }
-          attr_accessor :created_at
+          sig { returns(T::Boolean) }
+          attr_accessor :has_more
 
-          # The object type, which is always "checkpoint.permission".
           sig { returns(Symbol) }
           attr_accessor :object
 
-          # The project identifier that the permission is for.
-          sig { returns(String) }
-          attr_accessor :project_id
+          sig { returns(T.nilable(String)) }
+          attr_accessor :first_id
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :last_id
 
-          # The `checkpoint.permission` object represents a permission for a fine-tuned
-          # model checkpoint.
           sig do
             params(
-              id: String,
-              created_at: Integer,
-              project_id: String,
+              data:
+                T::Array[
+                  OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse::Data::OrHash
+                ],
+              has_more: T::Boolean,
+              first_id: T.nilable(String),
+              last_id: T.nilable(String),
               object: Symbol
             ).returns(T.attached_class)
           end
           def self.new(
-            # The permission identifier, which can be referenced in the API endpoints.
-            id:,
-            # The Unix timestamp (in seconds) for when the permission was created.
-            created_at:,
-            # The project identifier that the permission is for.
-            project_id:,
-            # The object type, which is always "checkpoint.permission".
-            object: :"checkpoint.permission"
+            data:,
+            has_more:,
+            first_id: nil,
+            last_id: nil,
+            object: :list
           )
           end
 
           sig do
             override.returns(
               {
-                id: String,
-                created_at: Integer,
+                data:
+                  T::Array[
+                    OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse::Data
+                  ],
+                has_more: T::Boolean,
                 object: Symbol,
-                project_id: String
+                first_id: T.nilable(String),
+                last_id: T.nilable(String)
               }
             )
           end
           def to_hash
           end
+
+          class Data < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse::Data,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The permission identifier, which can be referenced in the API endpoints.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # The Unix timestamp (in seconds) for when the permission was created.
+            sig { returns(Integer) }
+            attr_accessor :created_at
+
+            # The object type, which is always "checkpoint.permission".
+            sig { returns(Symbol) }
+            attr_accessor :object
+
+            # The project identifier that the permission is for.
+            sig { returns(String) }
+            attr_accessor :project_id
+
+            # The `checkpoint.permission` object represents a permission for a fine-tuned
+            # model checkpoint.
+            sig do
+              params(
+                id: String,
+                created_at: Integer,
+                project_id: String,
+                object: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The permission identifier, which can be referenced in the API endpoints.
+              id:,
+              # The Unix timestamp (in seconds) for when the permission was created.
+              created_at:,
+              # The project identifier that the permission is for.
+              project_id:,
+              # The object type, which is always "checkpoint.permission".
+              object: :"checkpoint.permission"
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  created_at: Integer,
+                  object: Symbol,
+                  project_id: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end

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