openai 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c6dd691067d679cc3e1fb922b6187850c4857704511bd48f6a0b182f212e72d
-  data.tar.gz: a885e6d50f931ab851dddb2f592f3d0e3a93eaefc985ae55c9962f6ea724e2ca
+  metadata.gz: 6b599800794abd03ec5996e03446e1a0d64629ff4bc2d69faafe3dfc3a725a92
+  data.tar.gz: e5e53b68d6e78af2b37c5703c7d5b9772aa7a3a7150f9f106c3cb03a4621ac54
 SHA512:
-  metadata.gz: 8673a1b9933ba901c41811123d34d73217344d1589e2d4d4f2741cc7cf0732d6843ba387e27edffa9b60fdfbee032bdb839ce97f2c849032181432b86c021e31
-  data.tar.gz: a20ea6be9a122f849567e0e0f734f188f950b302acc1494dc15d302deb6874f8be0032758bae5ecd49aae84b5d98a347f0d05b9e05d1971abb03d237142758a4
+  metadata.gz: 17843501e1e36fb5befd7173af249ead0fd13ec4343f73b82fbc8e7b7974016218f9ca59f7107553111dddf1bb921cf4dffa3db339737bba7a2ae27b06716981
+  data.tar.gz: 7ca24e963309b62ea68ab018592875fe663c7818153a666101295731834be2b1eb473bc0ac2f016cf0ca341935f428d9c6ce8dc881ff8d17da8853d22eed91df

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.21.0 (2025-09-02)
+
+Full Changelog: [v0.20.0...v0.21.0](https://github.com/openai/openai-ruby/compare/v0.20.0...v0.21.0)
+
+### Features
+
+* **api:** realtime API updates ([a8ab6ab](https://github.com/openai/openai-ruby/commit/a8ab6ab5995d7a10b336e8987101d0135e161359))
+
+
+### Bug Fixes
+
+* correctly raise errors encountered during streaming ([766c6c6](https://github.com/openai/openai-ruby/commit/766c6c65c7d27f853ca6cd3ebc4d0ad6385c5924))
+
 ## 0.20.0 (2025-08-26)
 
 Full Changelog: [v0.19.0...v0.20.0](https://github.com/openai/openai-ruby/compare/v0.19.0...v0.20.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openai", "~> 0.20.0"
+gem "openai", "~> 0.21.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/openai/client.rb

@@ -75,6 +75,9 @@ module OpenAI
     # @return [OpenAI::Resources::Responses]
     attr_reader :responses
 
+    # @return [OpenAI::Resources::Realtime]
+    attr_reader :realtime
+
     # @return [OpenAI::Resources::Conversations]
     attr_reader :conversations
 
@@ -163,6 +166,7 @@ module OpenAI
       @batches = OpenAI::Resources::Batches.new(client: self)
       @uploads = OpenAI::Resources::Uploads.new(client: self)
       @responses = OpenAI::Resources::Responses.new(client: self)
+      @realtime = OpenAI::Resources::Realtime.new(client: self)
       @conversations = OpenAI::Resources::Conversations.new(client: self)
       @evals = OpenAI::Resources::Evals.new(client: self)
       @containers = OpenAI::Resources::Containers.new(client: self)

data/lib/openai/internal/stream.rb

@@ -38,14 +38,15 @@ module OpenAI
                   else
                     "An error occurred during streaming"
                   end
-                OpenAI::Errors::APIError.for(
+                err = OpenAI::Errors::APIError.for(
                   url: @url,
                   status: @status,
-                  body: body,
+                  body: data,
                   request: nil,
                   response: @response,
                   message: message
                 )
+                raise err
               in decoded
                 unwrapped = OpenAI::Internal::Util.dig(decoded, @unwrap)
                 y << OpenAI::Internal::Type::Converter.coerce(@model, unwrapped)

data/lib/openai/models/audio/speech_create_params.rb

@@ -117,6 +117,10 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::VERSE }
 
+          variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::MARIN }
+
+          variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::CEDAR }
+
           # @!method self.variants
           #   @return [Array(String, Symbol)]
 
@@ -134,6 +138,8 @@ module OpenAI
           SAGE = :sage
           SHIMMER = :shimmer
           VERSE = :verse
+          MARIN = :marin
+          CEDAR = :cedar
 
           # @!endgroup
         end

data/lib/openai/models/chat/chat_completion_audio_param.rb

@@ -73,6 +73,10 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::VERSE }
 
+          variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::MARIN }
+
+          variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::CEDAR }
+
           # @!method self.variants
           #   @return [Array(String, Symbol)]
 
@@ -90,6 +94,8 @@ module OpenAI
           SAGE = :sage
           SHIMMER = :shimmer
           VERSE = :verse
+          MARIN = :marin
+          CEDAR = :cedar
 
           # @!endgroup
         end

data/lib/openai/models/evals/run_cancel_response.rb

@@ -686,7 +686,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
               # @!attribute top_p
@@ -708,7 +708,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
 

data/lib/openai/models/evals/run_create_params.rb

@@ -614,7 +614,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
               # @!attribute top_p
@@ -636,7 +636,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
 

data/lib/openai/models/evals/run_create_response.rb

@@ -686,7 +686,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
               # @!attribute top_p
@@ -708,7 +708,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
 

data/lib/openai/models/evals/run_list_response.rb

@@ -685,7 +685,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
               # @!attribute top_p
@@ -707,7 +707,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
 

data/lib/openai/models/evals/run_retrieve_response.rb

@@ -690,7 +690,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
               # @!attribute top_p
@@ -712,7 +712,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::Tool::WebSearchTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
 

data/lib/openai/models/realtime/client_secret_create_params.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      # @see OpenAI::Resources::Realtime::ClientSecrets#create
+      class ClientSecretCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute expires_after
+        #   Configuration for the ephemeral token expiration.
+        #
+        #   @return [OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter, nil]
+        optional :expires_after, -> { OpenAI::Realtime::ClientSecretCreateParams::ExpiresAfter }
+
+        # @!attribute session
+        #   Session configuration to use for the client secret. Choose either a realtime
+        #   session or a transcription session.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest, nil]
+        optional :session, union: -> { OpenAI::Realtime::ClientSecretCreateParams::Session }
+
+        # @!method initialize(expires_after: nil, session: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::ClientSecretCreateParams} for more details.
+        #
+        #   @param expires_after [OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter] Configuration for the ephemeral token expiration.
+        #
+        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest] Session configuration to use for the client secret. Choose either a realtime
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+        class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+          # @!attribute anchor
+          #   The anchor point for the ephemeral token expiration. Only `created_at` is
+          #   currently supported.
+          #
+          #   @return [Symbol, OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter::Anchor, nil]
+          optional :anchor, enum: -> { OpenAI::Realtime::ClientSecretCreateParams::ExpiresAfter::Anchor }
+
+          # @!attribute seconds
+          #   The number of seconds from the anchor point to the expiration. Select a value
+          #   between `10` and `7200`.
+          #
+          #   @return [Integer, nil]
+          optional :seconds, Integer
+
+          # @!method initialize(anchor: nil, seconds: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter} for more
+          #   details.
+          #
+          #   Configuration for the ephemeral token expiration.
+          #
+          #   @param anchor [Symbol, OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter::Anchor] The anchor point for the ephemeral token expiration. Only `created_at` is curren
+          #
+          #   @param seconds [Integer] The number of seconds from the anchor point to the expiration. Select a value be
+
+          # The anchor point for the ephemeral token expiration. Only `created_at` is
+          # currently supported.
+          #
+          # @see OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter#anchor
+          module Anchor
+            extend OpenAI::Internal::Type::Enum
+
+            CREATED_AT = :created_at
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Session configuration to use for the client secret. Choose either a realtime
+        # session or a transcription session.
+        module Session
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # Realtime session object configuration.
+          variant :realtime, -> { OpenAI::Realtime::RealtimeSessionCreateRequest }
+
+          # Realtime transcription session object configuration.
+          variant :transcription, -> { OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest }
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest)]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/client_secret_create_response.rb

