openai 0.54.0 → 0.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83d02aadc8a7e6f7b37049c3d9f4aeaea7431550be5d59b39125caac69dc0b8d
-  data.tar.gz: 65952c4730694ec1d6d8e94975574830caaa4b00af59102004c22193eeddd084
+  metadata.gz: 1829322792fdc33445abe86fe08267e3b93d183511e2e1651ef6e1cd81ecc1b8
+  data.tar.gz: 2b9578ceacd8423c77d35e7c3f0e3f7fb9d56bcd971403a83dedf8bb0cb9fa51
 SHA512:
-  metadata.gz: 0cdf744110926dcc10a24efcb6d945f23da0390a72827434ab6b0cd9308e1e5a9f64e6d7f8d304c206c146caf10fc8d06c242c3f6447ed7d052bb60f302f905a
-  data.tar.gz: 5cc663414eead8566eaefb21714a5fad8e1bbaa5ed5f8b297d4af45909b4cc0ea34d96fa273cc85e587f4fa41cc263b0c5b88db67e4c22e24a10cbb48822165b
+  metadata.gz: 6a248621c5aea0ac33ad525d91dfae5e7b9934c18b8e7a172685dade248784c44b7d262ba1575472efdec948be1cc52e4d588845a13a12f2bb87854d196fd095
+  data.tar.gz: 1247752dd4600a775ea0d52f977d360348bf0ade61b5274bcd92a135d5a86db2acaf689feb9cd35e58f33db37d246dee6e37a9e0d2c0b4b704fe46920079312f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.55.0 (2026-03-13)
+
+Full Changelog: [v0.54.0...v0.55.0](https://github.com/openai/openai-ruby/compare/v0.54.0...v0.55.0)
+
+### Features
+
+* **api:** custom voices ([a9f7891](https://github.com/openai/openai-ruby/commit/a9f78916b97e3a59f35dbcac05c725474e6634af))
+
 ## 0.54.0 (2026-03-13)
 
 Full Changelog: [v0.53.0...v0.54.0](https://github.com/openai/openai-ruby/compare/v0.53.0...v0.54.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.54.0"
+gem "openai", "~> 0.55.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -24,11 +24,12 @@ module OpenAI
         # @!attribute voice
         #   The voice to use when generating the audio. Supported built-in voices are
         #   `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
-        #   `shimmer`, `verse`, `marin`, and `cedar`. Previews of the voices are available
-        #   in the
+        #   `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
+        #   object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
+        #   voices are available in the
         #   [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
         #
-        #   @return [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice]
+        #   @return [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice::ID, OpenAI::Models::Audio::SpeechCreateParams::Voice]
         required :voice, union: -> { OpenAI::Audio::SpeechCreateParams::Voice }
 
         # @!attribute instructions
@@ -67,7 +68,7 @@ module OpenAI
         #
         #   @param model [String, Symbol, OpenAI::Models::Audio::SpeechModel] One of the available [TTS models](https://platform.openai.com/docs/models#tts):
         #
-        #   @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice] The voice to use when generating the audio. Supported built-in voices are `alloy
+        #   @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice::ID, OpenAI::Models::Audio::SpeechCreateParams::Voice] The voice to use when generating the audio. Supported built-in voices are `alloy
         #
         #   @param instructions [String] Control the voice of your generated audio with additional instructions. Does not
         #
@@ -95,8 +96,9 @@ module OpenAI
 
         # The voice to use when generating the audio. Supported built-in voices are
         # `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
-        # `shimmer`, `verse`, `marin`, and `cedar`. Previews of the voices are available
-        # in the
+        # `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
+        # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
+        # voices are available in the
         # [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
         module Voice
           extend OpenAI::Internal::Type::Union
@@ -123,11 +125,33 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::CEDAR }
 
+          # Custom voice reference.
+          variant -> { OpenAI::Audio::SpeechCreateParams::Voice::ID }
+
+          class ID < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The custom voice ID, e.g. `voice_1234`.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!method initialize(id:)
+            #   Custom voice reference.
+            #
+            #   @param id [String] The custom voice ID, e.g. `voice_1234`.
+          end
+
           # @!method self.variants
-          #   @return [Array(String, Symbol)]
+          #   @return [Array(String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice::ID)]
 
           define_sorbet_constant!(:Variants) do
-            T.type_alias { T.any(String, OpenAI::Audio::SpeechCreateParams::Voice::TaggedSymbol) }
+            T.type_alias do
+              T.any(
+                String,
+                OpenAI::Audio::SpeechCreateParams::Voice::TaggedSymbol,
+                OpenAI::Audio::SpeechCreateParams::Voice::ID
+              )
+            end
           end
 
           # @!group

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

@@ -14,9 +14,10 @@ module OpenAI
         # @!attribute voice
         #   The voice the model uses to respond. Supported built-in voices are `alloy`,
         #   `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
-        #   `marin`, and `cedar`.
+        #   `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
+        #   for example `{ "id": "voice_1234" }`.
         #
-        #   @return [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice]
+        #   @return [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::ID, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice]
         required :voice, union: -> { OpenAI::Chat::ChatCompletionAudioParam::Voice }
 
         # @!method initialize(format_:, voice:)
@@ -29,7 +30,7 @@ module OpenAI
         #
         #   @param format_ [Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Format] Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`,
         #
-        #   @param voice [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice] The voice the model uses to respond. Supported built-in voices are `alloy`, `ash
+        #   @param voice [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::ID, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice] The voice the model uses to respond. Supported built-in voices are
 
         # Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`,
         # or `pcm16`.
@@ -51,7 +52,8 @@ module OpenAI
 
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
-        # `marin`, and `cedar`.
+        # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
+        # for example `{ "id": "voice_1234" }`.
         #
         # @see OpenAI::Models::Chat::ChatCompletionAudioParam#voice
         module Voice
@@ -79,11 +81,33 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::CEDAR }
 
+          # Custom voice reference.
+          variant -> { OpenAI::Chat::ChatCompletionAudioParam::Voice::ID }
+
+          class ID < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The custom voice ID, e.g. `voice_1234`.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!method initialize(id:)
+            #   Custom voice reference.
+            #
+            #   @param id [String] The custom voice ID, e.g. `voice_1234`.
+          end
+
           # @!method self.variants
-          #   @return [Array(String, Symbol)]
+          #   @return [Array(String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::ID)]
 
           define_sorbet_constant!(:Variants) do
-            T.type_alias { T.any(String, OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol) }
+            T.type_alias do
+              T.any(
+                String,
+                OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol,
+                OpenAI::Chat::ChatCompletionAudioParam::Voice::ID
+              )
+            end
           end
 
           # @!group

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

@@ -25,10 +25,12 @@ module OpenAI
         # @!attribute voice
         #   The voice the model uses to respond. Supported built-in voices are `alloy`,
         #   `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
-        #   `cedar`. Voice cannot be changed during the session once the model has responded
-        #   with audio at least once. We recommend `marin` and `cedar` for best quality.
+        #   `cedar`. You may also provide a custom voice object with an `id`, for example
+        #   `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+        #   model has responded with audio at least once. We recommend `marin` and `cedar`
+        #   for best quality.
         #
-        #   @return [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice, nil]
+        #   @return [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice::ID, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice, nil]
         optional :voice, union: -> { OpenAI::Realtime::RealtimeAudioConfigOutput::Voice }
 
         # @!method initialize(format_: nil, speed: nil, voice: nil)
@@ -39,12 +41,14 @@ module OpenAI
         #
         #   @param speed [Float] The speed of the model's spoken response as a multiple of the original speed.
         #
-        #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice] The voice the model uses to respond. Supported built-in voices are `alloy`, `ash
+        #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice::ID, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice] The voice the model uses to respond. Supported built-in voices are
 
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
-        # `cedar`. Voice cannot be changed during the session once the model has responded
-        # with audio at least once. We recommend `marin` and `cedar` for best quality.
+        # `cedar`. You may also provide a custom voice object with an `id`, for example
+        # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+        # model has responded with audio at least once. We recommend `marin` and `cedar`
+        # for best quality.
         #
         # @see OpenAI::Models::Realtime::RealtimeAudioConfigOutput#voice
         module Voice
@@ -72,11 +76,33 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice::CEDAR }
 
+          # Custom voice reference.
+          variant -> { OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::ID }
+
+          class ID < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The custom voice ID, e.g. `voice_1234`.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!method initialize(id:)
+            #   Custom voice reference.
+            #
+            #   @param id [String] The custom voice ID, e.g. `voice_1234`.
+          end
+
           # @!method self.variants
-          #   @return [Array(String, Symbol)]
+          #   @return [Array(String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice::ID)]
 
           define_sorbet_constant!(:Variants) do
-            T.type_alias { T.any(String, OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::TaggedSymbol) }
+            T.type_alias do
+              T.any(
+                String,
+                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::TaggedSymbol,
+                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::ID
+              )
+            end
           end
 
           # @!group

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

@@ -25,10 +25,12 @@ module OpenAI
           # @!attribute voice
           #   The voice the model uses to respond. Supported built-in voices are `alloy`,
           #   `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
-          #   `cedar`. Voice cannot be changed during the session once the model has responded
-          #   with audio at least once.
+          #   `cedar`. You may also provide a custom voice object with an `id`, for example
+          #   `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+          #   model has responded with audio at least once. We recommend `marin` and `cedar`
+          #   for best quality.
           #
-          #   @return [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice, nil]
+          #   @return [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice, nil]
           optional :voice, union: -> { OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice }
 
           # @!method initialize(format_: nil, voice: nil)
@@ -38,12 +40,14 @@ module OpenAI
           #
           #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA] The format of the output audio.
           #
-          #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice] The voice the model uses to respond. Supported built-in voices are `alloy`, `ash
+          #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice] The voice the model uses to respond. Supported built-in voices are
 
           # The voice the model uses to respond. Supported built-in voices are `alloy`,
           # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
-          # `cedar`. Voice cannot be changed during the session once the model has responded
-          # with audio at least once.
+          # `cedar`. You may also provide a custom voice object with an `id`, for example
+          # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+          # model has responded with audio at least once. We recommend `marin` and `cedar`
+          # for best quality.
           #
           # @see OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output#voice
           module Voice
@@ -71,11 +75,33 @@ module OpenAI
 
             variant const: -> { OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::CEDAR }
 
+            # Custom voice reference.
+            variant -> { OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID }
+
+            class ID < OpenAI::Internal::Type::BaseModel
+              # @!attribute id
+              #   The custom voice ID, e.g. `voice_1234`.
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!method initialize(id:)
+              #   Custom voice reference.
+              #
+              #   @param id [String] The custom voice ID, e.g. `voice_1234`.
+            end
+
             # @!method self.variants
-            #   @return [Array(String, Symbol)]
+            #   @return [Array(String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID)]
 
             define_sorbet_constant!(:Variants) do
-              T.type_alias { T.any(String, OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::TaggedSymbol) }
+              T.type_alias do
+                T.any(
+                  String,
+                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::TaggedSymbol,
+                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID
+                )
+              end
             end
 
             # @!group

data/lib/openai/resources/audio/speech.rb

@@ -18,7 +18,7 @@ module OpenAI
         #
         # @param model [String, Symbol, OpenAI::Models::Audio::SpeechModel] One of the available [TTS models](https://platform.openai.com/docs/models#tts):
         #
-        # @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice] The voice to use when generating the audio. Supported built-in voices are `alloy
+        # @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice::ID, OpenAI::Models::Audio::SpeechCreateParams::Voice] The voice to use when generating the audio. Supported built-in voices are `alloy
         #
         # @param instructions [String] Control the voice of your generated audio with additional instructions. Does not
         #

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.54.0"
+  VERSION = "0.55.0"
 end

data/rbi/openai/models/audio/speech_create_params.rbi

@@ -23,12 +23,17 @@ module OpenAI
 
         # The voice to use when generating the audio. Supported built-in voices are
         # `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
-        # `shimmer`, `verse`, `marin`, and `cedar`. Previews of the voices are available
-        # in the
+        # `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
+        # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
+        # voices are available in the
         # [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
         sig do
           returns(
-            T.any(String, OpenAI::Audio::SpeechCreateParams::Voice::OrSymbol)
+            T.any(
+              String,
+              OpenAI::Audio::SpeechCreateParams::Voice::OrSymbol,
+              OpenAI::Audio::SpeechCreateParams::Voice::ID
+            )
           )
         end
         attr_accessor :voice
@@ -90,7 +95,11 @@ module OpenAI
             input: String,
             model: T.any(String, OpenAI::Audio::SpeechModel::OrSymbol),
             voice:
-              T.any(String, OpenAI::Audio::SpeechCreateParams::Voice::OrSymbol),
+              T.any(
+                String,
+                OpenAI::Audio::SpeechCreateParams::Voice::OrSymbol,
+                OpenAI::Audio::SpeechCreateParams::Voice::ID::OrHash
+              ),
             instructions: String,
             response_format:
               OpenAI::Audio::SpeechCreateParams::ResponseFormat::OrSymbol,
@@ -108,8 +117,9 @@ module OpenAI
           model:,
           # The voice to use when generating the audio. Supported built-in voices are
           # `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
-          # `shimmer`, `verse`, `marin`, and `cedar`. Previews of the voices are available
-          # in the
+          # `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
+          # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
+          # voices are available in the
           # [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
           voice:,
           # Control the voice of your generated audio with additional instructions. Does not
@@ -136,7 +146,8 @@ module OpenAI
               voice:
                 T.any(
                   String,
-                  OpenAI::Audio::SpeechCreateParams::Voice::OrSymbol
+                  OpenAI::Audio::SpeechCreateParams::Voice::OrSymbol,
+                  OpenAI::Audio::SpeechCreateParams::Voice::ID
                 ),
               instructions: String,
               response_format:
@@ -172,8 +183,9 @@ module OpenAI
 
         # The voice to use when generating the audio. Supported built-in voices are
         # `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
-        # `shimmer`, `verse`, `marin`, and `cedar`. Previews of the voices are available
-        # in the
+        # `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
+        # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
+        # voices are available in the
         # [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
         module Voice
           extend OpenAI::Internal::Type::Union
@@ -182,10 +194,37 @@ module OpenAI
             T.type_alias do
               T.any(
                 String,
-                OpenAI::Audio::SpeechCreateParams::Voice::TaggedSymbol
+                OpenAI::Audio::SpeechCreateParams::Voice::TaggedSymbol,
+                OpenAI::Audio::SpeechCreateParams::Voice::ID
               )
             end
 
+          class ID < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Audio::SpeechCreateParams::Voice::ID,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The custom voice ID, e.g. `voice_1234`.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # Custom voice reference.
+            sig { params(id: String).returns(T.attached_class) }
+            def self.new(
+              # The custom voice ID, e.g. `voice_1234`.
+              id:
+            )
+            end
+
+            sig { override.returns({ id: String }) }
+            def to_hash
+            end
+          end
+
           sig do
             override.returns(
               T::Array[OpenAI::Audio::SpeechCreateParams::Voice::Variants]

data/rbi/openai/models/chat/chat_completion_audio_param.rbi

@@ -23,12 +23,14 @@ module OpenAI
 
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
-        # `marin`, and `cedar`.
+        # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
+        # for example `{ "id": "voice_1234" }`.
         sig do
           returns(
             T.any(
               String,
-              OpenAI::Chat::ChatCompletionAudioParam::Voice::OrSymbol
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::OrSymbol,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::ID
             )
           )
         end
@@ -43,7 +45,8 @@ module OpenAI
             voice:
               T.any(
                 String,
-                OpenAI::Chat::ChatCompletionAudioParam::Voice::OrSymbol
+                OpenAI::Chat::ChatCompletionAudioParam::Voice::OrSymbol,
+                OpenAI::Chat::ChatCompletionAudioParam::Voice::ID::OrHash
               )
           ).returns(T.attached_class)
         end
@@ -53,7 +56,8 @@ module OpenAI
           format_:,
           # The voice the model uses to respond. Supported built-in voices are `alloy`,
           # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
-          # `marin`, and `cedar`.
+          # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
+          # for example `{ "id": "voice_1234" }`.
           voice:
         )
         end
