openai 0.87.0 → 0.89.0

data/lib/openai/models/image_gen_completed_event.rb

@@ -53,26 +53,32 @@ module OpenAI
       required :usage, -> { OpenAI::ImageGenCompletedEvent::Usage }
 
       # @!method initialize(b64_json:, background:, created_at:, output_format:, quality:, size:, usage:, type: :"image_generation.completed")
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ImageGenCompletedEvent} for more details.
-      #
       #   Emitted when image generation has completed and the final image is available.
       #
-      #   @param b64_json [String] Base64-encoded image data, suitable for rendering as an image.
+      #   @param b64_json [String]
+      #     Base64-encoded image data, suitable for rendering as an image.
       #
-      #   @param background [Symbol, OpenAI::Models::ImageGenCompletedEvent::Background] The background setting for the generated image.
+      #   @param background [Symbol, OpenAI::Models::ImageGenCompletedEvent::Background]
+      #     The background setting for the generated image.
       #
-      #   @param created_at [Integer] The Unix timestamp when the event was created.
+      #   @param created_at [Integer]
+      #     The Unix timestamp when the event was created.
       #
-      #   @param output_format [Symbol, OpenAI::Models::ImageGenCompletedEvent::OutputFormat] The output format for the generated image.
+      #   @param output_format [Symbol, OpenAI::Models::ImageGenCompletedEvent::OutputFormat]
+      #     The output format for the generated image.
       #
-      #   @param quality [Symbol, OpenAI::Models::ImageGenCompletedEvent::Quality] The quality setting for the generated image.
+      #   @param quality [Symbol, OpenAI::Models::ImageGenCompletedEvent::Quality]
+      #     The quality setting for the generated image.
       #
-      #   @param size [String, Symbol, OpenAI::Models::ImageGenCompletedEvent::Size] The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+      #   @param size [String, Symbol, OpenAI::Models::ImageGenCompletedEvent::Size]
+      #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       #
-      #   @param usage [OpenAI::Models::ImageGenCompletedEvent::Usage] For the GPT image models only, the token usage information for the image generat
+      #   @param usage [OpenAI::Models::ImageGenCompletedEvent::Usage]
+      #     For the GPT image models only, the token usage information for the image
+      #     generation.
       #
-      #   @param type [Symbol, :"image_generation.completed"] The type of the event. Always `image_generation.completed`.
+      #   @param type [Symbol, :"image_generation.completed"]
+      #     The type of the event. Always `image_generation.completed`.
 
       # The background setting for the generated image.
       #
@@ -185,19 +191,20 @@ module OpenAI
         required :total_tokens, Integer
 
         # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, total_tokens:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::ImageGenCompletedEvent::Usage} for more details.
-        #
         #   For the GPT image models only, the token usage information for the image
         #   generation.
         #
-        #   @param input_tokens [Integer] The number of tokens (images and text) in the input prompt.
+        #   @param input_tokens [Integer]
+        #     The number of tokens (images and text) in the input prompt.
         #
-        #   @param input_tokens_details [OpenAI::Models::ImageGenCompletedEvent::Usage::InputTokensDetails] The input tokens detailed information for the image generation.
+        #   @param input_tokens_details [OpenAI::Models::ImageGenCompletedEvent::Usage::InputTokensDetails]
+        #     The input tokens detailed information for the image generation.
         #
-        #   @param output_tokens [Integer] The number of image tokens in the output image.
+        #   @param output_tokens [Integer]
+        #     The number of image tokens in the output image.
         #
-        #   @param total_tokens [Integer] The total number of tokens (images and text) used for the image generation.
+        #   @param total_tokens [Integer]
+        #     The total number of tokens (images and text) used for the image generation.
 
         # @see OpenAI::Models::ImageGenCompletedEvent::Usage#input_tokens_details
         class InputTokensDetails < OpenAI::Internal::Type::BaseModel
@@ -216,9 +223,11 @@ module OpenAI
           # @!method initialize(image_tokens:, text_tokens:)
           #   The input tokens detailed information for the image generation.
           #
-          #   @param image_tokens [Integer] The number of image tokens in the input prompt.
+          #   @param image_tokens [Integer]
+          #     The number of image tokens in the input prompt.
           #
-          #   @param text_tokens [Integer] The number of text tokens in the input prompt.
+          #   @param text_tokens [Integer]
+          #     The number of text tokens in the input prompt.
         end
       end
     end

