openai 0.28.1 → 0.30.0

data/rbi/openai/resources/realtime/calls.rbi

@@ -0,0 +1,182 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Realtime
+      class Calls
+        # Accept an incoming SIP call and configure the realtime session that will handle
+        # it.
+        sig do
+          params(
+            call_id: String,
+            audio: OpenAI::Realtime::RealtimeAudioConfig::OrHash,
+            include:
+              T::Array[
+                OpenAI::Realtime::RealtimeSessionCreateRequest::Include::OrSymbol
+              ],
+            instructions: String,
+            max_output_tokens: T.any(Integer, Symbol),
+            model:
+              T.any(
+                String,
+                OpenAI::Realtime::RealtimeSessionCreateRequest::Model::OrSymbol
+              ),
+            output_modalities:
+              T::Array[
+                OpenAI::Realtime::RealtimeSessionCreateRequest::OutputModality::OrSymbol
+              ],
+            prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
+            tool_choice:
+              T.any(
+                OpenAI::Responses::ToolChoiceOptions::OrSymbol,
+                OpenAI::Responses::ToolChoiceFunction::OrHash,
+                OpenAI::Responses::ToolChoiceMcp::OrHash
+              ),
+            tools:
+              T::Array[
+                T.any(
+                  OpenAI::Realtime::RealtimeFunctionTool::OrHash,
+                  OpenAI::Realtime::RealtimeToolsConfigUnion::Mcp::OrHash
+                )
+              ],
+            tracing:
+              T.nilable(
+                T.any(
+                  Symbol,
+                  OpenAI::Realtime::RealtimeTracingConfig::TracingConfiguration::OrHash
+                )
+              ),
+            truncation:
+              T.any(
+                OpenAI::Realtime::RealtimeTruncation::RealtimeTruncationStrategy::OrSymbol,
+                OpenAI::Realtime::RealtimeTruncationRetentionRatio::OrHash
+              ),
+            type: Symbol,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).void
+        end
+        def accept(
+          # The identifier for the call provided in the
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # webhook.
+          call_id,
+          # Configuration for input and output audio.
+          audio: nil,
+          # Additional fields to include in server outputs.
+          #
+          # `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+          # transcription.
+          include: nil,
+          # The default system instructions (i.e. system message) prepended to model calls.
+          # This field allows the client to guide the model on desired responses. The model
+          # can be instructed on response content and format, (e.g. "be extremely succinct",
+          # "act friendly", "here are examples of good responses") and on audio behavior
+          # (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The
+          # instructions are not guaranteed to be followed by the model, but they provide
+          # guidance to the model on the desired behavior.
+          #
+          # Note that the server sets default instructions which will be used if this field
+          # is not set and are visible in the `session.created` event at the start of the
+          # session.
+          instructions: nil,
+          # Maximum number of output tokens for a single assistant response, inclusive of
+          # tool calls. Provide an integer between 1 and 4096 to limit output tokens, or
+          # `inf` for the maximum available tokens for a given model. Defaults to `inf`.
+          max_output_tokens: nil,
+          # The Realtime model used for this session.
+          model: nil,
+          # The set of modalities the model can respond with. It defaults to `["audio"]`,
+          # indicating that the model will respond with audio plus a transcript. `["text"]`
+          # can be used to make the model respond with text only. It is not possible to
+          # request both `text` and `audio` at the same time.
+          output_modalities: nil,
+          # Reference to a prompt template and its variables.
+          # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+          prompt: nil,
+          # How the model chooses tools. Provide one of the string modes or force a specific
+          # function/MCP tool.
+          tool_choice: nil,
+          # Tools available to the model.
+          tools: nil,
+          # Realtime API can write session traces to the
+          # [Traces Dashboard](/logs?api=traces). Set to null to disable tracing. Once
+          # tracing is enabled for a session, the configuration cannot be modified.
+          #
+          # `auto` will create a trace for the session with default values for the workflow
+          # name, group id, and metadata.
+          tracing: nil,
+          # Controls how the realtime conversation is truncated prior to model inference.
+          # The default is `auto`.
+          truncation: nil,
+          # The type of session to create. Always `realtime` for the Realtime API.
+          type: :realtime,
+          request_options: {}
+        )
+        end
+
+        # End an active Realtime API call, whether it was initiated over SIP or WebRTC.
+        sig do
+          params(
+            call_id: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).void
+        end
+        def hangup(
+          # The identifier for the call. For SIP calls, use the value provided in the
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # webhook. For WebRTC sessions, reuse the call ID returned in the `Location`
+          # header when creating the call with
+          # [`POST /v1/realtime/calls`](https://platform.openai.com/docs/api-reference/realtime/create-call).
+          call_id,
+          request_options: {}
+        )
+        end
+
+        # Transfer an active SIP call to a new destination using the SIP REFER verb.
+        sig do
+          params(
+            call_id: String,
+            target_uri: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).void
+        end
+        def refer(
+          # The identifier for the call provided in the
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # webhook.
+          call_id,
+          # 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
+
+        # Decline an incoming SIP call by returning a SIP status code to the caller.
+        sig do
+          params(
+            call_id: String,
+            status_code: Integer,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).void
+        end
+        def reject(
+          # The identifier for the call provided in the
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # webhook.
+          call_id,
+          # SIP response code to send back to the caller. Defaults to `603` (Decline) when
+          # omitted.
+          status_code: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/realtime.rbi

@@ -6,6 +6,9 @@ module OpenAI
       sig { returns(OpenAI::Resources::Realtime::ClientSecrets) }
       attr_reader :client_secrets
 
+      sig { returns(OpenAI::Resources::Realtime::Calls) }
+      attr_reader :calls
+
       # @api private
       sig { params(client: OpenAI::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/openai/resources/videos.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Videos
+      # Create a video
+      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(OpenAI::Video)
+      end
+      def create(
+        # 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
+
+      # Retrieve a video
+      sig do
+        params(
+          video_id: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Video)
+      end
+      def retrieve(
+        # The identifier of the video to retrieve.
+        video_id,
+        request_options: {}
+      )
+      end
+
+      # List videos
+      sig do
+        params(
+          after: String,
+          limit: Integer,
+          order: OpenAI::VideoListParams::Order::OrSymbol,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Internal::ConversationCursorPage[OpenAI::Video])
+      end
+      def list(
+        # Identifier for the last item from the previous pagination request
+        after: nil,
+        # Number of items to retrieve
+        limit: nil,
+        # Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+        # descending order.
+        order: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete a video
+      sig do
+        params(
+          video_id: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Models::VideoDeleteResponse)
+      end
+      def delete(
+        # The identifier of the video to delete.
+        video_id,
+        request_options: {}
+      )
+      end
+
+      # Download video content
+      sig do
+        params(
+          video_id: String,
+          variant: OpenAI::VideoDownloadContentParams::Variant::OrSymbol,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(StringIO)
+      end
+      def download_content(
+        # The identifier of the video whose media to download.
+        video_id,
+        # Which downloadable asset to return. Defaults to the MP4 video.
+        variant: nil,
+        request_options: {}
+      )
+      end
+
+      # Create a video remix
+      sig do
+        params(
+          video_id: String,
+          prompt: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(OpenAI::Video)
+      end
+      def remix(
+        # The identifier of the completed video to remix.
+        video_id,
+        # Updated text prompt that directs the remix generation.
+        prompt:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: OpenAI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/openai/client.rbs

@@ -54,6 +54,8 @@ module OpenAI
 
     attr_reader containers: OpenAI::Resources::Containers
 
+    attr_reader videos: OpenAI::Resources::Videos
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/openai/models/all_models.rbs

@@ -20,6 +20,8 @@ module OpenAI
         | :"computer-use-preview"
         | :"computer-use-preview-2025-03-11"
         | :"gpt-5-codex"
+        | :"gpt-5-pro"
+        | :"gpt-5-pro-2025-10-06"
 
       module ResponsesOnlyModel
         extend OpenAI::Internal::Type::Enum
@@ -35,6 +37,8 @@ module OpenAI
         COMPUTER_USE_PREVIEW: :"computer-use-preview"
         COMPUTER_USE_PREVIEW_2025_03_11: :"computer-use-preview-2025-03-11"
         GPT_5_CODEX: :"gpt-5-codex"
+        GPT_5_PRO: :"gpt-5-pro"
+        GPT_5_PRO_2025_10_06: :"gpt-5-pro-2025-10-06"
 
         def self?.values: -> ::Array[OpenAI::Models::AllModels::responses_only_model]
       end

data/sig/openai/models/beta/chatkit/chat_session.rbs

@@ -0,0 +1,69 @@
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        type chat_session =
+          {
+            id: String,
+            chatkit_configuration: OpenAI::Beta::ChatKit::ChatSessionChatKitConfiguration,
+            client_secret: String,
+            expires_at: Integer,
+            :max_requests_per_1_minute => Integer,
+            object: :"chatkit.session",
+            rate_limits: OpenAI::Beta::ChatKit::ChatSessionRateLimits,
+            status: OpenAI::Models::Beta::ChatKit::chat_session_status,
+            user: String,
+            workflow: OpenAI::Beta::ChatKitWorkflow
+          }
+
+        class ChatSession < OpenAI::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor chatkit_configuration: OpenAI::Beta::ChatKit::ChatSessionChatKitConfiguration
+
+          attr_accessor client_secret: String
+
+          attr_accessor expires_at: Integer
+
+          attr_accessor max_requests_per_1_minute: Integer
+
+          attr_accessor object: :"chatkit.session"
+
+          attr_accessor rate_limits: OpenAI::Beta::ChatKit::ChatSessionRateLimits
+
+          attr_accessor status: OpenAI::Models::Beta::ChatKit::chat_session_status
+
+          attr_accessor user: String
+
+          attr_accessor workflow: OpenAI::Beta::ChatKitWorkflow
+
+          def initialize: (
+            id: String,
+            chatkit_configuration: OpenAI::Beta::ChatKit::ChatSessionChatKitConfiguration,
+            client_secret: String,
+            expires_at: Integer,
+            max_requests_per_1_minute: Integer,
+            rate_limits: OpenAI::Beta::ChatKit::ChatSessionRateLimits,
+            status: OpenAI::Models::Beta::ChatKit::chat_session_status,
+            user: String,
+            workflow: OpenAI::Beta::ChatKitWorkflow,
+            ?object: :"chatkit.session"
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            chatkit_configuration: OpenAI::Beta::ChatKit::ChatSessionChatKitConfiguration,
+            client_secret: String,
+            expires_at: Integer,
+            :max_requests_per_1_minute => Integer,
+            object: :"chatkit.session",
+            rate_limits: OpenAI::Beta::ChatKit::ChatSessionRateLimits,
+            status: OpenAI::Models::Beta::ChatKit::chat_session_status,
+            user: String,
+            workflow: OpenAI::Beta::ChatKitWorkflow
+          }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/chatkit/chat_session_automatic_thread_titling.rbs

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        type chat_session_automatic_thread_titling = { enabled: bool }
+
+        class ChatSessionAutomaticThreadTitling < OpenAI::Internal::Type::BaseModel
+          attr_accessor enabled: bool
+
+          def initialize: (enabled: bool) -> void
+
+          def to_hash: -> { enabled: bool }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/chatkit/chat_session_chatkit_configuration.rbs

@@ -0,0 +1,34 @@
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        type chat_session_chatkit_configuration =
+          {
+            automatic_thread_titling: OpenAI::Beta::ChatKit::ChatSessionAutomaticThreadTitling,
+            file_upload: OpenAI::Beta::ChatKit::ChatSessionFileUpload,
+            history: OpenAI::Beta::ChatKit::ChatSessionHistory
+          }
+
+        class ChatSessionChatKitConfiguration < OpenAI::Internal::Type::BaseModel
+          attr_accessor automatic_thread_titling: OpenAI::Beta::ChatKit::ChatSessionAutomaticThreadTitling
+
+          attr_accessor file_upload: OpenAI::Beta::ChatKit::ChatSessionFileUpload
+
+          attr_accessor history: OpenAI::Beta::ChatKit::ChatSessionHistory
+
+          def initialize: (
+            automatic_thread_titling: OpenAI::Beta::ChatKit::ChatSessionAutomaticThreadTitling,
+            file_upload: OpenAI::Beta::ChatKit::ChatSessionFileUpload,
+            history: OpenAI::Beta::ChatKit::ChatSessionHistory
+          ) -> void
+
+          def to_hash: -> {
+            automatic_thread_titling: OpenAI::Beta::ChatKit::ChatSessionAutomaticThreadTitling,
+            file_upload: OpenAI::Beta::ChatKit::ChatSessionFileUpload,
+            history: OpenAI::Beta::ChatKit::ChatSessionHistory
+          }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/chatkit/chat_session_chatkit_configuration_param.rbs

@@ -0,0 +1,103 @@
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        type chat_session_chatkit_configuration_param =
+          {
+            automatic_thread_titling: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling,
+            file_upload: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload,
+            history: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History
+          }
+
+        class ChatSessionChatKitConfigurationParam < OpenAI::Internal::Type::BaseModel
+          attr_reader automatic_thread_titling: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling?
+
+          def automatic_thread_titling=: (
+            OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling
+          ) -> OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling
+
+          attr_reader file_upload: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload?
+
+          def file_upload=: (
+            OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload
+          ) -> OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload
+
+          attr_reader history: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History?
+
+          def history=: (
+            OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History
+          ) -> OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History
+
+          def initialize: (
+            ?automatic_thread_titling: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling,
+            ?file_upload: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload,
+            ?history: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History
+          ) -> void
+
+          def to_hash: -> {
+            automatic_thread_titling: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling,
+            file_upload: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload,
+            history: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History
+          }
+
+          type automatic_thread_titling = { enabled: bool }
+
+          class AutomaticThreadTitling < OpenAI::Internal::Type::BaseModel
+            attr_reader enabled: bool?
+
+            def enabled=: (bool) -> bool
+
+            def initialize: (?enabled: bool) -> void
+
+            def to_hash: -> { enabled: bool }
+          end
+
+          type file_upload =
+            { enabled: bool, max_file_size: Integer, max_files: Integer }
+
+          class FileUpload < OpenAI::Internal::Type::BaseModel
+            attr_reader enabled: bool?
+
+            def enabled=: (bool) -> bool
+
+            attr_reader max_file_size: Integer?
+
+            def max_file_size=: (Integer) -> Integer
+
+            attr_reader max_files: Integer?
+
+            def max_files=: (Integer) -> Integer
+
+            def initialize: (
+              ?enabled: bool,
+              ?max_file_size: Integer,
+              ?max_files: Integer
+            ) -> void
+
+            def to_hash: -> {
+              enabled: bool,
+              max_file_size: Integer,
+              max_files: Integer
+            }
+          end
+
+          type history = { enabled: bool, recent_threads: Integer }
+
+          class History < OpenAI::Internal::Type::BaseModel
+            attr_reader enabled: bool?
+
+            def enabled=: (bool) -> bool
+
+            attr_reader recent_threads: Integer?
+
+            def recent_threads=: (Integer) -> Integer
+
+            def initialize: (?enabled: bool, ?recent_threads: Integer) -> void
+
+            def to_hash: -> { enabled: bool, recent_threads: Integer }
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/chatkit/chat_session_expires_after_param.rbs

@@ -0,0 +1,20 @@
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        type chat_session_expires_after_param =
+          { anchor: :created_at, seconds: Integer }
+
+        class ChatSessionExpiresAfterParam < OpenAI::Internal::Type::BaseModel
+          attr_accessor anchor: :created_at
+
+          attr_accessor seconds: Integer
+
+          def initialize: (seconds: Integer, ?anchor: :created_at) -> void
+
+          def to_hash: -> { anchor: :created_at, seconds: Integer }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/chatkit/chat_session_file_upload.rbs

@@ -0,0 +1,30 @@
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        type chat_session_file_upload =
+          { enabled: bool, max_file_size: Integer?, max_files: Integer? }
+
+        class ChatSessionFileUpload < OpenAI::Internal::Type::BaseModel
+          attr_accessor enabled: bool
+
+          attr_accessor max_file_size: Integer?
+
+          attr_accessor max_files: Integer?
+
+          def initialize: (
+            enabled: bool,
+            max_file_size: Integer?,
+            max_files: Integer?
+          ) -> void
+
+          def to_hash: -> {
+            enabled: bool,
+            max_file_size: Integer?,
+            max_files: Integer?
+          }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/chatkit/chat_session_history.rbs

@@ -0,0 +1,19 @@
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        type chat_session_history = { enabled: bool, recent_threads: Integer? }
+
+        class ChatSessionHistory < OpenAI::Internal::Type::BaseModel
+          attr_accessor enabled: bool
+
+          attr_accessor recent_threads: Integer?
+
+          def initialize: (enabled: bool, recent_threads: Integer?) -> void
+
+          def to_hash: -> { enabled: bool, recent_threads: Integer? }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/chatkit/chat_session_rate_limits.rbs

@@ -0,0 +1,18 @@
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        type chat_session_rate_limits =
+          { :max_requests_per_1_minute => Integer }
+
+        class ChatSessionRateLimits < OpenAI::Internal::Type::BaseModel
+          attr_accessor max_requests_per_1_minute: Integer
+
+          def initialize: (max_requests_per_1_minute: Integer) -> void
+
+          def to_hash: -> { :max_requests_per_1_minute => Integer }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/chatkit/chat_session_rate_limits_param.rbs

@@ -0,0 +1,20 @@
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        type chat_session_rate_limits_param =
+          { :max_requests_per_1_minute => Integer }
+
+        class ChatSessionRateLimitsParam < OpenAI::Internal::Type::BaseModel
+          attr_reader max_requests_per_1_minute: Integer?
+
+          def max_requests_per_1_minute=: (Integer) -> Integer
+
+          def initialize: (?max_requests_per_1_minute: Integer) -> void
+
+          def to_hash: -> { :max_requests_per_1_minute => Integer }
+        end
+      end
+    end
+  end
+end