@@ -65,7 +69,8 @@ module OpenAI
               voice:
                 T.any(
                   String,
-                  OpenAI::Chat::ChatCompletionAudioParam::Voice::OrSymbol
+                  OpenAI::Chat::ChatCompletionAudioParam::Voice::OrSymbol,
+                  OpenAI::Chat::ChatCompletionAudioParam::Voice::ID
                 )
             }
           )
@@ -128,7 +133,8 @@ module OpenAI
 
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
-        # `marin`, and `cedar`.
+        # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
+        # for example `{ "id": "voice_1234" }`.
         module Voice
           extend OpenAI::Internal::Type::Union
 
@@ -136,10 +142,37 @@ module OpenAI
             T.type_alias do
               T.any(
                 String,
-                OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+                OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol,
+                OpenAI::Chat::ChatCompletionAudioParam::Voice::ID
               )
             end
 
+          class ID < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Chat::ChatCompletionAudioParam::Voice::ID,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The custom voice ID, e.g. `voice_1234`.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # Custom voice reference.
+            sig { params(id: String).returns(T.attached_class) }
+            def self.new(
+              # The custom voice ID, e.g. `voice_1234`.
+              id:
+            )
+            end
+
+            sig { override.returns({ id: String }) }
+            def to_hash
+            end
+          end
+
           sig do
             override.returns(
               T::Array[OpenAI::Chat::ChatCompletionAudioParam::Voice::Variants]

data/rbi/openai/models/realtime/realtime_audio_config_output.rbi

@@ -53,14 +53,17 @@ module OpenAI
 
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
-        # `cedar`. Voice cannot be changed during the session once the model has responded
-        # with audio at least once. We recommend `marin` and `cedar` for best quality.
+        # `cedar`. You may also provide a custom voice object with an `id`, for example
+        # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+        # model has responded with audio at least once. We recommend `marin` and `cedar`
+        # for best quality.
         sig do
           returns(
             T.nilable(
               T.any(
                 String,
-                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::OrSymbol
+                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::OrSymbol,
+                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::ID
               )
             )
           )
@@ -72,7 +75,8 @@ module OpenAI
             voice:
               T.any(
                 String,
-                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::OrSymbol
+                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::OrSymbol,
+                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::ID::OrHash
               )
           ).void
         end
