openai 0.61.0 → 0.63.0

data/rbi/openai/models/admin/organization/usage_completions_response.rbi

@@ -926,6 +926,11 @@ module OpenAI
                 sig { returns(T.nilable(String)) }
                 attr_accessor :project_id
 
+                # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                # result.
+                sig { returns(T.nilable(Float)) }
+                attr_accessor :quantity
+
                 # The aggregated costs details of the specific time bucket.
                 sig do
                   params(
@@ -934,6 +939,7 @@ module OpenAI
                     api_key_id: T.nilable(String),
                     line_item: T.nilable(String),
                     project_id: T.nilable(String),
+                    quantity: T.nilable(Float),
                     object: Symbol
                   ).returns(T.attached_class)
                 end
@@ -949,6 +955,9 @@ module OpenAI
                   # When `group_by=project_id`, this field provides the project ID of the grouped
                   # costs result.
                   project_id: nil,
+                  # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                  # result.
+                  quantity: nil,
                   object: :"organization.costs.result"
                 )
                 end
@@ -961,7 +970,8 @@ module OpenAI
                         OpenAI::Models::Admin::Organization::UsageCompletionsResponse::Data::Result::OrganizationCostsResult::Amount,
                       api_key_id: T.nilable(String),
                       line_item: T.nilable(String),
-                      project_id: T.nilable(String)
+                      project_id: T.nilable(String),
+                      quantity: T.nilable(Float)
                     }
                   )
                 end

data/rbi/openai/models/admin/organization/usage_costs_response.rbi

@@ -926,6 +926,11 @@ module OpenAI
                 sig { returns(T.nilable(String)) }
                 attr_accessor :project_id
 
+                # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                # result.
+                sig { returns(T.nilable(Float)) }
+                attr_accessor :quantity
+
                 # The aggregated costs details of the specific time bucket.
                 sig do
                   params(
@@ -934,6 +939,7 @@ module OpenAI
                     api_key_id: T.nilable(String),
                     line_item: T.nilable(String),
                     project_id: T.nilable(String),
+                    quantity: T.nilable(Float),
                     object: Symbol
                   ).returns(T.attached_class)
                 end
@@ -949,6 +955,9 @@ module OpenAI
                   # When `group_by=project_id`, this field provides the project ID of the grouped
                   # costs result.
                   project_id: nil,
+                  # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                  # result.
+                  quantity: nil,
                   object: :"organization.costs.result"
                 )
                 end
@@ -961,7 +970,8 @@ module OpenAI
                         OpenAI::Models::Admin::Organization::UsageCostsResponse::Data::Result::OrganizationCostsResult::Amount,
                       api_key_id: T.nilable(String),
                       line_item: T.nilable(String),
-                      project_id: T.nilable(String)
+                      project_id: T.nilable(String),
+                      quantity: T.nilable(Float)
                     }
                   )
                 end

data/rbi/openai/models/admin/organization/usage_embeddings_response.rbi

@@ -926,6 +926,11 @@ module OpenAI
                 sig { returns(T.nilable(String)) }
                 attr_accessor :project_id
 
+                # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                # result.
+                sig { returns(T.nilable(Float)) }
+                attr_accessor :quantity
+
                 # The aggregated costs details of the specific time bucket.
                 sig do
                   params(
@@ -934,6 +939,7 @@ module OpenAI
                     api_key_id: T.nilable(String),
                     line_item: T.nilable(String),
                     project_id: T.nilable(String),
+                    quantity: T.nilable(Float),
                     object: Symbol
                   ).returns(T.attached_class)
                 end
@@ -949,6 +955,9 @@ module OpenAI
                   # When `group_by=project_id`, this field provides the project ID of the grouped
                   # costs result.
                   project_id: nil,
+                  # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                  # result.
+                  quantity: nil,
                   object: :"organization.costs.result"
                 )
                 end
@@ -961,7 +970,8 @@ module OpenAI
                         OpenAI::Models::Admin::Organization::UsageEmbeddingsResponse::Data::Result::OrganizationCostsResult::Amount,
                       api_key_id: T.nilable(String),
                       line_item: T.nilable(String),
-                      project_id: T.nilable(String)
+                      project_id: T.nilable(String),
+                      quantity: T.nilable(Float)
                     }
                   )
                 end

