openai 0.28.1 → 0.30.0

data/rbi/openai/models/image_edit_params.rbi

@@ -38,7 +38,8 @@ module OpenAI
 
       # Control how much effort the model will exert to match the style and features,
       # especially facial features, of input images. This parameter is only supported
-      # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
+      # for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
+      # `low`. Defaults to `low`.
       sig do
         returns(T.nilable(OpenAI::ImageEditParams::InputFidelity::OrSymbol))
       end
@@ -161,7 +162,8 @@ module OpenAI
         background: nil,
         # Control how much effort the model will exert to match the style and features,
         # especially facial features, of input images. This parameter is only supported
-        # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
+        # for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
+        # `low`. Defaults to `low`.
         input_fidelity: nil,
         # An additional image whose fully transparent areas (e.g. where alpha is zero)
         # indicate where `image` should be edited. If there are multiple images provided,
@@ -294,7 +296,8 @@ module OpenAI
 
       # Control how much effort the model will exert to match the style and features,
       # especially facial features, of input images. This parameter is only supported
-      # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
+      # for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
+      # `low`. Defaults to `low`.
       module InputFidelity
         extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/image_model.rbi

@@ -11,6 +11,8 @@ module OpenAI
       DALL_E_2 = T.let(:"dall-e-2", OpenAI::ImageModel::TaggedSymbol)
       DALL_E_3 = T.let(:"dall-e-3", OpenAI::ImageModel::TaggedSymbol)
       GPT_IMAGE_1 = T.let(:"gpt-image-1", OpenAI::ImageModel::TaggedSymbol)
+      GPT_IMAGE_1_MINI =
+        T.let(:"gpt-image-1-mini", OpenAI::ImageModel::TaggedSymbol)
 
       sig { override.returns(T::Array[OpenAI::ImageModel::TaggedSymbol]) }
       def self.values

data/rbi/openai/models/realtime/call_accept_params.rbi

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

data/rbi/openai/models/realtime/call_hangup_params.rbi

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