@@ -90,7 +94,8 @@ module OpenAI
             voice:
               T.any(
                 String,
-                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::OrSymbol
+                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::OrSymbol,
+                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::ID::OrHash
               )
           ).returns(T.attached_class)
         end
@@ -107,8 +112,10 @@ module OpenAI
           speed: nil,
           # The voice the model uses to respond. Supported built-in voices are `alloy`,
           # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
-          # `cedar`. Voice cannot be changed during the session once the model has responded
-          # with audio at least once. We recommend `marin` and `cedar` for best quality.
+          # `cedar`. You may also provide a custom voice object with an `id`, for example
+          # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+          # model has responded with audio at least once. We recommend `marin` and `cedar`
+          # for best quality.
           voice: nil
         )
         end
@@ -126,7 +133,8 @@ module OpenAI
               voice:
                 T.any(
                   String,
-                  OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::OrSymbol
+                  OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::OrSymbol,
+                  OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::ID
                 )
             }
           )
@@ -136,8 +144,10 @@ module OpenAI
 
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
-        # `cedar`. Voice cannot be changed during the session once the model has responded
-        # with audio at least once. We recommend `marin` and `cedar` for best quality.
+        # `cedar`. You may also provide a custom voice object with an `id`, for example
+        # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+        # model has responded with audio at least once. We recommend `marin` and `cedar`
+        # for best quality.
         module Voice
           extend OpenAI::Internal::Type::Union
 
