feat(api): add GPT Image 2.5 models and image options

.castiron.stats.yml

@@ -1,8 +1,8 @@
 schema_version: 1
-generation_id: 6bb9e6c1-649a-4064-96b6-31ddb719a74b
-openapi_spec_hash: a2e1a14d94531a640817968365170f62
-openapi_transformed_spec_hash: 64d5a44b8c772a86a5c1824c7d7d6ddd
-config_hash: dfe8a20c64cc5d852e69c441cbd28ae7
-codegen_sha: 8aef429ad0e34051f0e6fc1ce4f99462cc817168
-codegen_hash: 7f483327c3394f7c93be5cae1abb8c6db77ebd44923cfe7cd8e8857de9386138
-public_codegen_sha: 4e571cbcb8e83ab27007a10e50acbba9c1565be7
+generation_id: 7f5b669b-5cfb-49a0-a069-b34e47bd12e9
+openapi_spec_hash: 0ac5ea4ab2546a188a36a0d370367637
+openapi_transformed_spec_hash: 6be6c39576ec27111cab26c251d2ab65
+config_hash: d92ec885ac2a08b6a4c1ff90420f0327
+codegen_sha: 23ba3d180f14bc59feb714e1ab25d5d341f5c213
+codegen_hash: 1e48d0bf25ef090cada933936c2c23c5843d9fc1504a36983ab2970b4a51971d
+public_codegen_sha: 0e6ccf8a94ca9c81a24ae4309a74e49d91639708

lib/openai/models/beta/beta_response_input_item.rb

@@ -1224,7 +1224,30 @@ class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
           #   @return [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Agent, nil]
           optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Agent }, nil?: true
 
-          # @!method initialize(id:, result:, status:, agent: nil, type: :image_generation_call)
+          # @!attribute quality
+          #   The quality of the image generated by the image generation tool call. One of
+          #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Quality, nil]
+          optional(
+            :quality,
+            enum: -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Quality },
+            nil?: true
+          )
+
+          # @!attribute size
+          #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
+          #   @return [String, Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size, nil]
+          optional(
+            :size,
+            union: -> {
+              OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Size
+            },
+            nil?: true
+          )
+
+          # @!method initialize(id:, result:, status:, agent: nil, quality: nil, size: nil, type: :image_generation_call)
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall} for more
           #   details.
@@ -1239,6 +1262,10 @@ class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
           #
           #   @param agent [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Agent, nil] The agent that produced this item.
           #
+          #   @param quality [Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Quality, nil] The quality of the image generated by the image generation tool call. One of `lo
+          #
+          #   @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size, nil] The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
           #   @param type [Symbol, :image_generation_call] The type of the image generation call. Always `image_generation_call`.
 
           # The status of the image generation call.
@@ -1269,6 +1296,62 @@ class Agent < OpenAI::Internal::Type::BaseModel
             #
             #   @param agent_name [String] The canonical name of the agent that produced this item.
           end
+
+          # The quality of the image generated by the image generation tool call. One of
+          # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+          #
+          # @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#quality
+          module Quality
+            extend OpenAI::Internal::Type::Enum
+
+            LOW = :low
+            MEDIUM = :medium
+            HIGH = :high
+            XHIGH = :xhigh
+            MAX = :max
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
+          # @see OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall#size
+          module Size
+            extend OpenAI::Internal::Type::Union
+
+            variant String
+
+            variant(
+              const: -> { OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size::SIZE_1024X1024 }
+            )
+
+            variant(
+              const: -> { OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size::SIZE_1024X1536 }
+            )
+
+            variant(
+              const: -> { OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size::SIZE_1536X1024 }
+            )
+
+            # @!method self.variants
+            #   @return [Array(String, Symbol)]
+
+            define_sorbet_constant!(:Variants) do
+              T.type_alias {
+                T.any(String, OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::Size::TaggedSymbol)
+              }
+            end
+
+            # @!group
+
+            SIZE_1024X1024 = :"1024x1024"
+            SIZE_1024X1536 = :"1024x1536"
+            SIZE_1536X1024 = :"1536x1024"
+
+            # @!endgroup
+          end
         end
 
         class LocalShellCall < OpenAI::Internal::Type::BaseModel

lib/openai/models/beta/beta_response_item.rb

@@ -803,7 +803,26 @@ class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
           #   @return [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Agent, nil]
           optional :agent, -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Agent }, nil?: true
 
-          # @!method initialize(id:, result:, status:, agent: nil, type: :image_generation_call)
+          # @!attribute quality
+          #   The quality of the image generated by the image generation tool call. One of
+          #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Quality, nil]
+          optional(
+            :quality,
+            enum: -> {
+              OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Quality
+            },
+            nil?: true
+          )
+
+          # @!attribute size
+          #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
+          #   @return [String, Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Size, nil]
+          optional :size, union: -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Size }, nil?: true
+
+          # @!method initialize(id:, result:, status:, agent: nil, quality: nil, size: nil, type: :image_generation_call)
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall} for more details.
           #
@@ -817,6 +836,10 @@ class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
           #
           #   @param agent [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Agent, nil] The agent that produced this item.
           #
