openai 0.53.0 → 0.55.0

data/rbi/openai/models/video_edit_params.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoEditParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::VideoEditParams, OpenAI::Internal::AnyHash)
+        end
+
+      # Text prompt that describes how to edit the source video.
+      sig { returns(String) }
+      attr_accessor :prompt
+
+      # Reference to the completed video to edit.
+      sig do
+        returns(
+          T.any(
+            OpenAI::Internal::FileInput,
+            OpenAI::VideoEditParams::Video::VideoReferenceInputParam
+          )
+        )
+      end
+      attr_accessor :video
+
+      sig do
+        params(
+          prompt: String,
+          video:
+            T.any(
+              OpenAI::Internal::FileInput,
+              OpenAI::VideoEditParams::Video::VideoReferenceInputParam::OrHash
+            ),
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Text prompt that describes how to edit the source video.
+        prompt:,
+        # Reference to the completed video to edit.
+        video:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            prompt: String,
+            video:
+              T.any(
+                OpenAI::Internal::FileInput,
+                OpenAI::VideoEditParams::Video::VideoReferenceInputParam
+              ),
+            request_options: OpenAI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Reference to the completed video to edit.
+      module Video
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              StringIO,
+              OpenAI::VideoEditParams::Video::VideoReferenceInputParam
+            )
+          end
+
+        class VideoReferenceInputParam < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::VideoEditParams::Video::VideoReferenceInputParam,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The identifier of the completed video.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Reference to the completed video.
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The identifier of the completed video.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(T::Array[OpenAI::VideoEditParams::Video::Variants])
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/video_extend_params.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoExtendParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::VideoExtendParams, OpenAI::Internal::AnyHash)
+        end
+
+      # Updated text prompt that directs the extension generation.
+      sig { returns(String) }
+      attr_accessor :prompt
+
+      # Length of the newly generated extension segment in seconds (allowed values: 4,
+      # 8, 12, 16, 20).
+      sig { returns(OpenAI::VideoSeconds::OrSymbol) }
+      attr_accessor :seconds
+
+      # Reference to the completed video to extend.
+      sig do
+        returns(
+          T.any(
+            OpenAI::Internal::FileInput,
+            OpenAI::VideoExtendParams::Video::VideoReferenceInputParam
+          )
+        )
+      end
+      attr_accessor :video
+
+      sig do
+        params(
+          prompt: String,
+          seconds: OpenAI::VideoSeconds::OrSymbol,
+          video:
+            T.any(
+              OpenAI::Internal::FileInput,
+              OpenAI::VideoExtendParams::Video::VideoReferenceInputParam::OrHash
+            ),
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Updated text prompt that directs the extension generation.
+        prompt:,
+        # Length of the newly generated extension segment in seconds (allowed values: 4,
+        # 8, 12, 16, 20).
+        seconds:,
+        # Reference to the completed video to extend.
+        video:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            prompt: String,
+            seconds: OpenAI::VideoSeconds::OrSymbol,
+            video:
+              T.any(
+                OpenAI::Internal::FileInput,
+                OpenAI::VideoExtendParams::Video::VideoReferenceInputParam
+              ),
+            request_options: OpenAI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Reference to the completed video to extend.
+      module Video
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              StringIO,
+              OpenAI::VideoExtendParams::Video::VideoReferenceInputParam
+            )
+          end
+
+        class VideoReferenceInputParam < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::VideoExtendParams::Video::VideoReferenceInputParam,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The identifier of the completed video.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Reference to the completed video.
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The identifier of the completed video.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(T::Array[OpenAI::VideoExtendParams::Video::Variants])
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/video_get_character_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoGetCharacterParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::VideoGetCharacterParams, OpenAI::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :character_id
+
+      sig do
+        params(
+          character_id: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(character_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { character_id: String, request_options: OpenAI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/openai/models/video_get_character_response.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoGetCharacterResponse < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            OpenAI::Models::VideoGetCharacterResponse,
+            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.rbi

@@ -139,6 +139,8 @@ module OpenAI
 
   ImageGenStreamEvent = OpenAI::Models::ImageGenStreamEvent
 
+  ImageInputReferenceParam = OpenAI::Models::ImageInputReferenceParam
+
   ImageModel = OpenAI::Models::ImageModel
 
   ImagesResponse = OpenAI::Models::ImagesResponse
@@ -244,6 +246,8 @@ module OpenAI
 
   Video = OpenAI::Models::Video
 
+  VideoCreateCharacterParams = OpenAI::Models::VideoCreateCharacterParams
+
   VideoCreateError = OpenAI::Models::VideoCreateError
 
   VideoCreateParams = OpenAI::Models::VideoCreateParams
@@ -252,6 +256,12 @@ module OpenAI
 
   VideoDownloadContentParams = OpenAI::Models::VideoDownloadContentParams
 
+  VideoEditParams = OpenAI::Models::VideoEditParams
+
+  VideoExtendParams = OpenAI::Models::VideoExtendParams
+
+  VideoGetCharacterParams = OpenAI::Models::VideoGetCharacterParams
+
   VideoListParams = OpenAI::Models::VideoListParams
 
   VideoModel = OpenAI::Models::VideoModel

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/rbi/openai/resources/videos.rbi

@@ -7,7 +7,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,
@@ -17,7 +21,7 @@ module OpenAI
       def create(
         # 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`.
@@ -80,6 +84,23 @@ module OpenAI
       )
       end
 
+      # Create a character from an uploaded video.
+      sig do
+        params(
+          name: String,
+          video: OpenAI::Internal::FileInput,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Models::VideoCreateCharacterResponse)
+      end
+      def create_character(
+        # Display name for this API character.
+        name:,
+        # Video file used to create a character.
+        video:,
+        request_options: {}
+      )
+      end
+
       # Download the generated video bytes or a derived preview asset.
       #
       # Streams the rendered video content for the specified video job.
@@ -99,6 +120,67 @@ module OpenAI
       )
       end
 
+      # Create a new video generation job by editing a source video or existing
+      # generated video.
+      sig do
+        params(
+          prompt: String,
+          video:
+            T.any(
+              OpenAI::Internal::FileInput,
+              OpenAI::VideoEditParams::Video::VideoReferenceInputParam::OrHash
+            ),
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Video)
+      end
+      def edit(
+        # Text prompt that describes how to edit the source video.
+        prompt:,
+        # Reference to the completed video to edit.
+        video:,
+        request_options: {}
+      )
+      end
+
+      # Create an extension of a completed video.
+      sig do
+        params(
+          prompt: String,
+          seconds: OpenAI::VideoSeconds::OrSymbol,
+          video:
+            T.any(
+              OpenAI::Internal::FileInput,
+              OpenAI::VideoExtendParams::Video::VideoReferenceInputParam::OrHash
+            ),
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Video)
+      end
+      def extend_(
+        # Updated text prompt that directs the extension generation.
+        prompt:,
+        # Length of the newly generated extension segment in seconds (allowed values: 4,
+        # 8, 12, 16, 20).
+        seconds:,
+        # Reference to the completed video to extend.
+        video:,
+        request_options: {}
+      )
+      end
+
+      # Fetch a character.
+      sig do
+        params(
+          character_id: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Models::VideoGetCharacterResponse)
+      end
+      def get_character(
+        # The identifier of the character to retrieve.
+        character_id,
+        request_options: {}
+      )
+      end
+
       # Create a remix of a completed video using a refreshed prompt.
       sig do
         params(

data/sig/openai/client.rbs

@@ -14,6 +14,8 @@ module OpenAI
 
     attr_reader project: String?
 
+    attr_reader webhook_secret: String?
+
     attr_reader completions: OpenAI::Resources::Completions
 
     attr_reader chat: OpenAI::Resources::Chat
@@ -64,6 +66,7 @@ module OpenAI
       ?api_key: String?,
       ?organization: String?,
       ?project: String?,
+      ?webhook_secret: String?,
       ?base_url: String?,
       ?max_retries: Integer,
       ?timeout: Float,

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/image_input_reference_param.rbs

@@ -0,0 +1,19 @@
+module OpenAI
+  module Models
+    type image_input_reference_param = { file_id: String, image_url: String }
+
+    class ImageInputReferenceParam < OpenAI::Internal::Type::BaseModel
+      attr_reader file_id: String?
+
+      def file_id=: (String) -> String
+
+      attr_reader image_url: String?
+
+      def image_url=: (String) -> String
+
+      def initialize: (?file_id: String, ?image_url: String) -> void
+
+      def to_hash: -> { file_id: String, image_url: String }
+    end
+  end
+end

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

data/sig/openai/models/responses/response_input_file.rbs

@@ -4,7 +4,6 @@ module OpenAI
       type response_input_file =
         {
           type: :input_file,
-          detail: OpenAI::Models::Responses::ResponseInputFile::detail,
           file_data: String,
           file_id: String?,
           file_url: String,
@@ -14,12 +13,6 @@ module OpenAI
       class ResponseInputFile < OpenAI::Internal::Type::BaseModel
         attr_accessor type: :input_file
 
-        attr_reader detail: OpenAI::Models::Responses::ResponseInputFile::detail?
-
-        def detail=: (
-          OpenAI::Models::Responses::ResponseInputFile::detail
-        ) -> OpenAI::Models::Responses::ResponseInputFile::detail
-
         attr_reader file_data: String?
 
         def file_data=: (String) -> String
@@ -35,7 +28,6 @@ module OpenAI
         def filename=: (String) -> String
 
         def initialize: (
-          ?detail: OpenAI::Models::Responses::ResponseInputFile::detail,
           ?file_data: String,
           ?file_id: String?,
           ?file_url: String,
@@ -45,23 +37,11 @@ module OpenAI
 
         def to_hash: -> {
           type: :input_file,
-          detail: OpenAI::Models::Responses::ResponseInputFile::detail,
           file_data: String,
           file_id: String?,
           file_url: String,
           filename: String
         }
-
-        type detail = :low | :high
-
-        module Detail
-          extend OpenAI::Internal::Type::Enum
-
-          LOW: :low
-          HIGH: :high
-
-          def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseInputFile::detail]
-        end
       end
     end
   end