@@ -145,10 +155,37 @@ module OpenAI
             T.type_alias do
               T.any(
                 String,
-                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::TaggedSymbol
+                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::TaggedSymbol,
+                OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::ID
               )
             end
 
+          class ID < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::ID,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The custom voice ID, e.g. `voice_1234`.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # Custom voice reference.
+            sig { params(id: String).returns(T.attached_class) }
+            def self.new(
+              # The custom voice ID, e.g. `voice_1234`.
+              id:
+            )
+            end
+
+            sig { override.returns({ id: String }) }
+            def to_hash
+            end
+          end
+
           sig do
             override.returns(
               T::Array[

data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi

@@ -87,14 +87,17 @@ module OpenAI
 
           # The voice the model uses to respond. Supported built-in voices are `alloy`,
           # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
-          # `cedar`. Voice cannot be changed during the session once the model has responded
-          # with audio at least once.
+          # `cedar`. You may also provide a custom voice object with an `id`, for example
+          # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+          # model has responded with audio at least once. We recommend `marin` and `cedar`
+          # for best quality.
           sig do
             returns(
               T.nilable(
                 T.any(
                   String,
-                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::OrSymbol
+                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::OrSymbol,
+                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID
                 )
               )
             )
@@ -106,7 +109,8 @@ module OpenAI
               voice:
                 T.any(
                   String,
-                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::OrSymbol
+                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::OrSymbol,
+                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID::OrHash
                 )
             ).void
           end
@@ -123,7 +127,8 @@ module OpenAI
               voice:
                 T.any(
                   String,
-                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::OrSymbol
+                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::OrSymbol,
+                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID::OrHash
                 )
             ).returns(T.attached_class)
           end