data/rbi/openai/models/admin/organization/usage_images_response.rbi

@@ -926,6 +926,11 @@ module OpenAI
                 sig { returns(T.nilable(String)) }
                 attr_accessor :project_id
 
+                # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                # result.
+                sig { returns(T.nilable(Float)) }
+                attr_accessor :quantity
+
                 # The aggregated costs details of the specific time bucket.
                 sig do
                   params(
@@ -934,6 +939,7 @@ module OpenAI
                     api_key_id: T.nilable(String),
                     line_item: T.nilable(String),
                     project_id: T.nilable(String),
+                    quantity: T.nilable(Float),
                     object: Symbol
                   ).returns(T.attached_class)
                 end
@@ -949,6 +955,9 @@ module OpenAI
                   # When `group_by=project_id`, this field provides the project ID of the grouped
                   # costs result.
                   project_id: nil,
+                  # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                  # result.
+                  quantity: nil,
                   object: :"organization.costs.result"
                 )
                 end
@@ -961,7 +970,8 @@ module OpenAI
                         OpenAI::Models::Admin::Organization::UsageImagesResponse::Data::Result::OrganizationCostsResult::Amount,
                       api_key_id: T.nilable(String),
                       line_item: T.nilable(String),
-                      project_id: T.nilable(String)
+                      project_id: T.nilable(String),
+                      quantity: T.nilable(Float)
                     }
                   )
                 end

data/rbi/openai/models/admin/organization/usage_moderations_response.rbi

@@ -926,6 +926,11 @@ module OpenAI
                 sig { returns(T.nilable(String)) }
                 attr_accessor :project_id
 
+                # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                # result.
+                sig { returns(T.nilable(Float)) }
+                attr_accessor :quantity
+
                 # The aggregated costs details of the specific time bucket.
                 sig do
                   params(
@@ -934,6 +939,7 @@ module OpenAI
                     api_key_id: T.nilable(String),
                     line_item: T.nilable(String),
                     project_id: T.nilable(String),
+                    quantity: T.nilable(Float),
                     object: Symbol
                   ).returns(T.attached_class)
                 end
@@ -949,6 +955,9 @@ module OpenAI
                   # When `group_by=project_id`, this field provides the project ID of the grouped
                   # costs result.
                   project_id: nil,
+                  # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                  # result.
+                  quantity: nil,
                   object: :"organization.costs.result"
                 )
                 end
@@ -961,7 +970,8 @@ module OpenAI
                         OpenAI::Models::Admin::Organization::UsageModerationsResponse::Data::Result::OrganizationCostsResult::Amount,
                       api_key_id: T.nilable(String),
                       line_item: T.nilable(String),
-                      project_id: T.nilable(String)
+                      project_id: T.nilable(String),
+                      quantity: T.nilable(Float)
                     }
                   )
                 end

data/rbi/openai/models/admin/organization/usage_vector_stores_response.rbi

@@ -926,6 +926,11 @@ module OpenAI
                 sig { returns(T.nilable(String)) }
                 attr_accessor :project_id
 
+                # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                # result.
+                sig { returns(T.nilable(Float)) }
+                attr_accessor :quantity
+
                 # The aggregated costs details of the specific time bucket.
                 sig do
                   params(
@@ -934,6 +939,7 @@ module OpenAI
                     api_key_id: T.nilable(String),
                     line_item: T.nilable(String),
                     project_id: T.nilable(String),
+                    quantity: T.nilable(Float),
                     object: Symbol
                   ).returns(T.attached_class)
                 end
@@ -949,6 +955,9 @@ module OpenAI
                   # When `group_by=project_id`, this field provides the project ID of the grouped
                   # costs result.
                   project_id: nil,
+                  # When `group_by=line_item`, this field provides the quantity of the grouped costs
+                  # result.
+                  quantity: nil,
                   object: :"organization.costs.result"
                 )
                 end
@@ -961,7 +970,8 @@ module OpenAI
                         OpenAI::Models::Admin::Organization::UsageVectorStoresResponse::Data::Result::OrganizationCostsResult::Amount,
                       api_key_id: T.nilable(String),
                       line_item: T.nilable(String),
-                      project_id: T.nilable(String)
+                      project_id: T.nilable(String),
+                      quantity: T.nilable(Float)
                     }
                   )
                 end