data/lib/openai/models/image_gen_partial_image_event.rb

@@ -52,26 +52,31 @@ module OpenAI
       required :type, const: :"image_generation.partial_image"
 
       # @!method initialize(b64_json:, background:, created_at:, output_format:, partial_image_index:, quality:, size:, type: :"image_generation.partial_image")
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ImageGenPartialImageEvent} for more details.
-      #
       #   Emitted when a partial image is available during image generation streaming.
       #
-      #   @param b64_json [String] Base64-encoded partial image data, suitable for rendering as an image.
+      #   @param b64_json [String]
+      #     Base64-encoded partial image data, suitable for rendering as an image.
       #
-      #   @param background [Symbol, OpenAI::Models::ImageGenPartialImageEvent::Background] The background setting for the requested image.
+      #   @param background [Symbol, OpenAI::Models::ImageGenPartialImageEvent::Background]
+      #     The background setting for the requested image.
       #
-      #   @param created_at [Integer] The Unix timestamp when the event was created.
+      #   @param created_at [Integer]
+      #     The Unix timestamp when the event was created.
       #
-      #   @param output_format [Symbol, OpenAI::Models::ImageGenPartialImageEvent::OutputFormat] The output format for the requested image.
+      #   @param output_format [Symbol, OpenAI::Models::ImageGenPartialImageEvent::OutputFormat]
+      #     The output format for the requested image.
       #
-      #   @param partial_image_index [Integer] 0-based index for the partial image (streaming).
+      #   @param partial_image_index [Integer]
+      #     0-based index for the partial image (streaming).
       #
-      #   @param quality [Symbol, OpenAI::Models::ImageGenPartialImageEvent::Quality] The quality setting for the requested image.
+      #   @param quality [Symbol, OpenAI::Models::ImageGenPartialImageEvent::Quality]
+      #     The quality setting for the requested image.
       #
-      #   @param size [String, Symbol, OpenAI::Models::ImageGenPartialImageEvent::Size] The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+      #   @param size [String, Symbol, OpenAI::Models::ImageGenPartialImageEvent::Size]
+      #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       #
-      #   @param type [Symbol, :"image_generation.partial_image"] The type of the event. Always `image_generation.partial_image`.
+      #   @param type [Symbol, :"image_generation.partial_image"]
+      #     The type of the event. Always `image_generation.partial_image`.
 
       # The background setting for the requested image.
       #

data/lib/openai/models/image_generate_params.rb

@@ -135,40 +135,103 @@ module OpenAI
       # @!attribute user
       #   A unique identifier representing your end-user, which can help OpenAI to monitor
       #   and detect abuse.
-      #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+      #   [Learn more](https://developers.openai.com/api/docs/guides/safety-best-practices#implement-safety-identifiers).
       #
       #   @return [String, nil]
       optional :user, String
 
       # @!method initialize(prompt:, background: nil, model: nil, moderation: nil, n: nil, output_compression: nil, output_format: nil, partial_images: nil, quality: nil, response_format: nil, size: nil, style: nil, user: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ImageGenerateParams} for more details.