@@ -132,8 +137,10 @@ module OpenAI
             format_: nil,
             # The voice the model uses to respond. Supported built-in voices are `alloy`,
             # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
-            # `cedar`. Voice cannot be changed during the session once the model has responded
-            # with audio at least once.
+            # `cedar`. You may also provide a custom voice object with an `id`, for example
+            # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+            # model has responded with audio at least once. We recommend `marin` and `cedar`
+            # for best quality.
             voice: nil
           )
           end
@@ -150,7 +157,8 @@ module OpenAI
                 voice:
                   T.any(
                     String,
-                    OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::OrSymbol
+                    OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::OrSymbol,
+                    OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID
                   )
               }
             )
@@ -160,8 +168,10 @@ module OpenAI
 
           # The voice the model uses to respond. Supported built-in voices are `alloy`,
           # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
-          # `cedar`. Voice cannot be changed during the session once the model has responded
-          # with audio at least once.
+          # `cedar`. You may also provide a custom voice object with an `id`, for example
+          # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+          # model has responded with audio at least once. We recommend `marin` and `cedar`
+          # for best quality.
           module Voice
             extend OpenAI::Internal::Type::Union
 
@@ -169,10 +179,37 @@ module OpenAI
               T.type_alias do
                 T.any(
                   String,
-                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::TaggedSymbol
+                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::TaggedSymbol,
+                  OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID
                 )
               end
 
