openai 0.91.0 → 0.93.0

data/sig/openai/models/image_edit_completed_event.rbs

@@ -13,22 +13,48 @@ module OpenAI
       }
 
     class ImageEditCompletedEvent < OpenAI::Internal::Type::BaseModel
+      # Base64-encoded final edited image data, suitable for rendering as an image.
       attr_accessor b64_json: String
 
+      # The background setting for the edited image.
       attr_accessor background: OpenAI::Models::ImageEditCompletedEvent::background
 
+      # The Unix timestamp when the event was created.
       attr_accessor created_at: Integer
 
+      # The output format for the edited image.
       attr_accessor output_format: OpenAI::Models::ImageEditCompletedEvent::output_format
 
+      # The quality setting for the edited image.
       attr_accessor quality: OpenAI::Models::ImageEditCompletedEvent::quality
 
+      # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       attr_accessor size: OpenAI::Models::ImageEditCompletedEvent::size
 
+      # The type of the event. Always `image_edit.completed`.
       attr_accessor type: :"image_edit.completed"
 
+      # For the GPT image models only, the token usage information for the image
+      # generation.
       attr_accessor usage: OpenAI::ImageEditCompletedEvent::Usage
 
+      # @param b64_json
+      #   Base64-encoded final edited image data, suitable for rendering as an image.
+      # @param background
+      #   The background setting for the edited image.
+      # @param created_at
+      #   The Unix timestamp when the event was created.
+      # @param output_format
+      #   The output format for the edited image.
+      # @param quality
+      #   The quality setting for the edited image.
+      # @param size
+      #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+      # @param usage
+      #   For the GPT image models only, the token usage information for the image
+      #   generation.
+      # @param type
+      #   The type of the event. Always `image_edit.completed`.
       def initialize: (
         b64_json: String,
         background: OpenAI::Models::ImageEditCompletedEvent::background,
@@ -117,14 +143,26 @@ module OpenAI
         }
 
       class Usage < OpenAI::Internal::Type::BaseModel
+        # The number of tokens (images and text) in the input prompt.
         attr_accessor input_tokens: Integer
 
+        # The input tokens detailed information for the image generation.
         attr_accessor input_tokens_details: OpenAI::ImageEditCompletedEvent::Usage::InputTokensDetails
 
+        # The number of image tokens in the output image.
         attr_accessor output_tokens: Integer
 
+        # The total number of tokens (images and text) used for the image generation.
         attr_accessor total_tokens: Integer
 
