openai 0.53.0 → 0.55.0

data/lib/openai/models/video_extend_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::Videos#extend_
+    class VideoExtendParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!attribute prompt
+      #   Updated text prompt that directs the extension generation.
+      #
+      #   @return [String]
+      required :prompt, String
+
+      # @!attribute seconds
+      #   Length of the newly generated extension segment in seconds (allowed values: 4,
+      #   8, 12, 16, 20).
+      #
+      #   @return [Symbol, OpenAI::Models::VideoSeconds]
+      required :seconds, enum: -> { OpenAI::VideoSeconds }
+
+      # @!attribute video
+      #   Reference to the completed video to extend.
+      #
+      #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart, OpenAI::Models::VideoExtendParams::Video::VideoReferenceInputParam]
+      required :video, union: -> { OpenAI::VideoExtendParams::Video }
+
+      # @!method initialize(prompt:, seconds:, video:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::VideoExtendParams} for more details.
+      #
+      #   @param prompt [String] Updated text prompt that directs the extension generation.
+      #
+      #   @param seconds [Symbol, OpenAI::Models::VideoSeconds] Length of the newly generated extension segment in seconds (allowed values: 4, 8
+      #
+      #   @param video [Pathname, StringIO, IO, String, OpenAI::FilePart, OpenAI::Models::VideoExtendParams::Video::VideoReferenceInputParam] Reference to the completed video to extend.
+      #
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+      # Reference to the completed video to extend.
+      module Video
+        extend OpenAI::Internal::Type::Union
+
+        # Reference to the completed video to extend.
+        variant OpenAI::Internal::Type::FileInput
+
+        # Reference to the completed video.
+        variant -> { OpenAI::VideoExtendParams::Video::VideoReferenceInputParam }
+
+        class VideoReferenceInputParam < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The identifier of the completed video.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Reference to the completed video.
+          #
+          #   @param id [String] The identifier of the completed video.
+        end
+
+        # @!method self.variants
+        #   @return [Array(StringIO, OpenAI::Models::VideoExtendParams::Video::VideoReferenceInputParam)]
+      end
+    end
+  end
+end

data/lib/openai/models/video_get_character_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::Videos#get_character
+    class VideoGetCharacterParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!attribute character_id
+      #
+      #   @return [String]
+      required :character_id, String
+
+      # @!method initialize(character_id:, request_options: {})
+      #   @param character_id [String]
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/openai/models/video_get_character_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::Videos#get_character
+    class VideoGetCharacterResponse < OpenAI::Internal::Type::BaseModel
+      # @!attribute id
+      #   Identifier for the character creation cameo.
+      #
+      #   @return [String, nil]
+      required :id, String, nil?: true
+
+      # @!attribute created_at
+      #   Unix timestamp (in seconds) when the character was created.
+      #
+      #   @return [Integer]
+      required :created_at, Integer
+
+      # @!attribute name
+      #   Display name for the character.
+      #
+      #   @return [String, nil]
+      required :name, String, nil?: true
+
+      # @!method initialize(id:, created_at:, name:)
+      #   @param id [String, nil] Identifier for the character creation cameo.
+      #
+      #   @param created_at [Integer] Unix timestamp (in seconds) when the character was created.
+      #
+      #   @param name [String, nil] Display name for the character.
+    end
+  end
+end

data/lib/openai/models.rb

@@ -176,6 +176,8 @@ module OpenAI
 
   ImageGenStreamEvent = OpenAI::Models::ImageGenStreamEvent
 
+  ImageInputReferenceParam = OpenAI::Models::ImageInputReferenceParam
+
   ImageModel = OpenAI::Models::ImageModel
 
   ImagesResponse = OpenAI::Models::ImagesResponse
@@ -279,6 +281,8 @@ module OpenAI
 
   Video = OpenAI::Models::Video
 
+  VideoCreateCharacterParams = OpenAI::Models::VideoCreateCharacterParams
+
   VideoCreateError = OpenAI::Models::VideoCreateError
 
   VideoCreateParams = OpenAI::Models::VideoCreateParams
@@ -287,6 +291,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/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/resources/videos.rb

@@ -12,7 +12,7 @@ module OpenAI
       #
       # @param prompt [String] Text prompt that describes the video to generate.
       #
-      # @param input_reference [Pathname, StringIO, IO, String, OpenAI::FilePart] Optional multipart reference asset that guides generation.
+      # @param input_reference [Pathname, StringIO, IO, String, OpenAI::FilePart, OpenAI::Models::ImageInputReferenceParam] Optional reference asset upload or reference object that guides generation.
       #
       # @param model [String, Symbol, OpenAI::Models::VideoModel] The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
       #
@@ -108,6 +108,31 @@ module OpenAI
         )
       end
 
+      # Create a character from an uploaded video.
+      #
+      # @overload create_character(name:, video:, request_options: {})
+      #
+      # @param name [String] Display name for this API character.
+      #
+      # @param video [Pathname, StringIO, IO, String, OpenAI::FilePart] Video file used to create a character.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Models::VideoCreateCharacterResponse]
+      #
+      # @see OpenAI::Models::VideoCreateCharacterParams
+      def create_character(params)
+        parsed, options = OpenAI::VideoCreateCharacterParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "videos/characters",
+          headers: {"content-type" => "multipart/form-data"},
+          body: parsed,
+          model: OpenAI::Models::VideoCreateCharacterResponse,
+          options: options
+        )
+      end
+
       # Download the generated video bytes or a derived preview asset.
       #
       # Streams the rendered video content for the specified video job.
@@ -136,6 +161,82 @@ module OpenAI
         )
       end
 
