openai 0.86.0 → 0.87.0

data/rbi/openai/models/responses/response_output_item.rbi

@@ -347,6 +347,15 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # The quality of the image generated by the image generation tool call. One of
+          # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)) }
+          attr_accessor :quality
+
+          # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          sig { returns(T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::Variants)) }
+          attr_accessor :size
+
           # An image generation request made by the model.
           sig do
             params(
@@ -357,6 +366,10 @@ module OpenAI
 
               status: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Status::OrSymbol,
 
+              quality: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::OrSymbol),
+
+              size: T.nilable(T.any(String, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::OrSymbol)),
+
               type: Symbol
             )
               .returns(T.attached_class)
@@ -372,6 +385,13 @@ module OpenAI
             # The status of the image generation call.
             status:,
 
+            # The quality of the image generated by the image generation tool call. One of
+            # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+            quality: nil,
+
+            # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+            size: nil,
+
             # The type of the image generation call. Always `image_generation_call`.
 
             type: :image_generation_call
@@ -384,7 +404,9 @@ module OpenAI
                 id: String,
                 result: T.nilable(String),
                 status: OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Status::TaggedSymbol,
-                type: Symbol
+                type: Symbol,
+                quality: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol),
+                size: T.nilable(OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::Variants)
               }
             )
           end
@@ -422,6 +444,67 @@ module OpenAI
             def self.values
             end
           end