-      #
-      #   @param prompt [String] A text description of the desired image(s). The maximum length is 32000 characte
-      #
-      #   @param background [Symbol, OpenAI::Models::ImageGenerateParams::Background, nil] Allows to set transparency for the background of the generated image(s). Must
-      #
-      #   @param model [String, Symbol, OpenAI::Models::ImageModel, nil] The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT i
-      #
-      #   @param moderation [Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil] Control the content-moderation level for images generated by the GPT image model
-      #
-      #   @param n [Integer, nil] The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
-      #
-      #   @param output_compression [Integer, nil] The compression level (0-100%) for the generated images. This parameter is only
-      #
-      #   @param output_format [Symbol, OpenAI::Models::ImageGenerateParams::OutputFormat, nil] The format in which the generated images are returned. This parameter is only su
-      #
-      #   @param partial_images [Integer, nil] The number of partial images to generate. This parameter is used for
-      #
-      #   @param quality [Symbol, OpenAI::Models::ImageGenerateParams::Quality, nil] The quality of the image that will be generated.
-      #
-      #   @param response_format [Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil] The format in which generated images with `dall-e-2` and `dall-e-3` are returned
-      #
-      #   @param size [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil] The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`, `
-      #
-      #   @param style [Symbol, OpenAI::Models::ImageGenerateParams::Style, nil] The style of the generated images. This parameter is only supported for `dall-e-
-      #
-      #   @param user [String] A unique identifier representing your end-user, which can help OpenAI to monitor
+      #   @param prompt [String]
+      #     A text description of the desired image(s). The maximum length is 32000
+      #     characters for the GPT image models, 1000 characters for `dall-e-2` and 4000
+      #     characters for `dall-e-3`.
+      #
+      #   @param background [Symbol, OpenAI::Models::ImageGenerateParams::Background, nil]
+      #     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 model [String, Symbol, OpenAI::Models::ImageModel, nil]
+      #     The model to use for image generation. One of `dall-e-2`, `dall-e-3`, 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`). Defaults to `dall-e-2` unless a parameter
+      #     specific to the GPT image models is used.
+      #
+      #   @param moderation [Symbol, OpenAI::Models::ImageGenerateParams::Moderation, nil]
+      #     Control the content-moderation level for images generated by the GPT image
+      #     models. Must be either `low` for less restrictive filtering or `auto` (default
+      #     value).
+      #
+      #   @param n [Integer, nil]
+      #     The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
+      #     `n=1` is supported.
+      #
+      #   @param output_compression [Integer, nil]
+      #     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 [Symbol, OpenAI::Models::ImageGenerateParams::OutputFormat, nil]
+      #     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`.
+      #
+      #   @param partial_images [Integer, nil]
+      #     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 [Symbol, OpenAI::Models::ImageGenerateParams::Quality, nil]
+      #     The quality of the image that will be generated.
+      #
+      #     - `auto` (default value) will automatically select the best quality for the
+      #       given model.
+      #     - `high`, `medium` and `low` are supported for the GPT image models.
+      #     - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
+      #       `2026-09-08` snapshots, also support `xhigh` and `max`.
+      #     - `hd` and `standard` are supported for `dall-e-3`.
+      #     - `standard` is the only option for `dall-e-2`.
+      #
+      #   @param response_format [Symbol, OpenAI::Models::ImageGenerateParams::ResponseFormat, nil]
+      #     The format in which generated images with `dall-e-2` and `dall-e-3` 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 isn't supported for the GPT
+      #     image models, which always return base64-encoded images.
+      #
+      #   @param size [String, Symbol, OpenAI::Models::ImageGenerateParams::Size, nil]
+      #     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 style [Symbol, OpenAI::Models::ImageGenerateParams::Style, nil]
+      #     The style of the generated images. This parameter is only supported for
+      #     `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean
+      #     towards generating hyper-real and dramatic images. Natural causes the model to
+      #     produce more natural, less hyper-real looking images.
+      #
+      #   @param 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).
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/openai/models/image_input_reference_param.rb

@@ -17,7 +17,8 @@ module OpenAI
       # @!method initialize(file_id: nil, image_url: nil)
       #   @param file_id [String]
       #
-      #   @param image_url [String] A fully qualified URL or base64-encoded data URL.
+      #   @param image_url [String]
+      #     A fully qualified URL or base64-encoded data URL.
     end
   end
 end

data/lib/openai/models/images_response.rb

@@ -49,24 +49,30 @@ module OpenAI
       optional :usage, -> { OpenAI::ImagesResponse::Usage }
 
       # @!method initialize(created:, background: nil, data: nil, output_format: nil, quality: nil, size: nil, usage: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ImagesResponse} for more details.
-      #
       #   The response from the image generation endpoint.
       #
-      #   @param created [Integer] The Unix timestamp (in seconds) of when the image was created.
+      #   @param created [Integer]
+      #     The Unix timestamp (in seconds) of when the image was created.
       #
-      #   @param background [Symbol, OpenAI::Models::ImagesResponse::Background] The background parameter used for the image generation. Either `transparent` or
+      #   @param background [Symbol, OpenAI::Models::ImagesResponse::Background]
+      #     The background parameter used for the image generation. Either `transparent` or
+      #     `opaque`.
       #
-      #   @param data [Array<OpenAI::Models::Image>] The list of generated images.
+      #   @param data [Array<OpenAI::Models::Image>]
+      #     The list of generated images.
       #
-      #   @param output_format [Symbol, OpenAI::Models::ImagesResponse::OutputFormat] The output format of the image generation. Either `png`, `webp`, or `jpeg`.
+      #   @param output_format [Symbol, OpenAI::Models::ImagesResponse::OutputFormat]
+      #     The output format of the image generation. Either `png`, `webp`, or `jpeg`.
       #