+      # Create a new video generation job by editing a source video or existing
+      # generated video.
+      #
+      # @overload edit(prompt:, video:, request_options: {})
+      #
+      # @param prompt [String] Text prompt that describes how to edit the source video.
+      #
+      # @param video [Pathname, StringIO, IO, String, OpenAI::FilePart, OpenAI::Models::VideoEditParams::Video::VideoReferenceInputParam] Reference to the completed video to edit.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Models::Video]
+      #
+      # @see OpenAI::Models::VideoEditParams
+      def edit(params)
+        parsed, options = OpenAI::VideoEditParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "videos/edits",
+          headers: {"content-type" => "multipart/form-data"},
+          body: parsed,
+          model: OpenAI::Video,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {OpenAI::Models::VideoExtendParams} for more details.
+      #
+      # Create an extension of a completed video.
+      #
+      # @overload extend_(prompt:, seconds:, video:, request_options: {})
+      #
+      # @param prompt [String] Updated text prompt that directs the extension generation.
+      #
+      # @param seconds [Symbol, OpenAI::Models::VideoSeconds] Length of the newly generated extension segment in seconds (allowed values: 4, 8
+      #
+      # @param video [Pathname, StringIO, IO, String, OpenAI::FilePart, OpenAI::Models::VideoExtendParams::Video::VideoReferenceInputParam] Reference to the completed video to extend.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Models::Video]
+      #
+      # @see OpenAI::Models::VideoExtendParams
+      def extend_(params)
+        parsed, options = OpenAI::VideoExtendParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "videos/extensions",
+          headers: {"content-type" => "multipart/form-data"},
+          body: parsed,
+          model: OpenAI::Video,
+          options: options
+        )
+      end
+
+      # Fetch a character.
+      #
+      # @overload get_character(character_id, request_options: {})
+      #
+      # @param character_id [String] The identifier of the character to retrieve.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Models::VideoGetCharacterResponse]
+      #
+      # @see OpenAI::Models::VideoGetCharacterParams
+      def get_character(character_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["videos/characters/%1$s", character_id],
+          model: OpenAI::Models::VideoGetCharacterResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Create a remix of a completed video using a refreshed prompt.
       #
       # @overload remix(video_id, prompt:, request_options: {})

data/lib/openai/version.rb

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

data/lib/openai.rb

@@ -403,6 +403,7 @@ require_relative "openai/models/image_gen_completed_event"
 require_relative "openai/models/image_generate_params"
 require_relative "openai/models/image_gen_partial_image_event"
 require_relative "openai/models/image_gen_stream_event"
+require_relative "openai/models/image_input_reference_param"
 require_relative "openai/models/image_model"
 require_relative "openai/models/images_response"
 require_relative "openai/models/metadata"
@@ -733,11 +734,17 @@ require_relative "openai/models/vector_store_search_params"
 require_relative "openai/models/vector_store_search_response"
 require_relative "openai/models/vector_store_update_params"
 require_relative "openai/models/video"
+require_relative "openai/models/video_create_character_params"
+require_relative "openai/models/video_create_character_response"
 require_relative "openai/models/video_create_error"
 require_relative "openai/models/video_create_params"
 require_relative "openai/models/video_delete_params"
 require_relative "openai/models/video_delete_response"
 require_relative "openai/models/video_download_content_params"
+require_relative "openai/models/video_edit_params"
+require_relative "openai/models/video_extend_params"
+require_relative "openai/models/video_get_character_params"
+require_relative "openai/models/video_get_character_response"
 require_relative "openai/models/video_list_params"
 require_relative "openai/models/video_model"
 require_relative "openai/models/video_remix_params"

data/rbi/openai/client.rbi

@@ -19,6 +19,9 @@ module OpenAI
     sig { returns(T.nilable(String)) }
     attr_reader :project
 
+    sig { returns(T.nilable(String)) }
+    attr_reader :webhook_secret
+
     # Given a prompt, the model will return one or more predicted completions, and can
     # also return the probabilities of alternative tokens at each position.
     sig { returns(OpenAI::Resources::Completions) }
@@ -110,6 +113,7 @@ module OpenAI
         api_key: T.nilable(String),
         organization: T.nilable(String),
         project: T.nilable(String),
+        webhook_secret: T.nilable(String),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
@@ -124,6 +128,8 @@ module OpenAI
       organization: ENV["OPENAI_ORG_ID"],
       # Defaults to `ENV["OPENAI_PROJECT_ID"]`
       project: ENV["OPENAI_PROJECT_ID"],
+      # Defaults to `ENV["OPENAI_WEBHOOK_SECRET"]`
+      webhook_secret: ENV["OPENAI_WEBHOOK_SECRET"],
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["OPENAI_BASE_URL"]`
       base_url: ENV["OPENAI_BASE_URL"],

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

@@ -0,0 +1,39 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class ImageInputReferenceParam < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::ImageInputReferenceParam, OpenAI::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :file_id
+
+      sig { params(file_id: String).void }
+      attr_writer :file_id
+
+      # A fully qualified URL or base64-encoded data URL.
+      sig { returns(T.nilable(String)) }
+      attr_reader :image_url
+
+      sig { params(image_url: String).void }
+      attr_writer :image_url
+
+      sig do
+        params(file_id: String, image_url: String).returns(T.attached_class)
+      end
+      def self.new(
+        file_id: nil,
+        # A fully qualified URL or base64-encoded data URL.
+        image_url: nil
+      )
+      end
+
+      sig { override.returns({ file_id: String, image_url: String }) }
+      def to_hash
+      end
+    end
+  end
+end