+            class ID < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # The custom voice ID, e.g. `voice_1234`.
+              sig { returns(String) }
+              attr_accessor :id
+
+              # Custom voice reference.
+              sig { params(id: String).returns(T.attached_class) }
+              def self.new(
+                # The custom voice ID, e.g. `voice_1234`.
+                id:
+              )
+              end
+
+              sig { override.returns({ id: String }) }
+              def to_hash
+              end
+            end
+
             sig do
               override.returns(
                 T::Array[

data/rbi/openai/resources/audio/speech.rbi

@@ -13,7 +13,11 @@ module OpenAI
             input: String,
             model: T.any(String, OpenAI::Audio::SpeechModel::OrSymbol),
             voice:
-              T.any(String, OpenAI::Audio::SpeechCreateParams::Voice::OrSymbol),
+              T.any(
+                String,
+                OpenAI::Audio::SpeechCreateParams::Voice::OrSymbol,
+                OpenAI::Audio::SpeechCreateParams::Voice::ID::OrHash
+              ),
             instructions: String,
             response_format:
               OpenAI::Audio::SpeechCreateParams::ResponseFormat::OrSymbol,
@@ -31,8 +35,9 @@ module OpenAI
           model:,
           # The voice to use when generating the audio. Supported built-in voices are
           # `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
-          # `shimmer`, `verse`, `marin`, and `cedar`. Previews of the voices are available
-          # in the
+          # `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
+          # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
+          # voices are available in the
           # [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
           voice:,
           # Control the voice of your generated audio with additional instructions. Does not

data/sig/openai/models/audio/speech_create_params.rbs

@@ -85,10 +85,21 @@ module OpenAI
           | :verse
           | :marin
           | :cedar
+          | OpenAI::Audio::SpeechCreateParams::Voice::ID
 
         module Voice
           extend OpenAI::Internal::Type::Union
 
+          type id = { id: String }
+
+          class ID < OpenAI::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            def initialize: (id: String) -> void
+
+            def to_hash: -> { id: String }
+          end
+
           def self?.variants: -> ::Array[OpenAI::Models::Audio::SpeechCreateParams::voice]
 
           ALLOY: :alloy

data/sig/openai/models/chat/chat_completion_audio_param.rbs

@@ -51,10 +51,21 @@ module OpenAI
           | :verse
           | :marin
           | :cedar
+          | OpenAI::Chat::ChatCompletionAudioParam::Voice::ID
 
         module Voice
           extend OpenAI::Internal::Type::Union
 
+          type id = { id: String }
+
+          class ID < OpenAI::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            def initialize: (id: String) -> void
+
+            def to_hash: -> { id: String }
+          end
+
           def self?.variants: -> ::Array[OpenAI::Models::Chat::ChatCompletionAudioParam::voice]
 
           ALLOY: :alloy

data/sig/openai/models/realtime/realtime_audio_config_output.rbs

@@ -49,10 +49,21 @@ module OpenAI
           | :verse
           | :marin
           | :cedar
+          | OpenAI::Realtime::RealtimeAudioConfigOutput::Voice::ID
 
         module Voice
           extend OpenAI::Internal::Type::Union
 
+          type id = { id: String }
+
+          class ID < OpenAI::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            def initialize: (id: String) -> void
+
+            def to_hash: -> { id: String }
+          end
+
           def self?.variants: -> ::Array[OpenAI::Models::Realtime::RealtimeAudioConfigOutput::voice]
 
           ALLOY: :alloy

data/sig/openai/models/realtime/realtime_response_create_audio_output.rbs

@@ -60,10 +60,21 @@ module OpenAI
             | :verse
             | :marin
             | :cedar
+            | OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice::ID
 
           module Voice
             extend OpenAI::Internal::Type::Union
 
+            type id = { id: String }
+
+            class ID < OpenAI::Internal::Type::BaseModel
+              attr_accessor id: String
+
+              def initialize: (id: String) -> void
+
+              def to_hash: -> { id: String }
+            end
+
             def self?.variants: -> ::Array[OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::voice]
 
             ALLOY: :alloy

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.54.0
+  version: 0.55.0
 platform: ruby
 authors:
 - OpenAI