-      #   @param quality [Symbol, OpenAI::Models::ImagesResponse::Quality] The quality of the image generated. One of `low`, `medium`, `high`, `xhigh`, or
+      #   @param quality [Symbol, OpenAI::Models::ImagesResponse::Quality]
+      #     The quality of the image generated. One of `low`, `medium`, `high`, `xhigh`, or
+      #     `max`.
       #
-      #   @param size [String, Symbol, OpenAI::Models::ImagesResponse::Size] The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+      #   @param size [String, Symbol, OpenAI::Models::ImagesResponse::Size]
+      #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
       #
-      #   @param usage [OpenAI::Models::ImagesResponse::Usage] For `gpt-image-1` only, the token usage information for the image generation.
+      #   @param usage [OpenAI::Models::ImagesResponse::Usage]
+      #     For `gpt-image-1` only, the token usage information for the image generation.
 
       # The background parameter used for the image generation. Either `transparent` or
       # `opaque`.
@@ -184,15 +190,20 @@ module OpenAI
         # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, total_tokens:, output_tokens_details: nil)
         #   For `gpt-image-1` only, the token usage information for the image generation.
         #
-        #   @param input_tokens [Integer] The number of tokens (images and text) in the input prompt.
+        #   @param input_tokens [Integer]
+        #     The number of tokens (images and text) in the input prompt.
         #
-        #   @param input_tokens_details [OpenAI::Models::ImagesResponse::Usage::InputTokensDetails] The input tokens detailed information for the image generation.
+        #   @param input_tokens_details [OpenAI::Models::ImagesResponse::Usage::InputTokensDetails]
+        #     The input tokens detailed information for the image generation.
         #
-        #   @param output_tokens [Integer] The number of output tokens generated by the model.
+        #   @param output_tokens [Integer]
+        #     The number of output tokens generated by the model.
         #
-        #   @param total_tokens [Integer] The total number of tokens (images and text) used for the image generation.
+        #   @param total_tokens [Integer]
+        #     The total number of tokens (images and text) used for the image generation.
         #
-        #   @param output_tokens_details [OpenAI::Models::ImagesResponse::Usage::OutputTokensDetails] The output token details for the image generation.
+        #   @param output_tokens_details [OpenAI::Models::ImagesResponse::Usage::OutputTokensDetails]
+        #     The output token details for the image generation.
 
         # @see OpenAI::Models::ImagesResponse::Usage#input_tokens_details
         class InputTokensDetails < OpenAI::Internal::Type::BaseModel
@@ -211,9 +222,11 @@ module OpenAI
           # @!method initialize(image_tokens:, text_tokens:)
           #   The input tokens detailed information for the image generation.
           #
-          #   @param image_tokens [Integer] The number of image tokens in the input prompt.
+          #   @param image_tokens [Integer]
+          #     The number of image tokens in the input prompt.
           #
-          #   @param text_tokens [Integer] The number of text tokens in the input prompt.
+          #   @param text_tokens [Integer]
+          #     The number of text tokens in the input prompt.
         end
 
         # @see OpenAI::Models::ImagesResponse::Usage#output_tokens_details
@@ -233,9 +246,11 @@ module OpenAI
           # @!method initialize(image_tokens:, text_tokens:)
           #   The output token details for the image generation.
           #
-          #   @param image_tokens [Integer] The number of image output tokens generated by the model.
+          #   @param image_tokens [Integer]
+          #     The number of image output tokens generated by the model.
           #
-          #   @param text_tokens [Integer] The number of text output tokens generated by the model.
+          #   @param text_tokens [Integer]
+          #     The number of text output tokens generated by the model.
         end
       end
     end