+        # @param input_tokens
+        #   The number of tokens (images and text) in the input prompt.
+        # @param input_tokens_details
+        #   The input tokens detailed information for the image generation.
+        # @param output_tokens
+        #   The number of image tokens in the output image.
+        # @param total_tokens
+        #   The total number of tokens (images and text) used for the image generation.
         def initialize: (
           input_tokens: Integer,
           input_tokens_details: OpenAI::ImageEditCompletedEvent::Usage::InputTokensDetails,
@@ -143,10 +181,16 @@ module OpenAI
           { image_tokens: Integer, text_tokens: Integer }
 
         class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # The number of image tokens in the input prompt.
           attr_accessor image_tokens: Integer
 
+          # The number of text tokens in the input prompt.
           attr_accessor text_tokens: Integer
 
+          # @param image_tokens
+          #   The number of image tokens in the input prompt.
+          # @param text_tokens
+          #   The number of text tokens in the input prompt.
           def initialize: (image_tokens: Integer, text_tokens: Integer) -> void
 
           def to_hash: -> { image_tokens: Integer, text_tokens: Integer }

data/sig/openai/models/image_edit_params.rbs

@@ -23,38 +23,221 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # 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`, `gpt-image-1.5`,
+      # `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+      # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
+      # `gpt-image-2.5-flare-2026-09-08`, 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.
+      #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
       attr_accessor image: OpenAI::Models::ImageEditParams::image
 
+      # A text description of the desired image(s). The maximum length is 1000
+      # characters for `dall-e-2`, and 32000 characters for the GPT image models.
       attr_accessor prompt: String
 
+      # Allows to set transparency for the background of the generated image(s). 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.5-sunburst` and `gpt-image-2.5-flare`, including their `2026-09-08`
+      # snapshots, support `opaque` and `transparent` backgrounds. Transparent
+      # backgrounds are available for supported GPT Image models. For `gpt-image-2` and
+      # `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
+      # set the output format to `png` or `webp`.
       attr_accessor background: OpenAI::Models::ImageEditParams::background?
 
+      # Controls fidelity to the original input image(s). This parameter is supported
+      # for GPT image models that support input fidelity. `gpt-image-2` and
+      # `gpt-image-2-2026-04-21` ignore this parameter.
       attr_accessor input_fidelity: OpenAI::Models::ImageEditParams::input_fidelity?
 
+      # An additional image whose fully transparent areas (e.g. where alpha is zero)
+      # indicate where `image` should be edited. If there are multiple images provided,
+      # 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`.
+      #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
       attr_reader mask: OpenAI::Internal::file_input?
 
+      # An additional image whose fully transparent areas (e.g. where alpha is zero)
+      # indicate where `image` should be edited. If there are multiple images provided,
+      # 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`.
+      #
+      # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      # content type.
       def mask=: (OpenAI::Internal::file_input) -> OpenAI::Internal::file_input
 
+      # 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`, `gpt-image-2.5-sunburst`,
+      # `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
+      # `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`). Defaults to
+      # `gpt-image-1.5`.
       attr_accessor model: OpenAI::Models::ImageEditParams::model?
 
+      # The number of images to generate. Must be between 1 and 10.
       attr_accessor n: Integer?
 
+      # The compression level (0-100%) for the generated images. This parameter is only
+      # supported for the GPT image models with the `webp` or `jpeg` output formats, and
+      # defaults to 100.
       attr_accessor output_compression: Integer?
 
+      # The format in which the generated images are returned. This parameter is only
+      # supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`. The
+      # default value is `png`.
       attr_accessor output_format: OpenAI::Models::ImageEditParams::output_format?
 
+      # The number of partial images to generate. This parameter is used for streaming
+      # responses that return partial images. Value must be between 0 and 3. When set to
+      # 0, the response will be a single image sent in one streaming event.
+      #
+      # Note that the final image may be sent before the full number of partial images
+      # are generated if the full image is generated more quickly.
       attr_accessor partial_images: Integer?
 
+      # The quality of the image that will be generated for GPT image models. The GPT
+      # image models support `low`, `medium`, and `high`. `gpt-image-2.5-sunburst` and
+      # `gpt-image-2.5-flare`, including their `2026-09-08` snapshots, also support
+      # `xhigh` and `max`. Defaults to `auto`.
       attr_accessor quality: OpenAI::Models::ImageEditParams::quality?
 
+      # The format in which the generated images are returned. Must be one of `url` or
+      # `b64_json`. URLs are only valid for 60 minutes after the image has been
+      # 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.
       attr_accessor response_format: OpenAI::Models::ImageEditParams::response_format?
 
+      # The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
+      # `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
+      # `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, 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`.
       attr_accessor size: OpenAI::Models::ImageEditParams::size?
 
+      # A unique identifier representing your end-user, which can help OpenAI to monitor
+      # and detect abuse.
+      # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       attr_reader user: String?
 
+      # A unique identifier representing your end-user, which can help OpenAI to monitor
+      # and detect abuse.
+      # [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       def user=: (String) -> String
 
+      # @param image
+      #   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`, `gpt-image-1.5`,
+      #   `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+      #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
+      #   `gpt-image-2.5-flare-2026-09-08`, 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.
+      #
+      #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      #   content type.
+      # @param prompt
+      #   A text description of the desired image(s). The maximum length is 1000
+      #   characters for `dall-e-2`, and 32000 characters for the GPT image models.
+      # @param background
+      #   Allows to set transparency for the background of the generated image(s). 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.5-sunburst` and `gpt-image-2.5-flare`, including their `2026-09-08`
+      #   snapshots, support `opaque` and `transparent` backgrounds. Transparent
+      #   backgrounds are available for supported GPT Image models. For `gpt-image-2` and
+      #   `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
+      #   set the output format to `png` or `webp`.
+      # @param input_fidelity
+      #   Controls fidelity to the original input image(s). This parameter is supported
+      #   for GPT image models that support input fidelity. `gpt-image-2` and
+      #   `gpt-image-2-2026-04-21` ignore this parameter.
+      # @param mask
+      #   An additional image whose fully transparent areas (e.g. where alpha is zero)
+      #   indicate where `image` should be edited. If there are multiple images provided,
+      #   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`.
+      #
+      #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+      #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
+      #   content type.
+      # @param model
+      #   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`, `gpt-image-2.5-sunburst`,
+      #   `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
+      #   `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`). Defaults to
+      #   `gpt-image-1.5`.
+      # @param n
+      #   The number of images to generate. Must be between 1 and 10.
+      # @param output_compression
+      #   The compression level (0-100%) for the generated images. This parameter is only
+      #   supported for the GPT image models with the `webp` or `jpeg` output formats, and
+      #   defaults to 100.
+      # @param output_format
+      #   The format in which the generated images are returned. This parameter is only
+      #   supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`. The
+      #   default value is `png`.
+      # @param partial_images
+      #   The number of partial images to generate. This parameter is used for streaming
+      #   responses that return partial images. Value must be between 0 and 3. When set to
+      #   0, the response will be a single image sent in one streaming event.
+      #
+      #   Note that the final image may be sent before the full number of partial images
+      #   are generated if the full image is generated more quickly.
+      # @param quality
+      #   The quality of the image that will be generated for GPT image models. The GPT
+      #   image models support `low`, `medium`, and `high`. `gpt-image-2.5-sunburst` and
+      #   `gpt-image-2.5-flare`, including their `2026-09-08` snapshots, also support
+      #   `xhigh` and `max`. Defaults to `auto`.
+      # @param response_format
+      #   The format in which the generated images are returned. Must be one of `url` or
+      #   `b64_json`. URLs are only valid for 60 minutes after the image has been
+      #   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.
+      # @param size
+      #   The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
+      #   `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
+      #   `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, 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`.
+      # @param user
+      #   A unique identifier representing your end-user, which can help OpenAI to monitor
+      #   and detect abuse.
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       def initialize: (
         image: OpenAI::Models::ImageEditParams::image,
         prompt: String,

data/sig/openai/models/image_edit_partial_image_event.rbs

@@ -13,22 +13,46 @@ module OpenAI
       }
 
     class ImageEditPartialImageEvent < OpenAI::Internal::Type::BaseModel
+      # Base64-encoded partial image data, suitable for rendering as an image.
       attr_accessor b64_json: String
 
+      # The background setting for the requested edited image.
       attr_accessor background: OpenAI::Models::ImageEditPartialImageEvent::background
 
+      # The Unix timestamp when the event was created.
       attr_accessor created_at: Integer
 
+      # The output format for the requested edited image.
       attr_accessor output_format: OpenAI::Models::ImageEditPartialImageEvent::output_format
 
+      # 0-based index for the partial image (streaming).
       attr_accessor partial_image_index: Integer
 
+      # The quality setting for the requested edited image.
       attr_accessor quality: OpenAI::Models::ImageEditPartialImageEvent::quality
 
+      # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       attr_accessor size: OpenAI::Models::ImageEditPartialImageEvent::size
 
+      # The type of the event. Always `image_edit.partial_image`.
       attr_accessor type: :"image_edit.partial_image"
 
+      # @param b64_json
+      #   Base64-encoded partial image data, suitable for rendering as an image.
+      # @param background
+      #   The background setting for the requested edited image.
+      # @param created_at
+      #   The Unix timestamp when the event was created.
+      # @param output_format
+      #   The output format for the requested edited image.
+      # @param partial_image_index
+      #   0-based index for the partial image (streaming).
+      # @param quality
+      #   The quality setting for the requested edited image.
+      # @param size
+      #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+      # @param type
+      #   The type of the event. Always `image_edit.partial_image`.
       def initialize: (
         b64_json: String,
         background: OpenAI::Models::ImageEditPartialImageEvent::background,

data/sig/openai/models/image_gen_completed_event.rbs

@@ -13,22 +13,48 @@ module OpenAI
       }
 
     class ImageGenCompletedEvent < OpenAI::Internal::Type::BaseModel
+      # Base64-encoded image data, suitable for rendering as an image.
       attr_accessor b64_json: String
 
+      # The background setting for the generated image.
       attr_accessor background: OpenAI::Models::ImageGenCompletedEvent::background
 
+      # The Unix timestamp when the event was created.
       attr_accessor created_at: Integer
 
+      # The output format for the generated image.
       attr_accessor output_format: OpenAI::Models::ImageGenCompletedEvent::output_format
 
+      # The quality setting for the generated image.
       attr_accessor quality: OpenAI::Models::ImageGenCompletedEvent::quality
 
+      # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       attr_accessor size: OpenAI::Models::ImageGenCompletedEvent::size
 
+      # The type of the event. Always `image_generation.completed`.
       attr_accessor type: :"image_generation.completed"
 
+      # For the GPT image models only, the token usage information for the image
+      # generation.
       attr_accessor usage: OpenAI::ImageGenCompletedEvent::Usage
 
+      # @param b64_json
+      #   Base64-encoded image data, suitable for rendering as an image.
+      # @param background
+      #   The background setting for the generated image.
+      # @param created_at
+      #   The Unix timestamp when the event was created.
+      # @param output_format
+      #   The output format for the generated image.
+      # @param quality
+      #   The quality setting for the generated image.
+      # @param size
+      #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+      # @param usage
+      #   For the GPT image models only, the token usage information for the image
+      #   generation.
+      # @param type
+      #   The type of the event. Always `image_generation.completed`.
       def initialize: (
         b64_json: String,
         background: OpenAI::Models::ImageGenCompletedEvent::background,
@@ -117,14 +143,26 @@ module OpenAI
         }
 
       class Usage < OpenAI::Internal::Type::BaseModel
+        # The number of tokens (images and text) in the input prompt.
         attr_accessor input_tokens: Integer
 
+        # The input tokens detailed information for the image generation.
         attr_accessor input_tokens_details: OpenAI::ImageGenCompletedEvent::Usage::InputTokensDetails
 
+        # The number of image tokens in the output image.
         attr_accessor output_tokens: Integer
 
+        # The total number of tokens (images and text) used for the image generation.
         attr_accessor total_tokens: Integer
 
+        # @param input_tokens
+        #   The number of tokens (images and text) in the input prompt.
+        # @param input_tokens_details
+        #   The input tokens detailed information for the image generation.
+        # @param output_tokens
+        #   The number of image tokens in the output image.
+        # @param total_tokens
+        #   The total number of tokens (images and text) used for the image generation.
         def initialize: (
           input_tokens: Integer,
           input_tokens_details: OpenAI::ImageGenCompletedEvent::Usage::InputTokensDetails,
@@ -143,10 +181,16 @@ module OpenAI
           { image_tokens: Integer, text_tokens: Integer }
 
         class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # The number of image tokens in the input prompt.
           attr_accessor image_tokens: Integer
 
+          # The number of text tokens in the input prompt.
           attr_accessor text_tokens: Integer
 
+          # @param image_tokens
+          #   The number of image tokens in the input prompt.
+          # @param text_tokens
+          #   The number of text tokens in the input prompt.
           def initialize: (image_tokens: Integer, text_tokens: Integer) -> void
 
           def to_hash: -> { image_tokens: Integer, text_tokens: Integer }

data/sig/openai/models/image_gen_partial_image_event.rbs

@@ -13,22 +13,46 @@ module OpenAI
       }
 
     class ImageGenPartialImageEvent < OpenAI::Internal::Type::BaseModel
+      # Base64-encoded partial image data, suitable for rendering as an image.
       attr_accessor b64_json: String
 
+      # The background setting for the requested image.
       attr_accessor background: OpenAI::Models::ImageGenPartialImageEvent::background
 
+      # The Unix timestamp when the event was created.
       attr_accessor created_at: Integer
 
+      # The output format for the requested image.
       attr_accessor output_format: OpenAI::Models::ImageGenPartialImageEvent::output_format
 
+      # 0-based index for the partial image (streaming).
       attr_accessor partial_image_index: Integer
 
+      # The quality setting for the requested image.
       attr_accessor quality: OpenAI::Models::ImageGenPartialImageEvent::quality
 
+      # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       attr_accessor size: OpenAI::Models::ImageGenPartialImageEvent::size
 
+      # The type of the event. Always `image_generation.partial_image`.
       attr_accessor type: :"image_generation.partial_image"
 
+      # @param b64_json
+      #   Base64-encoded partial image data, suitable for rendering as an image.
+      # @param background
+      #   The background setting for the requested image.
+      # @param created_at
+      #   The Unix timestamp when the event was created.
+      # @param output_format
+      #   The output format for the requested image.
+      # @param partial_image_index
+      #   0-based index for the partial image (streaming).
+      # @param quality
+      #   The quality setting for the requested image.
+      # @param size
+      #   The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+      # @param type
+      #   The type of the event. Always `image_generation.partial_image`.
       def initialize: (
         b64_json: String,
         background: OpenAI::Models::ImageGenPartialImageEvent::background,