data/rbi/openai/models/chat/chat_completion_token_logprob.rbi

@@ -32,8 +32,7 @@ module OpenAI
         attr_accessor :logprob
 
         # List of the most likely tokens and their log probability, at this token
-        # position. In rare cases, there may be fewer than the number of requested
-        # `top_logprobs` returned.
+        # position. The number of entries may be fewer than the requested `top_logprobs`.
         sig do
           returns(
             T::Array[OpenAI::Chat::ChatCompletionTokenLogprob::TopLogprob]
@@ -65,8 +64,7 @@ module OpenAI
           # unlikely.
           logprob:,
           # List of the most likely tokens and their log probability, at this token
-          # position. In rare cases, there may be fewer than the number of requested
-          # `top_logprobs` returned.
+          # position. The number of entries may be fewer than the requested `top_logprobs`.
           top_logprobs:
         )
         end

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

@@ -441,8 +441,9 @@ module OpenAI
         end
         attr_writer :tools
 
-        # An integer between 0 and 20 specifying the number of most likely tokens to
-        # return at each token position, each with an associated log probability.
+        # An integer between 0 and 20 specifying the maximum number of most likely tokens
+        # to return at each token position, each with an associated log probability. In
+        # some cases, the number of returned tokens may be fewer than requested.
         # `logprobs` must be set to `true` if this parameter is used.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :top_logprobs
@@ -780,8 +781,9 @@ module OpenAI
           # [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools)
           # or [function tools](https://platform.openai.com/docs/guides/function-calling).
           tools: nil,
-          # An integer between 0 and 20 specifying the number of most likely tokens to
-          # return at each token position, each with an associated log probability.
+          # An integer between 0 and 20 specifying the maximum number of most likely tokens
+          # to return at each token position, each with an associated log probability. In
+          # some cases, the number of returned tokens may be fewer than requested.
           # `logprobs` must be set to `true` if this parameter is used.
           top_logprobs: nil,
           # An alternative to sampling with temperature, called nucleus sampling, where the

data/rbi/openai/models/image_edit_params.rbi

@@ -13,10 +13,10 @@ module OpenAI
 
       # The image(s) to edit. Must be a supported image file or an array of images.
       #
-      # For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, and
-      # `gpt-image-1.5`), each image should be a `png`, `webp`, or `jpg` file less than
-      # 50MB. You can provide up to 16 images. `chatgpt-image-latest` follows the same
-      # input constraints as GPT image models.
+      # For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
+      # `gpt-image-2`, `gpt-image-2-2026-04-21`, and `chatgpt-image-latest`), each image
+      # should be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to
+      # 16 images.
       #
       # For `dall-e-2`, you can only provide one image, and it should be a square `png`
       # file less than 4MB.
@@ -29,9 +29,14 @@ module OpenAI
       attr_accessor :prompt
 
       # Allows to set transparency for the background of the generated image(s). This
-      # parameter is only supported for the GPT image models. Must be one of
-      # `transparent`, `opaque` or `auto` (default value). When `auto` is used, the
-      # model will automatically determine the best background for the image.
+      # parameter is only supported for GPT image models that support transparent
+      # backgrounds. Must be one of `transparent`, `opaque`, or `auto` (default value).
+      # When `auto` is used, the model will automatically determine the best background
+      # for the image.
+      #
+      # `gpt-image-2` and `gpt-image-2-2026-04-21` do not support transparent
+      # backgrounds. Requests with `background` set to `transparent` will return an
+      # error for these models; use `opaque` or `auto` instead.
       #
       # If `transparent`, the output format needs to support transparency, so it should
       # be set to either `png` (default value) or `webp`.
@@ -57,7 +62,10 @@ module OpenAI
       sig { params(mask: OpenAI::Internal::FileInput).void }
       attr_writer :mask
 
-      # The model to use for image generation. Defaults to `gpt-image-1.5`.
+      # The model to use for image generation. One of `dall-e-2` or a GPT image model
+      # (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
+      # `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`). Defaults to
+      # `gpt-image-1.5`.
       sig { returns(T.nilable(T.any(String, OpenAI::ImageModel::OrSymbol))) }
       attr_accessor :model
 
@@ -102,10 +110,22 @@ module OpenAI
       end
       attr_accessor :response_format
 