data/lib/openai/models/live/audio_format.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      # Audio encoding and sample rate for audio sent and received over a Live WebSocket
+      # connection. WebRTC and SIP negotiate their media format separately.
+      module AudioFormat
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Raw, mono 16-bit little-endian PCM audio for a Live WebSocket connection.
+        variant :"audio/pcm", -> { OpenAI::Live::AudioFormat::AudioPCM }
+
+        # Raw, mono G.711 μ-law audio for a Live WebSocket connection.
+        variant :"audio/pcmu", -> { OpenAI::Live::AudioFormat::AudioPCMU }
+
+        # Raw, mono G.711 A-law audio for a Live WebSocket connection.
+        variant :"audio/pcma", -> { OpenAI::Live::AudioFormat::AudioPCMA }
+
+        class AudioPCM < OpenAI::Internal::Type::BaseModel
+          # @!attribute rate
+          #   Audio sample rate in hertz. Live WebSocket PCM audio supports 16000 or 24000 Hz.
+          #
+          #   @return [Integer, OpenAI::Models::Live::AudioFormat::AudioPCM::Rate]
+          required :rate, enum: -> { OpenAI::Live::AudioFormat::AudioPCM::Rate }
+
+          # @!attribute type
+          #   The audio encoding. Always `audio/pcm`.
+          #
+          #   @return [Symbol, :"audio/pcm"]
+          required :type, const: :"audio/pcm"
+
+          # @!method initialize(rate:, type: :"audio/pcm")
+          #   Raw, mono 16-bit little-endian PCM audio for a Live WebSocket connection.
+          #
+          #   @param rate [Integer, OpenAI::Models::Live::AudioFormat::AudioPCM::Rate]
+          #     Audio sample rate in hertz. Live WebSocket PCM audio supports 16000 or 24000 Hz.
+          #
+          #   @param type [Symbol, :"audio/pcm"]
+          #     The audio encoding. Always `audio/pcm`.
+
+          # Audio sample rate in hertz. Live WebSocket PCM audio supports 16000 or 24000 Hz.
+          #
+          # @see OpenAI::Models::Live::AudioFormat::AudioPCM#rate
+          module Rate
+            extend OpenAI::Internal::Type::Enum
+
+            RATE_16000 = 16_000
+            RATE_24000 = 24_000
+
+            # @!method self.values
+            #   @return [Array<Integer>]
+          end
+        end
+
+        class AudioPCMU < OpenAI::Internal::Type::BaseModel
+          # @!attribute rate
+          #   Audio sample rate in hertz. G.711 audio uses 8000 Hz.
+          #
+          #   @return [Integer]
+          required :rate, Integer
+
+          # @!attribute type
+          #   The audio encoding. Always `audio/pcmu`.
+          #
+          #   @return [Symbol, :"audio/pcmu"]
+          required :type, const: :"audio/pcmu"
+
+          # @!method initialize(rate:, type: :"audio/pcmu")
+          #   Raw, mono G.711 μ-law audio for a Live WebSocket connection.
+          #
+          #   @param rate [Integer]
+          #     Audio sample rate in hertz. G.711 audio uses 8000 Hz.
+          #
+          #   @param type [Symbol, :"audio/pcmu"]
+          #     The audio encoding. Always `audio/pcmu`.
+        end
+
+        class AudioPCMA < OpenAI::Internal::Type::BaseModel
+          # @!attribute rate
+          #   Audio sample rate in hertz. G.711 audio uses 8000 Hz.
+          #
+          #   @return [Integer]
+          required :rate, Integer
+
+          # @!attribute type
+          #   The audio encoding. Always `audio/pcma`.
+          #
+          #   @return [Symbol, :"audio/pcma"]
+          required :type, const: :"audio/pcma"
+
+          # @!method initialize(rate:, type: :"audio/pcma")
+          #   Raw, mono G.711 A-law audio for a Live WebSocket connection.
+          #
+          #   @param rate [Integer]
+          #     Audio sample rate in hertz. G.711 audio uses 8000 Hz.
+          #
+          #   @param type [Symbol, :"audio/pcma"]
+          #     The audio encoding. Always `audio/pcma`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Live::AudioFormat::AudioPCM, OpenAI::Models::Live::AudioFormat::AudioPCMU, OpenAI::Models::Live::AudioFormat::AudioPCMA)]
+      end
+    end
+  end
+end

data/lib/openai/models/live/built_in_voice.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      # A built-in voice available for Live speech.
+      module BuiltInVoice
+        extend OpenAI::Internal::Type::Enum
+
+        ALLOY = :alloy
+        ASH = :ash
+        BALLAD = :ballad
+        BEACON = :beacon
+        BOSSA = :bossa
+        CEDAR = :cedar
+        CINDER = :cinder
+        CORAL = :coral
+        DELTA = :delta
+        ECHO = :echo
+        GLEAM = :gleam
+        MARIN = :marin
+        MERIDIAN = :meridian
+        QUARTZ = :quartz
+        RIPPLE = :ripple
+        SAGE = :sage
+        SHIMMER = :shimmer
+        STONE = :stone
+        TEMPO = :tempo
+        VERSE = :verse
+        VESPER = :vesper
+        WILLOW = :willow
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/openai/models/live/client_config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class ClientConfig < OpenAI::Internal::Type::BaseModel
+        # @!attribute data_channel
+        #   Client and server event permissions for the WebRTC frontend data channel.
+        #
+        #   @return [OpenAI::Models::Live::DataChannelConfig]
+        required :data_channel, -> { OpenAI::Live::DataChannelConfig }
+
+        # @!method initialize(data_channel:)
+        #   Startup-only capabilities for an untrusted frontend attached to a unified WebRTC
+        #   session. Trusted sideband connections are unaffected.
+        #
+        #   @param data_channel [OpenAI::Models::Live::DataChannelConfig]
+        #     Client and server event permissions for the WebRTC frontend data channel.
+      end
+    end
+  end
+end