+          #   @param quality [Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Quality, nil] The quality of the image generated by the image generation tool call. One of `lo
+          #
+          #   @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Size, nil] The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
           #   @param type [Symbol, :image_generation_call] The type of the image generation call. Always `image_generation_call`.
 
           # The status of the image generation call.
@@ -847,6 +870,54 @@ class Agent < OpenAI::Internal::Type::BaseModel
             #
             #   @param agent_name [String] The canonical name of the agent that produced this item.
           end
+
+          # The quality of the image generated by the image generation tool call. One of
+          # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+          #
+          # @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall#quality
+          module Quality
+            extend OpenAI::Internal::Type::Enum
+
+            LOW = :low
+            MEDIUM = :medium
+            HIGH = :high
+            XHIGH = :xhigh
+            MAX = :max
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
+          # @see OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall#size
+          module Size
+            extend OpenAI::Internal::Type::Union
+
+            variant String
+
+            variant const: -> { OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Size::SIZE_1024X1024 }
+
+            variant const: -> { OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Size::SIZE_1024X1536 }
+
+            variant const: -> { OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Size::SIZE_1536X1024 }
+
+            # @!method self.variants
+            #   @return [Array(String, Symbol)]
+
+            define_sorbet_constant!(:Variants) do
+              T.type_alias { T.any(String, OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Size::TaggedSymbol) }
+            end
+
+            # @!group
+
+            SIZE_1024X1024 = :"1024x1024"
+            SIZE_1024X1536 = :"1024x1536"
+            SIZE_1536X1024 = :"1536x1024"
+
+            # @!endgroup
+          end
         end
 
         class LocalShellCall < OpenAI::Internal::Type::BaseModel

lib/openai/models/beta/beta_response_output_item.rb

@@ -802,7 +802,30 @@ class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
           #   @return [OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Agent, nil]
           optional :agent, -> { OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Agent }, nil?: true
 
-          # @!method initialize(id:, result:, status:, agent: nil, type: :image_generation_call)
+          # @!attribute quality
+          #   The quality of the image generated by the image generation tool call. One of
+          #   `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Quality, nil]
+          optional(
+            :quality,
+            enum: -> { OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Quality },
+            nil?: true
+          )
+
+          # @!attribute size
+          #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
+          #   @return [String, Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size, nil]
+          optional(
+            :size,
+            union: -> {
+              OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Size
+            },
+            nil?: true
+          )
+
+          # @!method initialize(id:, result:, status:, agent: nil, quality: nil, size: nil, type: :image_generation_call)
           #   Some parameter documentations has been truncated, see
           #   {OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall} for more
           #   details.
@@ -817,6 +840,10 @@ class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
           #
           #   @param agent [OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Agent, nil] The agent that produced this item.
           #
+          #   @param quality [Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Quality, nil] The quality of the image generated by the image generation tool call. One of `lo
+          #
+          #   @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size, nil] The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
           #   @param type [Symbol, :image_generation_call] The type of the image generation call. Always `image_generation_call`.
 
           # The status of the image generation call.
@@ -847,6 +874,62 @@ class Agent < OpenAI::Internal::Type::BaseModel
             #
             #   @param agent_name [String] The canonical name of the agent that produced this item.
           end
+
+          # The quality of the image generated by the image generation tool call. One of
+          # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+          #
+          # @see OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall#quality
+          module Quality
+            extend OpenAI::Internal::Type::Enum
+
+            LOW = :low
+            MEDIUM = :medium
+            HIGH = :high
+            XHIGH = :xhigh
+            MAX = :max
+            AUTO = :auto
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          #
+          # @see OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall#size
+          module Size
+            extend OpenAI::Internal::Type::Union
+
+            variant String
+
+            variant(
+              const: -> { OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size::SIZE_1024X1024 }
+            )
+
+            variant(
+              const: -> { OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size::SIZE_1024X1536 }
+            )
+
+            variant(
+              const: -> { OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size::SIZE_1536X1024 }
+            )
+
+            # @!method self.variants
+            #   @return [Array(String, Symbol)]
+
+            define_sorbet_constant!(:Variants) do
+              T.type_alias {
+                T.any(String, OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::Size::TaggedSymbol)
+              }
+            end
+
+            # @!group
+
+            SIZE_1024X1024 = :"1024x1024"
+            SIZE_1024X1536 = :"1024x1536"
+            SIZE_1536X1024 = :"1536x1024"
+
+            # @!endgroup
+          end
         end
 
         class LocalShellCall < OpenAI::Internal::Type::BaseModel

lib/openai/models/beta/beta_responses_client_event.rb

@@ -336,6 +336,9 @@ class ResponseCreate < OpenAI::Internal::Type::BaseModel
 
           # @!attribute store
           #   Whether to store the generated model response for later retrieval via API.
+          #   Defaults to true when omitted. If set to true, response data will be stored for
+          #   at least 30 days, subject to the
+          #   [data retention exceptions](/api/docs/guides/your-data#v1responses).
           #
           #   @return [Boolean, nil]
           optional :store, OpenAI::Internal::Type::Boolean, nil?: true