openai 0.53.0 → 0.55.0

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/models/responses/response_input_file.rbi

@@ -16,22 +16,6 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # The detail level of the file to be sent to the model. One of `high` or `low`.
-        # Defaults to `high`.
-        sig do
-          returns(
-            T.nilable(OpenAI::Responses::ResponseInputFile::Detail::OrSymbol)
-          )
-        end
-        attr_reader :detail
-
-        sig do
-          params(
-            detail: OpenAI::Responses::ResponseInputFile::Detail::OrSymbol
-          ).void
-        end
-        attr_writer :detail
-
         # The content of the file to be sent to the model.
         sig { returns(T.nilable(String)) }
         attr_reader :file_data
@@ -60,7 +44,6 @@ module OpenAI
         # A file input to the model.
         sig do
           params(
-            detail: OpenAI::Responses::ResponseInputFile::Detail::OrSymbol,
             file_data: String,
             file_id: T.nilable(String),
             file_url: String,
@@ -69,9 +52,6 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The detail level of the file to be sent to the model. One of `high` or `low`.
-          # Defaults to `high`.
-          detail: nil,
           # The content of the file to be sent to the model.
           file_data: nil,
           # The ID of the file to be sent to the model.
@@ -89,7 +69,6 @@ module OpenAI
           override.returns(
             {
               type: Symbol,
-              detail: OpenAI::Responses::ResponseInputFile::Detail::OrSymbol,
               file_data: String,
               file_id: T.nilable(String),
               file_url: String,
@@ -99,39 +78,6 @@ module OpenAI
         end
         def to_hash
         end
-
-        # The detail level of the file to be sent to the model. One of `high` or `low`.
-        # Defaults to `high`.
-        module Detail
-          extend OpenAI::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, OpenAI::Responses::ResponseInputFile::Detail)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          LOW =
-            T.let(
-              :low,
-              OpenAI::Responses::ResponseInputFile::Detail::TaggedSymbol
-            )
-          HIGH =
-            T.let(
-              :high,
-              OpenAI::Responses::ResponseInputFile::Detail::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::Responses::ResponseInputFile::Detail::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
       end
     end
   end

data/rbi/openai/models/responses/response_input_file_content.rbi

@@ -16,25 +16,6 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # The detail level of the file to be sent to the model. One of `high` or `low`.
-        # Defaults to `high`.
-        sig do
-          returns(
-            T.nilable(
-              OpenAI::Responses::ResponseInputFileContent::Detail::OrSymbol
-            )
-          )
-        end
-        attr_reader :detail
-
-        sig do
-          params(
-            detail:
-              OpenAI::Responses::ResponseInputFileContent::Detail::OrSymbol
-          ).void
-        end
-        attr_writer :detail
-
         # The base64-encoded data of the file to be sent to the model.
         sig { returns(T.nilable(String)) }
         attr_accessor :file_data
@@ -54,8 +35,6 @@ module OpenAI
         # A file input to the model.
         sig do
           params(
-            detail:
-              OpenAI::Responses::ResponseInputFileContent::Detail::OrSymbol,
             file_data: T.nilable(String),
             file_id: T.nilable(String),
             file_url: T.nilable(String),
@@ -64,9 +43,6 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The detail level of the file to be sent to the model. One of `high` or `low`.
-          # Defaults to `high`.
-          detail: nil,
           # The base64-encoded data of the file to be sent to the model.
           file_data: nil,
           # The ID of the file to be sent to the model.
@@ -84,8 +60,6 @@ module OpenAI
           override.returns(
             {
               type: Symbol,
-              detail:
-                OpenAI::Responses::ResponseInputFileContent::Detail::OrSymbol,
               file_data: T.nilable(String),
               file_id: T.nilable(String),
               file_url: T.nilable(String),
@@ -95,39 +69,6 @@ module OpenAI
         end
         def to_hash
         end
-
-        # The detail level of the file to be sent to the model. One of `high` or `low`.
-        # Defaults to `high`.
-        module Detail
-          extend OpenAI::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, OpenAI::Responses::ResponseInputFileContent::Detail)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          HIGH =
-            T.let(
-              :high,
-              OpenAI::Responses::ResponseInputFileContent::Detail::TaggedSymbol
-            )
-          LOW =
-            T.let(
-              :low,
-              OpenAI::Responses::ResponseInputFileContent::Detail::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::Responses::ResponseInputFileContent::Detail::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
       end
     end
   end

data/rbi/openai/models/video_create_character_params.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoCreateCharacterParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::VideoCreateCharacterParams, OpenAI::Internal::AnyHash)
+        end
+
+      # Display name for this API character.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Video file used to create a character.
+      sig { returns(OpenAI::Internal::FileInput) }
+      attr_accessor :video
+
+      sig do
+        params(
+          name: String,
+          video: OpenAI::Internal::FileInput,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Display name for this API character.
+        name:,
+        # Video file used to create a character.
+        video:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            video: OpenAI::Internal::FileInput,
+            request_options: OpenAI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/openai/models/video_create_character_response.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoCreateCharacterResponse < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            OpenAI::Models::VideoCreateCharacterResponse,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+      # Identifier for the character creation cameo.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :id
+
+      # Unix timestamp (in seconds) when the character was created.
+      sig { returns(Integer) }
+      attr_accessor :created_at
+
+      # Display name for the character.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      sig do
+        params(
+          id: T.nilable(String),
+          created_at: Integer,
+          name: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Identifier for the character creation cameo.
+        id:,
+        # Unix timestamp (in seconds) when the character was created.
+        created_at:,
+        # Display name for the character.
+        name:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: T.nilable(String),
+            created_at: Integer,
+            name: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/openai/models/video_create_params.rbi

@@ -15,11 +15,25 @@ module OpenAI
       sig { returns(String) }
       attr_accessor :prompt
 
-      # Optional multipart reference asset that guides generation.
-      sig { returns(T.nilable(OpenAI::Internal::FileInput)) }
+      # Optional reference asset upload or reference object that guides generation.
+      sig do
+        returns(
+          T.nilable(
+            T.any(OpenAI::Internal::FileInput, OpenAI::ImageInputReferenceParam)
+          )
+        )
+      end
       attr_reader :input_reference
 
-      sig { params(input_reference: OpenAI::Internal::FileInput).void }
+      sig do
+        params(
+          input_reference:
+            T.any(
+              OpenAI::Internal::FileInput,
+              OpenAI::ImageInputReferenceParam::OrHash
+            )
+        ).void
+      end
       attr_writer :input_reference
 
       # The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
@@ -48,7 +62,11 @@ module OpenAI
       sig do
         params(
           prompt: String,
-          input_reference: OpenAI::Internal::FileInput,
+          input_reference:
+            T.any(
+              OpenAI::Internal::FileInput,
+              OpenAI::ImageInputReferenceParam::OrHash
+            ),
           model: T.any(String, OpenAI::VideoModel::OrSymbol),
           seconds: OpenAI::VideoSeconds::OrSymbol,
           size: OpenAI::VideoSize::OrSymbol,
@@ -58,7 +76,7 @@ module OpenAI
       def self.new(
         # Text prompt that describes the video to generate.
         prompt:,
-        # Optional multipart reference asset that guides generation.
+        # Optional reference asset upload or reference object that guides generation.
         input_reference: nil,
         # The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
         # to `sora-2`.
@@ -76,7 +94,11 @@ module OpenAI
         override.returns(
           {
             prompt: String,
-            input_reference: OpenAI::Internal::FileInput,
+            input_reference:
+              T.any(
+                OpenAI::Internal::FileInput,
+                OpenAI::ImageInputReferenceParam
+              ),
             model: T.any(String, OpenAI::VideoModel::OrSymbol),
             seconds: OpenAI::VideoSeconds::OrSymbol,
             size: OpenAI::VideoSize::OrSymbol,
@@ -86,6 +108,22 @@ module OpenAI
       end
       def to_hash
       end
+
+      # Optional reference asset upload or reference object that guides generation.
+      module InputReference
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
+          T.type_alias { T.any(StringIO, OpenAI::ImageInputReferenceParam) }
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::VideoCreateParams::InputReference::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
     end
   end
 end