+
+          # The quality of the image generated by the image generation tool call. One of
+          # `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+          module Quality
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias {
+              T.all(Symbol, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality)
+            }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LOW = T.let(:low, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+            MEDIUM = T.let(:medium, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+            HIGH = T.let(:high, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+            XHIGH = T.let(:xhigh, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+            MAX = T.let(:max, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+            AUTO = T.let(:auto, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol)
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Quality::TaggedSymbol]
+              )
+            }
+            def self.values
+            end
+          end
+
+          # The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+          module Size
+            extend OpenAI::Internal::Type::Union
+
+            Variants = T.type_alias {
+              T.any(String, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::TaggedSymbol)
+            }
+
+            sig {
+              override.returns(T::Array[OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::Variants])
+            }
+            def self.variants
+            end
+
+            TaggedSymbol = T.type_alias do
+              T.all(Symbol, OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size)
+            end
+
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SIZE_1024X1024 = T.let(
+              :"1024x1024",
+              OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::TaggedSymbol
+            )
+            SIZE_1024X1536 = T.let(
+              :"1024x1536",
+              OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::TaggedSymbol
+            )
+            SIZE_1536X1024 = T.let(
+              :"1536x1024",
+              OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::Size::TaggedSymbol
+            )
+
+          end
         end
 
         class LocalShellCall < OpenAI::Internal::Type::BaseModel

data/rbi/openai/models/responses/responses_client_event.rbi

@@ -256,6 +256,9 @@ module OpenAI
           attr_accessor :service_tier
 
           # 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).
           sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :store
 
@@ -740,6 +743,9 @@ module OpenAI
             service_tier: nil,
 
             # 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).
             store: nil,
 
             # If set to true, the model response data will be streamed to the client as it is

data/rbi/openai/models/responses/tool.rbi

@@ -954,9 +954,11 @@ module OpenAI
           # one of `transparent`, `opaque`, or `auto` (default value). When `auto` is used,
           # the model will automatically determine the best background for the image.
           #
-          # 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`.
+          # `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`.
           sig { returns(T.nilable(OpenAI::Responses::Tool::ImageGeneration::Background::OrSymbol)) }
           attr_reader :background
 
@@ -979,7 +981,9 @@ module OpenAI
           attr_writer :input_image_mask
 
           # The image generation model to use. One of `gpt-image-1`, `gpt-image-1-mini`,
-          # `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`, or
+          # `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`. Default: `gpt-image-1`.
           sig { returns(T.nilable(T.any(String, OpenAI::Responses::Tool::ImageGeneration::Model::OrSymbol))) }
           attr_reader :model
@@ -1017,25 +1021,28 @@ module OpenAI
           sig { params(partial_images: Integer).void }
           attr_writer :partial_images
 
-          # The quality of the generated image. One of `low`, `medium`, `high`, or `auto`.
-          # Default: `auto`.
+          # The quality of the generated image. 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`. Default:
+          # `auto`.
           sig { returns(T.nilable(OpenAI::Responses::Tool::ImageGeneration::Quality::OrSymbol)) }
           attr_reader :quality
 
           sig { params(quality: OpenAI::Responses::Tool::ImageGeneration::Quality::OrSymbol).void }
           attr_writer :quality
 
-          # 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`.
+          # 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`.
           sig { returns(T.nilable(T.any(String, OpenAI::Responses::Tool::ImageGeneration::Size::OrSymbol))) }
           attr_reader :size
 
@@ -1081,9 +1088,11 @@ module OpenAI
             # one of `transparent`, `opaque`, or `auto` (default value). When `auto` is used,
             # the model will automatically determine the best background for the image.
             #
-            # 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`.
+            # `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`.
             background: nil,
 
             # Control how much effort the model will exert to match the style and features,
@@ -1097,7 +1106,9 @@ module OpenAI
             input_image_mask: nil,
 
             # The image generation model to use. One of `gpt-image-1`, `gpt-image-1-mini`,
-            # `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`, or
+            # `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`. Default: `gpt-image-1`.
             model: nil,
 
@@ -1115,21 +1126,24 @@ module OpenAI
             # to 3.
             partial_images: nil,
 
-            # The quality of the generated image. One of `low`, `medium`, `high`, or `auto`.
-            # Default: `auto`.
+            # The quality of the generated image. 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`. Default:
+            # `auto`.
             quality: nil,
 
-            # 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`.
+            # 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`.
             size: nil,
 
             # The type of the image generation tool. Always `image_generation`.
@@ -1179,9 +1193,11 @@ module OpenAI
           # one of `transparent`, `opaque`, or `auto` (default value). When `auto` is used,
           # the model will automatically determine the best background for the image.
           #
-          # 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`.
+          # `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`.
           module Background
             extend OpenAI::Internal::Type::Enum
 
@@ -1270,7 +1286,9 @@ module OpenAI
           end
 
           # The image generation model to use. One of `gpt-image-1`, `gpt-image-1-mini`,
-          # `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`, or
+          # `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`. Default: `gpt-image-1`.
           module Model
             extend OpenAI::Internal::Type::Union
@@ -1294,6 +1312,22 @@ module OpenAI
               :"gpt-image-2-2026-04-21",
               OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
             )
+            GPT_IMAGE_2_5_SUNBURST = T.let(
+              :"gpt-image-2.5-sunburst",
+              OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
+            )
+            GPT_IMAGE_2_5_SUNBURST_2026_09_08 = T.let(
+              :"gpt-image-2.5-sunburst-2026-09-08",
+              OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
+            )
+            GPT_IMAGE_2_5_FLARE = T.let(
+              :"gpt-image-2.5-flare",
+              OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
+            )
+            GPT_IMAGE_2_5_FLARE_2026_09_08 = T.let(
+              :"gpt-image-2.5-flare-2026-09-08",
+              OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
+            )
             GPT_IMAGE_1_5 = T.let(:"gpt-image-1.5", OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol)
             CHATGPT_IMAGE_LATEST = T.let(
               :"chatgpt-image-latest",
@@ -1334,8 +1368,10 @@ module OpenAI
             end
           end
 
-          # The quality of the generated image. One of `low`, `medium`, `high`, or `auto`.
-          # Default: `auto`.
+          # The quality of the generated image. 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`. Default:
+          # `auto`.
           module Quality
             extend OpenAI::Internal::Type::Enum
 
@@ -1345,6 +1381,8 @@ module OpenAI
             LOW = T.let(:low, OpenAI::Responses::Tool::ImageGeneration::Quality::TaggedSymbol)
             MEDIUM = T.let(:medium, OpenAI::Responses::Tool::ImageGeneration::Quality::TaggedSymbol)
             HIGH = T.let(:high, OpenAI::Responses::Tool::ImageGeneration::Quality::TaggedSymbol)
+            XHIGH = T.let(:xhigh, OpenAI::Responses::Tool::ImageGeneration::Quality::TaggedSymbol)
+            MAX = T.let(:max, OpenAI::Responses::Tool::ImageGeneration::Quality::TaggedSymbol)
             AUTO = T.let(:auto, OpenAI::Responses::Tool::ImageGeneration::Quality::TaggedSymbol)
 
             sig { override.returns(T::Array[OpenAI::Responses::Tool::ImageGeneration::Quality::TaggedSymbol]) }
@@ -1352,17 +1390,18 @@ module OpenAI
             end
           end
 
-          # 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`.
+          # 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`.
           module Size
             extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/webhooks/live_call_incoming_webhook_event.rbi

@@ -100,8 +100,8 @@ module OpenAI
             )
           end
 
-          # The Transceiver `rtc_...` ID of the pending SIP session. The same value appears
-          # as `call_id` in `realtime.call.incoming`.
+          # The `live_...` ID of the pending SIP session. Forward this value unchanged when
+          # accepting or rejecting the call through the Live API.
           sig { returns(String) }
           attr_accessor :session_id
 
@@ -121,8 +121,8 @@ module OpenAI
           end
           def self.new(
 
-            # The Transceiver `rtc_...` ID of the pending SIP session. The same value appears
-            # as `call_id` in `realtime.call.incoming`.
+            # The `live_...` ID of the pending SIP session. Forward this value unchanged when
+            # accepting or rejecting the call through the Live API.
             session_id:,
 
             # Headers from the SIP Invite.

data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi

@@ -100,8 +100,10 @@ module OpenAI
             )
           end
 
-          # The Transceiver `rtc_...` ID of the pending SIP session. The same value appears
-          # as `session_id` in `live.call.incoming`.
+          # The Transceiver `rtc_...` ID of the pending SIP session. The paired
+          # `live.call.incoming` event derives its `session_id` by replacing the `rtc_`
+          # prefix with `live_`. Use the ID returned by the event with the corresponding
+          # Realtime or Live API.
           sig { returns(String) }
           attr_accessor :call_id
 
@@ -121,8 +123,10 @@ module OpenAI
           end
           def self.new(
 
-            # The Transceiver `rtc_...` ID of the pending SIP session. The same value appears
-            # as `session_id` in `live.call.incoming`.
+            # The Transceiver `rtc_...` ID of the pending SIP session. The paired
+            # `live.call.incoming` event derives its `session_id` by replacing the `rtc_`
+            # prefix with `live_`. Use the ID returned by the event with the corresponding
+            # Realtime or Live API.
             call_id:,
 
             # Headers from the SIP Invite.

data/rbi/openai/resources/beta/responses.rbi

@@ -247,7 +247,9 @@ module OpenAI
           # parameter.
           service_tier: nil,
           # Body param: Whether to store the generated model response for later retrieval
-          # via API.
+          # 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).
           store: nil,
           # Body param: Options for streaming responses. Only set this when you set
           # `stream: true`.
@@ -561,7 +563,9 @@ module OpenAI
           # parameter.
           service_tier: nil,
           # Body param: Whether to store the generated model response for later retrieval
-          # via API.
+          # 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).
           store: nil,
           # Body param: Options for streaming responses. Only set this when you set
           # `stream: true`.