-      # The size of the generated images. Must be one of `1024x1024`, `1536x1024`
-      # (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
-      # models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
-      sig { returns(T.nilable(OpenAI::ImageEditParams::Size::OrSymbol)) }
+      # The size of the generated images. For `gpt-image-2` and
+      # `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT`
+      # strings, for example `1536x864`. Width and height must both be divisible by 16
+      # and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above
+      # `2560x1440` are experimental, and the maximum supported resolution is
+      # `3840x2160`. The requested size must also satisfy the model's current pixel and
+      # edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are
+      # supported by the GPT image models; `auto` is supported for models that allow
+      # automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or
+      # `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or
+      # `1024x1792`.
+      sig do
+        returns(
+          T.nilable(T.any(String, OpenAI::ImageEditParams::Size::OrSymbol))
+        )
+      end
       attr_accessor :size
 
       # A unique identifier representing your end-user, which can help OpenAI to monitor
@@ -134,7 +154,8 @@ module OpenAI
           quality: T.nilable(OpenAI::ImageEditParams::Quality::OrSymbol),
           response_format:
             T.nilable(OpenAI::ImageEditParams::ResponseFormat::OrSymbol),
-          size: T.nilable(OpenAI::ImageEditParams::Size::OrSymbol),
+          size:
+            T.nilable(T.any(String, OpenAI::ImageEditParams::Size::OrSymbol)),
           user: String,
           request_options: OpenAI::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -142,10 +163,10 @@ module OpenAI
       def self.new(
         # The image(s) to edit. Must be a supported image file or an array of images.
         #
-        # For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, and
-        # `gpt-image-1.5`), each image should be a `png`, `webp`, or `jpg` file less than
-        # 50MB. You can provide up to 16 images. `chatgpt-image-latest` follows the same
-        # input constraints as GPT image models.
+        # For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
+        # `gpt-image-2`, `gpt-image-2-2026-04-21`, and `chatgpt-image-latest`), each image
+        # should be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to
+        # 16 images.
         #
         # For `dall-e-2`, you can only provide one image, and it should be a square `png`
         # file less than 4MB.
@@ -154,9 +175,14 @@ module OpenAI
         # characters for `dall-e-2`, and 32000 characters for the GPT image models.
         prompt:,
         # Allows to set transparency for the background of the generated image(s). This
-        # parameter is only supported for the GPT image models. Must be one of
-        # `transparent`, `opaque` or `auto` (default value). When `auto` is used, the
-        # model will automatically determine the best background for the image.
+        # parameter is only supported for GPT image models that support transparent
+        # backgrounds. Must be one of `transparent`, `opaque`, or `auto` (default value).
+        # When `auto` is used, the model will automatically determine the best background
+        # for the image.
+        #
+        # `gpt-image-2` and `gpt-image-2-2026-04-21` do not support transparent
+        # backgrounds. Requests with `background` set to `transparent` will return an
+        # error for these models; use `opaque` or `auto` instead.
         #
         # If `transparent`, the output format needs to support transparency, so it should
         # be set to either `png` (default value) or `webp`.
@@ -171,7 +197,10 @@ module OpenAI
         # the mask will be applied on the first image. Must be a valid PNG file, less than
         # 4MB, and have the same dimensions as `image`.
         mask: nil,
-        # The model to use for image generation. Defaults to `gpt-image-1.5`.
+        # The model to use for image generation. One of `dall-e-2` or a GPT image model
+        # (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
+        # `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`). Defaults to
+        # `gpt-image-1.5`.
         model: nil,
         # The number of images to generate. Must be between 1 and 10.
         n: nil,
@@ -198,9 +227,17 @@ module OpenAI
         # generated. This parameter is only supported for `dall-e-2` (default is `url` for
         # `dall-e-2`), as GPT image models always return base64-encoded images.
         response_format: nil,
-        # The size of the generated images. Must be one of `1024x1024`, `1536x1024`
-        # (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
-        # models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
+        # The size of the generated images. For `gpt-image-2` and
+        # `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT`
+        # strings, for example `1536x864`. Width and height must both be divisible by 16
+        # and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above
+        # `2560x1440` are experimental, and the maximum supported resolution is
+        # `3840x2160`. The requested size must also satisfy the model's current pixel and
+        # edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are
+        # supported by the GPT image models; `auto` is supported for models that allow
+        # automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or
+        # `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or
+        # `1024x1792`.
         size: nil,
         # A unique identifier representing your end-user, which can help OpenAI to monitor
         # and detect abuse.
@@ -229,7 +266,8 @@ module OpenAI
             quality: T.nilable(OpenAI::ImageEditParams::Quality::OrSymbol),
             response_format:
               T.nilable(OpenAI::ImageEditParams::ResponseFormat::OrSymbol),
-            size: T.nilable(OpenAI::ImageEditParams::Size::OrSymbol),
+            size:
+              T.nilable(T.any(String, OpenAI::ImageEditParams::Size::OrSymbol)),
             user: String,
             request_options: OpenAI::RequestOptions
           }