@@ -0,0 +1,300 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      # @see OpenAI::Resources::Realtime::ClientSecrets#create
+      class ClientSecretCreateResponse < OpenAI::Internal::Type::BaseModel
+        # @!attribute expires_at
+        #   Expiration timestamp for the client secret, in seconds since epoch.
+        #
+        #   @return [Integer]
+        required :expires_at, Integer
+
+        # @!attribute session
+        #   The session configuration for either a realtime or transcription session.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeSessionCreateResponse, OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse]
+        required :session, union: -> { OpenAI::Models::Realtime::ClientSecretCreateResponse::Session }
+
+        # @!attribute value
+        #   The generated client secret value.
+        #
+        #   @return [String]
+        required :value, String
+
+        # @!method initialize(expires_at:, session:, value:)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::ClientSecretCreateResponse} for more details.
+        #
+        #   Response from creating a session and client secret for the Realtime API.
+        #
+        #   @param expires_at [Integer] Expiration timestamp for the client secret, in seconds since epoch.
+        #
+        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateResponse, OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse] The session configuration for either a realtime or transcription session.
+        #
+        #   @param value [String] The generated client secret value.
+
+        # The session configuration for either a realtime or transcription session.
+        #
+        # @see OpenAI::Models::Realtime::ClientSecretCreateResponse#session
+        module Session
+          extend OpenAI::Internal::Type::Union
+
+          # A Realtime session configuration object.
+          variant -> { OpenAI::Realtime::RealtimeSessionCreateResponse }
+
+          # A Realtime transcription session configuration object.
+          variant -> { OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse }
+
+          class RealtimeTranscriptionSessionCreateResponse < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   Unique identifier for the session that looks like `sess_1234567890abcdef`.
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute audio
+            #   Configuration for input audio for the session.
+            #
+            #   @return [OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio, nil]
+            optional :audio,
+                     -> { OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio }
+
+            # @!attribute expires_at
+            #   Expiration timestamp for the session, in seconds since epoch.
+            #
+            #   @return [Integer, nil]
+            optional :expires_at, Integer
+
+            # @!attribute include
+            #   Additional fields to include in server outputs.
+            #
+            #   - `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+            #     transcription.
+            #
+            #   @return [Array<Symbol, OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Include>, nil]
+            optional :include,
+                     -> do
+                       OpenAI::Internal::Type::ArrayOf[
+                         enum: OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Include
+                       ]
+                     end
+
+            # @!attribute object
+            #   The object type. Always `realtime.transcription_session`.
+            #
+            #   @return [String, nil]
+            optional :object, String
+
+            # @!method initialize(id: nil, audio: nil, expires_at: nil, include: nil, object: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse}
+            #   for more details.
+            #
+            #   A Realtime transcription session configuration object.
+            #
+            #   @param id [String] Unique identifier for the session that looks like `sess_1234567890abcdef`.
+            #
+            #   @param audio [OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio] Configuration for input audio for the session.
+            #
+            #   @param expires_at [Integer] Expiration timestamp for the session, in seconds since epoch.
+            #
+            #   @param include [Array<Symbol, OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Include>] Additional fields to include in server outputs.
+            #
+            #   @param object [String] The object type. Always `realtime.transcription_session`.
+
+            # @see OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse#audio
+            class Audio < OpenAI::Internal::Type::BaseModel
+              # @!attribute input
+              #
+              #   @return [OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input, nil]
+              optional :input,
+                       -> { OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input }
+
+              # @!method initialize(input: nil)
+              #   Configuration for input audio for the session.
+              #
+              #   @param input [OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input]
+
+              # @see OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio#input
+              class Input < OpenAI::Internal::Type::BaseModel
+                # @!attribute format_
+                #   The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
+                #
+                #   @return [String, nil]
+                optional :format_, String, api_name: :format
+
+                # @!attribute noise_reduction
+                #   Configuration for input audio noise reduction.
+                #
+                #   @return [OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction, nil]
+                optional :noise_reduction,
+                         -> { OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction }
+
+                # @!attribute transcription
+                #   Configuration of the transcription model.
+                #
+                #   @return [OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::Transcription, nil]
+                optional :transcription,
+                         -> { OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::Transcription }
+
+                # @!attribute turn_detection
+                #   Configuration for turn detection.
+                #
+                #   @return [OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::TurnDetection, nil]
+                optional :turn_detection,
+                         -> { OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::TurnDetection }
+
+                # @!method initialize(format_: nil, noise_reduction: nil, transcription: nil, turn_detection: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input}
+                #   for more details.
+                #
+                #   @param format_ [String] The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
+                #
+                #   @param noise_reduction [OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction] Configuration for input audio noise reduction.
+                #
+                #   @param transcription [OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::Transcription] Configuration of the transcription model.
+                #
+                #   @param turn_detection [OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::TurnDetection] Configuration for turn detection.
+
+                # @see OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input#noise_reduction
+                class NoiseReduction < OpenAI::Internal::Type::BaseModel
+                  # @!attribute type
+                  #
+                  #   @return [Symbol, OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction::Type, nil]
+                  optional :type,
+                           enum: -> { OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction::Type }
+
+                  # @!method initialize(type: nil)
+                  #   Configuration for input audio noise reduction.
+                  #
+                  #   @param type [Symbol, OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction::Type]
+
+                  # @see OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction#type
+                  module Type
+                    extend OpenAI::Internal::Type::Enum
+
+                    NEAR_FIELD = :near_field
+                    FAR_FIELD = :far_field
+
+                    # @!method self.values
+                    #   @return [Array<Symbol>]
+                  end
+                end
+
+                # @see OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input#transcription
+                class Transcription < OpenAI::Internal::Type::BaseModel
+                  # @!attribute language
+                  #   The language of the input audio. Supplying the input language in
+                  #   [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`)
+                  #   format will improve accuracy and latency.
+                  #
+                  #   @return [String, nil]
+                  optional :language, String
+
+                  # @!attribute model
+                  #   The model to use for transcription. Can be `gpt-4o-transcribe`,
+                  #   `gpt-4o-mini-transcribe`, or `whisper-1`.
+                  #
+                  #   @return [Symbol, OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::Transcription::Model, nil]
+                  optional :model,
+                           enum: -> { OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::Transcription::Model }
+
+                  # @!attribute prompt
+                  #   An optional text to guide the model's style or continue a previous audio
+                  #   segment. The
+                  #   [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
+                  #   should match the audio language.
+                  #
+                  #   @return [String, nil]
+                  optional :prompt, String
+
+                  # @!method initialize(language: nil, model: nil, prompt: nil)
+                  #   Some parameter documentations has been truncated, see
+                  #   {OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::Transcription}
+                  #   for more details.
+                  #
+                  #   Configuration of the transcription model.
+                  #
+                  #   @param language [String] The language of the input audio. Supplying the input language in
+                  #
+                  #   @param model [Symbol, OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::Transcription::Model] The model to use for transcription. Can be `gpt-4o-transcribe`, `gpt-4o-mini-tra
+                  #
+                  #   @param prompt [String] An optional text to guide the model's style or continue a previous audio segment
+
+                  # The model to use for transcription. Can be `gpt-4o-transcribe`,
+                  # `gpt-4o-mini-transcribe`, or `whisper-1`.
+                  #
+                  # @see OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::Transcription#model
+                  module Model
+                    extend OpenAI::Internal::Type::Enum
+
+                    GPT_4O_TRANSCRIBE = :"gpt-4o-transcribe"
+                    GPT_4O_MINI_TRANSCRIBE = :"gpt-4o-mini-transcribe"
+                    WHISPER_1 = :"whisper-1"
+
+                    # @!method self.values
+                    #   @return [Array<Symbol>]
+                  end
+                end
+
+                # @see OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input#turn_detection
+                class TurnDetection < OpenAI::Internal::Type::BaseModel
+                  # @!attribute prefix_padding_ms
+                  #
+                  #   @return [Integer, nil]
+                  optional :prefix_padding_ms, Integer
+
+                  # @!attribute silence_duration_ms
+                  #
+                  #   @return [Integer, nil]
+                  optional :silence_duration_ms, Integer
+
+                  # @!attribute threshold
+                  #
+                  #   @return [Float, nil]
+                  optional :threshold, Float
+
+                  # @!attribute type
+                  #   Type of turn detection, only `server_vad` is currently supported.
+                  #
+                  #   @return [String, nil]
+                  optional :type, String
+
+                  # @!method initialize(prefix_padding_ms: nil, silence_duration_ms: nil, threshold: nil, type: nil)
+                  #   Some parameter documentations has been truncated, see
+                  #   {OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse::Audio::Input::TurnDetection}
+                  #   for more details.
+                  #
+                  #   Configuration for turn detection.
+                  #
+                  #   @param prefix_padding_ms [Integer]
+                  #
+                  #   @param silence_duration_ms [Integer]
+                  #
+                  #   @param threshold [Float]
+                  #
+                  #   @param type [String] Type of turn detection, only `server_vad` is currently supported.
+                end
+              end
+            end
+
+            module Include
+              extend OpenAI::Internal::Type::Enum
+
+              ITEM_INPUT_AUDIO_TRANSCRIPTION_LOGPROBS = :"item.input_audio_transcription.logprobs"
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Realtime::RealtimeSessionCreateResponse, OpenAI::Models::Realtime::ClientSecretCreateResponse::Session::RealtimeTranscriptionSessionCreateResponse)]
+        end
+      end
+    end
+  end
+end