data/lib/openai/models/live/client_delegation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class ClientDelegation < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The delegation owner. Always `client` for tasks handled by your application.
+        #
+        #   @return [Symbol, :client]
+        required :type, const: :client
+
+        # @!method initialize(type: :client)
+        #   Delegate tasks to your application. The Live session emits delegation events
+        #   that your backend handles.
+        #
+        #   @param type [Symbol, :client]
+        #     The delegation owner. Always `client` for tasks handled by your application.
+      end
+    end
+  end
+end

data/lib/openai/models/live/client_event.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      # Client events for Live. Initialize a primary WebSocket with session.start and
+      # wait for session.started. WebRTC creation already starts the session. Audio
+      # append is primary WebSocket-only. See the
+      # [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting)
+      # before writing frontend instructions and delegation policies.
+      module ClientEvent
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Start a Live session on a primary WebSocket. Send this event before other commands and wait for `session.started`.
+        variant :"session.start", -> { OpenAI::Live::SessionStartEvent }
+
+        # Update the delegation settings of an active Live session. The server acknowledges accepted changes with `session.updated`.
+        variant :"session.update", -> { OpenAI::Live::SessionUpdateEvent }
+
+        # Send audio to a Live session over its primary WebSocket. WebRTC and SIP sessions send audio over their media transport.
+        variant :"session.input_audio.append", -> { OpenAI::Live::InputAudioAppendEvent }
+
+        # Mute audio input to the Live model without closing the session. The server acknowledges with `session.input_audio.muted`.
+        variant :"session.input_audio.mute", -> { OpenAI::Live::InputAudioMuteEvent }
+
+        # Resume audio input to a Live model after muting it. The server acknowledges with `session.input_audio.unmuted`.
+        variant :"session.input_audio.unmute", -> { OpenAI::Live::InputAudioUnmuteEvent }
+
+        # Append instructions to the Live conversation while it is running, optionally associating them with an existing client delegation.
+        variant :"session.instructions.append", -> { OpenAI::Live::InstructionsAppendEvent }
+
+        # Provide silent reasoning or progress context to the Live model, optionally for an existing client delegation.
+        variant :"session.thinking.append", -> { OpenAI::Live::ThinkingAppendEvent }
+
+        # Provide context the Live model can communicate to the user, optionally for an existing client delegation.
+        variant :"session.commentary.append", -> { OpenAI::Live::CommentaryAppendEvent }
+
+        # Add an input item to the Live session’s Responses backend. Requires Responses delegation; use `response.create` to request a response.
+        variant :"response.item.create", -> { OpenAI::Live::ResponseItemCreateEvent }
+
+        # Request a response from the Live session’s Responses backend, or continue a delegated response waiting for tool results. Requires Responses delegation.
+        variant :"response.create", -> { OpenAI::Live::ResponseCreateEvent }
+
+        # Request that the Live session close. The terminal `session.closed` event contains the close reason and final usage.
+        variant :"session.close", -> { OpenAI::Live::SessionCloseEvent }
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Live::SessionStartEvent, OpenAI::Models::Live::SessionUpdateEvent, OpenAI::Models::Live::InputAudioAppendEvent, OpenAI::Models::Live::InputAudioMuteEvent, OpenAI::Models::Live::InputAudioUnmuteEvent, OpenAI::Models::Live::InstructionsAppendEvent, OpenAI::Models::Live::ThinkingAppendEvent, OpenAI::Models::Live::CommentaryAppendEvent, OpenAI::Models::Live::ResponseItemCreateEvent, OpenAI::Models::Live::ResponseCreateEvent, OpenAI::Models::Live::SessionCloseEvent)]
+      end
+    end
+  end
+end