@@ -240,10 +278,10 @@ module OpenAI
 
       # The image(s) to edit. Must be a supported image file or an array of images.
       #
-      # For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, and
-      # `gpt-image-1.5`), each image should be a `png`, `webp`, or `jpg` file less than
-      # 50MB. You can provide up to 16 images. `chatgpt-image-latest` follows the same
-      # input constraints as GPT image models.
+      # For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
+      # `gpt-image-2`, `gpt-image-2-2026-04-21`, and `chatgpt-image-latest`), each image
+      # should be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to
+      # 16 images.
       #
       # For `dall-e-2`, you can only provide one image, and it should be a square `png`
       # file less than 4MB.
@@ -266,9 +304,14 @@ module OpenAI
       end
 
       # Allows to set transparency for the background of the generated image(s). This
-      # parameter is only supported for the GPT image models. Must be one of
-      # `transparent`, `opaque` or `auto` (default value). When `auto` is used, the
-      # model will automatically determine the best background for the image.
+      # parameter is only supported for GPT image models that support transparent
+      # backgrounds. Must be one of `transparent`, `opaque`, or `auto` (default value).
+      # When `auto` is used, the model will automatically determine the best background
+      # for the image.
+      #
+      # `gpt-image-2` and `gpt-image-2-2026-04-21` do not support transparent
+      # backgrounds. Requests with `background` set to `transparent` will return an
+      # error for these models; use `opaque` or `auto` instead.
       #
       # If `transparent`, the output format needs to support transparency, so it should
       # be set to either `png` (default value) or `webp`.
@@ -318,7 +361,10 @@ module OpenAI
         end
       end
 
-      # The model to use for image generation. Defaults to `gpt-image-1.5`.
+      # The model to use for image generation. One of `dall-e-2` or a GPT image model
+      # (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
+      # `gpt-image-2-2026-04-21`, or `chatgpt-image-latest`). Defaults to
+      # `gpt-image-1.5`.
       module Model
         extend OpenAI::Internal::Type::Union
 
@@ -409,11 +455,30 @@ module OpenAI
         end
       end
 
-      # The size of the generated images. Must be one of `1024x1024`, `1536x1024`
-      # (landscape), `1024x1536` (portrait), or `auto` (default value) for the GPT image
-      # models, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
+      # The size of the generated images. For `gpt-image-2` and
+      # `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT`
+      # strings, for example `1536x864`. Width and height must both be divisible by 16
+      # and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above
+      # `2560x1440` are experimental, and the maximum supported resolution is
+      # `3840x2160`. The requested size must also satisfy the model's current pixel and
+      # edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are
+      # supported by the GPT image models; `auto` is supported for models that allow
+      # automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or
+      # `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or
+      # `1024x1792`.
       module Size
-        extend OpenAI::Internal::Type::Enum
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(String, OpenAI::ImageEditParams::Size::TaggedSymbol)
+          end
+
+        sig do
+          override.returns(T::Array[OpenAI::ImageEditParams::Size::Variants])
+        end
+        def self.variants
+        end
 
         TaggedSymbol =
           T.type_alias { T.all(Symbol, OpenAI::ImageEditParams::Size) }
@@ -430,14 +495,6 @@ module OpenAI
         SIZE_1024X1536 =
           T.let(:"1024x1536", OpenAI::ImageEditParams::Size::TaggedSymbol)
         AUTO = T.let(:auto, OpenAI::ImageEditParams::Size::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[OpenAI::ImageEditParams::Size::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
       end
     end
   end