data/rbi/openai/models/realtime/call_refer_params.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class CallReferParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Realtime::CallReferParams, OpenAI::Internal::AnyHash)
+          end
+
+        # URI that should appear in the SIP Refer-To header. Supports values like
+        # `tel:+14155550123` or `sip:agent@example.com`.
+        sig { returns(String) }
+        attr_accessor :target_uri
+
+        sig do
+          params(
+            target_uri: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # URI that should appear in the SIP Refer-To header. Supports values like
+          # `tel:+14155550123` or `sip:agent@example.com`.
+          target_uri:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { target_uri: String, request_options: OpenAI::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/call_reject_params.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class CallRejectParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Realtime::CallRejectParams, OpenAI::Internal::AnyHash)
+          end
+
+        # SIP response code to send back to the caller. Defaults to `603` (Decline) when
+        # omitted.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :status_code
+
+        sig { params(status_code: Integer).void }
+        attr_writer :status_code
+
+        sig do
+          params(
+            status_code: Integer,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # SIP response code to send back to the caller. Defaults to `603` (Decline) when
+          # omitted.
+          status_code: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { status_code: Integer, request_options: OpenAI::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/realtime_session.rbi

@@ -707,6 +707,26 @@ module OpenAI
               :"gpt-4o-mini-realtime-preview-2024-12-17",
               OpenAI::Realtime::RealtimeSession::Model::TaggedSymbol
             )
+          GPT_REALTIME_MINI =
+            T.let(
+              :"gpt-realtime-mini",
+              OpenAI::Realtime::RealtimeSession::Model::TaggedSymbol
+            )
+          GPT_REALTIME_MINI_2025_10_06 =
+            T.let(
+              :"gpt-realtime-mini-2025-10-06",
+              OpenAI::Realtime::RealtimeSession::Model::TaggedSymbol
+            )
+          GPT_AUDIO_MINI =
+            T.let(
+              :"gpt-audio-mini",
+              OpenAI::Realtime::RealtimeSession::Model::TaggedSymbol
+            )
+          GPT_AUDIO_MINI_2025_10_06 =
+            T.let(
+              :"gpt-audio-mini-2025-10-06",
+              OpenAI::Realtime::RealtimeSession::Model::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/openai/models/realtime/realtime_session_create_request.rbi

@@ -508,6 +508,26 @@ module OpenAI
               :"gpt-4o-mini-realtime-preview-2024-12-17",
               OpenAI::Realtime::RealtimeSessionCreateRequest::Model::TaggedSymbol
             )
+          GPT_REALTIME_MINI =
+            T.let(
+              :"gpt-realtime-mini",
+              OpenAI::Realtime::RealtimeSessionCreateRequest::Model::TaggedSymbol
+            )
+          GPT_REALTIME_MINI_2025_10_06 =
+            T.let(
+              :"gpt-realtime-mini-2025-10-06",
+              OpenAI::Realtime::RealtimeSessionCreateRequest::Model::TaggedSymbol
+            )
+          GPT_AUDIO_MINI =
+            T.let(
+              :"gpt-audio-mini",
+              OpenAI::Realtime::RealtimeSessionCreateRequest::Model::TaggedSymbol
+            )
+          GPT_AUDIO_MINI_2025_10_06 =
+            T.let(
+              :"gpt-audio-mini-2025-10-06",
+              OpenAI::Realtime::RealtimeSessionCreateRequest::Model::TaggedSymbol
+            )
         end
 
         module OutputModality

data/rbi/openai/models/realtime/realtime_session_create_response.rbi

@@ -1308,6 +1308,26 @@ module OpenAI
               :"gpt-4o-mini-realtime-preview-2024-12-17",
               OpenAI::Realtime::RealtimeSessionCreateResponse::Model::TaggedSymbol
             )
+          GPT_REALTIME_MINI =
+            T.let(
+              :"gpt-realtime-mini",
+              OpenAI::Realtime::RealtimeSessionCreateResponse::Model::TaggedSymbol
+            )
+          GPT_REALTIME_MINI_2025_10_06 =
+            T.let(
+              :"gpt-realtime-mini-2025-10-06",
+              OpenAI::Realtime::RealtimeSessionCreateResponse::Model::TaggedSymbol
+            )
+          GPT_AUDIO_MINI =
+            T.let(
+              :"gpt-audio-mini",
+              OpenAI::Realtime::RealtimeSessionCreateResponse::Model::TaggedSymbol
+            )
+          GPT_AUDIO_MINI_2025_10_06 =
+            T.let(
+              :"gpt-audio-mini-2025-10-06",
+              OpenAI::Realtime::RealtimeSessionCreateResponse::Model::TaggedSymbol
+            )
         end
 
         module OutputModality

data/rbi/openai/models/responses/tool.rbi

@@ -781,7 +781,8 @@ module OpenAI
 
           # Control how much effort the model will exert to match the style and features,
           # especially facial features, of input images. This parameter is only supported
-          # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
+          # for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
+          # `low`. Defaults to `low`.
           sig do
             returns(
               T.nilable(
@@ -946,7 +947,8 @@ module OpenAI
             background: nil,
             # Control how much effort the model will exert to match the style and features,
             # especially facial features, of input images. This parameter is only supported
-            # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
+            # for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
+            # `low`. Defaults to `low`.
             input_fidelity: nil,
             # Optional mask for inpainting. Contains `image_url` (string, optional) and
             # `file_id` (string, optional).
@@ -1046,7 +1048,8 @@ module OpenAI
 
           # Control how much effort the model will exert to match the style and features,
           # especially facial features, of input images. This parameter is only supported
-          # for `gpt-image-1`. Supports `high` and `low`. Defaults to `low`.
+          # for `gpt-image-1`. Unsupported for `gpt-image-1-mini`. Supports `high` and
+          # `low`. Defaults to `low`.
           module InputFidelity
             extend OpenAI::Internal::Type::Enum
 
@@ -1139,6 +1142,11 @@ module OpenAI
                 :"gpt-image-1",
                 OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
               )
+            GPT_IMAGE_1_MINI =
+              T.let(
+                :"gpt-image-1-mini",
+                OpenAI::Responses::Tool::ImageGeneration::Model::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/openai/models/responses_model.rbi

@@ -78,6 +78,16 @@ module OpenAI
             :"gpt-5-codex",
             OpenAI::ResponsesModel::ResponsesOnlyModel::TaggedSymbol
           )
+        GPT_5_PRO =
+          T.let(
+            :"gpt-5-pro",
+            OpenAI::ResponsesModel::ResponsesOnlyModel::TaggedSymbol
+          )
+        GPT_5_PRO_2025_10_06 =
+          T.let(
+            :"gpt-5-pro-2025-10-06",
+            OpenAI::ResponsesModel::ResponsesOnlyModel::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/openai/models/video.rbi

@@ -0,0 +1,143 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class Video < OpenAI::Internal::Type::BaseModel
+      OrHash = T.type_alias { T.any(OpenAI::Video, OpenAI::Internal::AnyHash) }
+
+      # Unique identifier for the video job.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Unix timestamp (seconds) for when the job completed, if finished.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :completed_at
+
+      # Unix timestamp (seconds) for when the job was created.
+      sig { returns(Integer) }
+      attr_accessor :created_at
+
+      # Error payload that explains why generation failed, if applicable.
+      sig { returns(T.nilable(OpenAI::VideoCreateError)) }
+      attr_reader :error
+
+      sig { params(error: T.nilable(OpenAI::VideoCreateError::OrHash)).void }
+      attr_writer :error
+
+      # Unix timestamp (seconds) for when the downloadable assets expire, if set.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :expires_at
+
+      # The video generation model that produced the job.
+      sig { returns(OpenAI::VideoModel::TaggedSymbol) }
+      attr_accessor :model
+
+      # The object type, which is always `video`.
+      sig { returns(Symbol) }
+      attr_accessor :object
+
+      # Approximate completion percentage for the generation task.
+      sig { returns(Integer) }
+      attr_accessor :progress
+
+      # Identifier of the source video if this video is a remix.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :remixed_from_video_id
+
+      # Duration of the generated clip in seconds.
+      sig { returns(OpenAI::VideoSeconds::TaggedSymbol) }
+      attr_accessor :seconds
+
+      # The resolution of the generated video.
+      sig { returns(OpenAI::VideoSize::TaggedSymbol) }
+      attr_accessor :size
+
+      # Current lifecycle status of the video job.
+      sig { returns(OpenAI::Video::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # Structured information describing a generated video job.
+      sig do
+        params(
+          id: String,
+          completed_at: T.nilable(Integer),
+          created_at: Integer,
+          error: T.nilable(OpenAI::VideoCreateError::OrHash),
+          expires_at: T.nilable(Integer),
+          model: OpenAI::VideoModel::OrSymbol,
+          progress: Integer,
+          remixed_from_video_id: T.nilable(String),
+          seconds: OpenAI::VideoSeconds::OrSymbol,
+          size: OpenAI::VideoSize::OrSymbol,
+          status: OpenAI::Video::Status::OrSymbol,
+          object: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the video job.
+        id:,
+        # Unix timestamp (seconds) for when the job completed, if finished.
+        completed_at:,
+        # Unix timestamp (seconds) for when the job was created.
+        created_at:,
+        # Error payload that explains why generation failed, if applicable.
+        error:,
+        # Unix timestamp (seconds) for when the downloadable assets expire, if set.
+        expires_at:,
+        # The video generation model that produced the job.
+        model:,
+        # Approximate completion percentage for the generation task.
+        progress:,
+        # Identifier of the source video if this video is a remix.
+        remixed_from_video_id:,
+        # Duration of the generated clip in seconds.
+        seconds:,
+        # The resolution of the generated video.
+        size:,
+        # Current lifecycle status of the video job.
+        status:,
+        # The object type, which is always `video`.
+        object: :video
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            completed_at: T.nilable(Integer),
+            created_at: Integer,
+            error: T.nilable(OpenAI::VideoCreateError),
+            expires_at: T.nilable(Integer),
+            model: OpenAI::VideoModel::TaggedSymbol,
+            object: Symbol,
+            progress: Integer,
+            remixed_from_video_id: T.nilable(String),
+            seconds: OpenAI::VideoSeconds::TaggedSymbol,
+            size: OpenAI::VideoSize::TaggedSymbol,
+            status: OpenAI::Video::Status::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Current lifecycle status of the video job.
+      module Status
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Video::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        QUEUED = T.let(:queued, OpenAI::Video::Status::TaggedSymbol)
+        IN_PROGRESS = T.let(:in_progress, OpenAI::Video::Status::TaggedSymbol)
+        COMPLETED = T.let(:completed, OpenAI::Video::Status::TaggedSymbol)
+        FAILED = T.let(:failed, OpenAI::Video::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[OpenAI::Video::Status::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/video_create_error.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoCreateError < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::VideoCreateError, OpenAI::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :code
+
+      sig { returns(String) }
+      attr_accessor :message
+
+      sig { params(code: String, message: String).returns(T.attached_class) }
+      def self.new(code:, message:)
+      end
+
+      sig { override.returns({ code: String, message: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/openai/models/video_create_params.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoCreateParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::VideoCreateParams, OpenAI::Internal::AnyHash)
+        end
+
+      # Text prompt that describes the video to generate.
+      sig { returns(String) }
+      attr_accessor :prompt
+
+      # Optional image reference that guides generation.
+      sig { returns(T.nilable(OpenAI::Internal::FileInput)) }
+      attr_reader :input_reference
+
+      sig { params(input_reference: OpenAI::Internal::FileInput).void }
+      attr_writer :input_reference
+
+      # The video generation model to use. Defaults to `sora-2`.
+      sig { returns(T.nilable(OpenAI::VideoModel::OrSymbol)) }
+      attr_reader :model
+
+      sig { params(model: OpenAI::VideoModel::OrSymbol).void }
+      attr_writer :model
+
+      # Clip duration in seconds. Defaults to 4 seconds.
+      sig { returns(T.nilable(OpenAI::VideoSeconds::OrSymbol)) }
+      attr_reader :seconds
+
+      sig { params(seconds: OpenAI::VideoSeconds::OrSymbol).void }
+      attr_writer :seconds
+
+      # Output resolution formatted as width x height. Defaults to 720x1280.
+      sig { returns(T.nilable(OpenAI::VideoSize::OrSymbol)) }
+      attr_reader :size
+
+      sig { params(size: OpenAI::VideoSize::OrSymbol).void }
+      attr_writer :size
+
+      sig do
+        params(
+          prompt: String,
+          input_reference: OpenAI::Internal::FileInput,
+          model: OpenAI::VideoModel::OrSymbol,
+          seconds: OpenAI::VideoSeconds::OrSymbol,
+          size: OpenAI::VideoSize::OrSymbol,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Text prompt that describes the video to generate.
+        prompt:,
+        # Optional image reference that guides generation.
+        input_reference: nil,
+        # The video generation model to use. Defaults to `sora-2`.
+        model: nil,
+        # Clip duration in seconds. Defaults to 4 seconds.
+        seconds: nil,
+        # Output resolution formatted as width x height. Defaults to 720x1280.
+        size: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            prompt: String,
+            input_reference: OpenAI::Internal::FileInput,
+            model: OpenAI::VideoModel::OrSymbol,
+            seconds: OpenAI::VideoSeconds::OrSymbol,
+            size: OpenAI::VideoSize::OrSymbol,
+            request_options: OpenAI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/openai/models/video_delete_params.rbi

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

data/rbi/openai/models/video_delete_response.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoDeleteResponse < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::Models::VideoDeleteResponse, OpenAI::Internal::AnyHash)
+        end
+
+      # Identifier of the deleted video.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Indicates that the video resource was deleted.
+      sig { returns(T::Boolean) }
+      attr_accessor :deleted
+
+      # The object type that signals the deletion response.
+      sig { returns(Symbol) }
+      attr_accessor :object
+
+      # Confirmation payload returned after deleting a video.
+      sig do
+        params(id: String, deleted: T::Boolean, object: Symbol).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # Identifier of the deleted video.
+        id:,
+        # Indicates that the video resource was deleted.
+        deleted:,
+        # The object type that signals the deletion response.
+        object: :"video.deleted"
+      )
+      end
+
+      sig do
+        override.returns({ id: String, deleted: T::Boolean, object: Symbol })
+      end
+      def to_hash
+      end
+    end
+  end
+end