openai 0.29.0 → 0.30.0

data/lib/openai/resources/beta/chatkit.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Beta
+      class ChatKit
+        # @return [OpenAI::Resources::Beta::ChatKit::Sessions]
+        attr_reader :sessions
+
+        # @return [OpenAI::Resources::Beta::ChatKit::Threads]
+        attr_reader :threads
+
+        # Some parameter documentations has been truncated, see
+        # {OpenAI::Models::Beta::ChatKitUploadFileParams} for more details.
+        #
+        # Upload a ChatKit file
+        #
+        # @overload upload_file(file:, request_options: {})
+        #
+        # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] Binary file contents to store with the ChatKit session. Supports PDFs and PNG, J
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Beta::FilePart, OpenAI::Models::Beta::ImagePart]
+        #
+        # @see OpenAI::Models::Beta::ChatKitUploadFileParams
+        def upload_file(params)
+          parsed, options = OpenAI::Beta::ChatKitUploadFileParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "chatkit/files",
+            headers: {"content-type" => "multipart/form-data"},
+            body: parsed,
+            model: OpenAI::Models::Beta::ChatKitUploadFileResponse,
+            options: {extra_headers: {"OpenAI-Beta" => "chatkit_beta=v1"}, **options}
+          )
+        end
+
+        # @api private
+        #
+        # @param client [OpenAI::Client]
+        def initialize(client:)
+          @client = client
+          @sessions = OpenAI::Resources::Beta::ChatKit::Sessions.new(client: client)
+          @threads = OpenAI::Resources::Beta::ChatKit::Threads.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/beta.rb

@@ -3,6 +3,9 @@
 module OpenAI
   module Resources
     class Beta
+      # @return [OpenAI::Resources::Beta::ChatKit]
+      attr_reader :chatkit
+
       # @return [OpenAI::Resources::Beta::Assistants]
       attr_reader :assistants
 
@@ -14,6 +17,7 @@ module OpenAI
       # @param client [OpenAI::Client]
       def initialize(client:)
         @client = client
+        @chatkit = OpenAI::Resources::Beta::ChatKit.new(client: client)
         @assistants = OpenAI::Resources::Beta::Assistants.new(client: client)
         @threads = OpenAI::Resources::Beta::Threads.new(client: client)
       end

data/lib/openai/resources/videos.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Videos
+      # Create a video
+      #
+      # @overload create(prompt:, input_reference: nil, model: nil, seconds: nil, size: nil, request_options: {})
+      #
+      # @param prompt [String] Text prompt that describes the video to generate.
+      #
+      # @param input_reference [Pathname, StringIO, IO, String, OpenAI::FilePart] Optional image reference that guides generation.
+      #
+      # @param model [Symbol, OpenAI::Models::VideoModel] The video generation model to use. Defaults to `sora-2`.
+      #
+      # @param seconds [Symbol, OpenAI::Models::VideoSeconds] Clip duration in seconds. Defaults to 4 seconds.
+      #
+      # @param size [Symbol, OpenAI::Models::VideoSize] Output resolution formatted as width x height. Defaults to 720x1280.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Models::Video]
+      #
+      # @see OpenAI::Models::VideoCreateParams
+      def create(params)
+        parsed, options = OpenAI::VideoCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "videos",
+          headers: {"content-type" => "multipart/form-data"},
+          body: parsed,
+          model: OpenAI::Video,
+          options: options
+        )
+      end
+
+      # Retrieve a video
+      #
+      # @overload retrieve(video_id, request_options: {})
+      #
+      # @param video_id [String] The identifier of the video to retrieve.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Models::Video]
+      #
+      # @see OpenAI::Models::VideoRetrieveParams
+      def retrieve(video_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["videos/%1$s", video_id],
+          model: OpenAI::Video,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {OpenAI::Models::VideoListParams} for more details.
+      #
+      # List videos
+      #
+      # @overload list(after: nil, limit: nil, order: nil, request_options: {})
+      #
+      # @param after [String] Identifier for the last item from the previous pagination request
+      #
+      # @param limit [Integer] Number of items to retrieve
+      #
+      # @param order [Symbol, OpenAI::Models::VideoListParams::Order] Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Video>]
+      #
+      # @see OpenAI::Models::VideoListParams
+      def list(params = {})
+        parsed, options = OpenAI::VideoListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "videos",
+          query: parsed,
+          page: OpenAI::Internal::ConversationCursorPage,
+          model: OpenAI::Video,
+          options: options
+        )
+      end
+
+      # Delete a video
+      #
+      # @overload delete(video_id, request_options: {})
+      #
+      # @param video_id [String] The identifier of the video to delete.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Models::VideoDeleteResponse]
+      #
+      # @see OpenAI::Models::VideoDeleteParams
+      def delete(video_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["videos/%1$s", video_id],
+          model: OpenAI::Models::VideoDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Download video content
+      #
+      # @overload download_content(video_id, variant: nil, request_options: {})
+      #
+      # @param video_id [String] The identifier of the video whose media to download.
+      #
+      # @param variant [Symbol, OpenAI::Models::VideoDownloadContentParams::Variant] Which downloadable asset to return. Defaults to the MP4 video.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [StringIO]
+      #
+      # @see OpenAI::Models::VideoDownloadContentParams
+      def download_content(video_id, params = {})
+        parsed, options = OpenAI::VideoDownloadContentParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["videos/%1$s/content", video_id],
+          query: parsed,
+          headers: {"accept" => "application/binary"},
+          model: StringIO,
+          options: options
+        )
+      end
+
+      # Create a video remix
+      #
+      # @overload remix(video_id, prompt:, request_options: {})
+      #
+      # @param video_id [String] The identifier of the completed video to remix.
+      #
+      # @param prompt [String] Updated text prompt that directs the remix generation.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Models::Video]
+      #
+      # @see OpenAI::Models::VideoRemixParams
+      def remix(video_id, params)
+        parsed, options = OpenAI::VideoRemixParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["videos/%1$s/remix", video_id],
+          headers: {"content-type" => "multipart/form-data"},
+          body: parsed,
+          model: OpenAI::Video,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [OpenAI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/openai/version.rb

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

data/lib/openai.rb

@@ -114,9 +114,39 @@ require_relative "openai/models/beta/assistant_tool_choice"
 require_relative "openai/models/beta/assistant_tool_choice_function"
 require_relative "openai/models/beta/assistant_tool_choice_option"
 require_relative "openai/models/beta/assistant_update_params"
+require_relative "openai/models/beta/chatkit/chatkit_attachment"
+require_relative "openai/models/beta/chatkit/chatkit_response_output_text"
+require_relative "openai/models/beta/chatkit/chatkit_thread"
+require_relative "openai/models/beta/chatkit/chatkit_thread_assistant_message_item"
+require_relative "openai/models/beta/chatkit/chatkit_thread_item_list"
+require_relative "openai/models/beta/chatkit/chatkit_thread_user_message_item"
+require_relative "openai/models/beta/chatkit/chatkit_widget_item"
+require_relative "openai/models/beta/chatkit/chat_session"
+require_relative "openai/models/beta/chatkit/chat_session_automatic_thread_titling"
+require_relative "openai/models/beta/chatkit/chat_session_chatkit_configuration"
+require_relative "openai/models/beta/chatkit/chat_session_chatkit_configuration_param"
+require_relative "openai/models/beta/chatkit/chat_session_expires_after_param"
+require_relative "openai/models/beta/chatkit/chat_session_file_upload"
+require_relative "openai/models/beta/chatkit/chat_session_history"
+require_relative "openai/models/beta/chatkit/chat_session_rate_limits"
+require_relative "openai/models/beta/chatkit/chat_session_rate_limits_param"
+require_relative "openai/models/beta/chatkit/chat_session_status"
+require_relative "openai/models/beta/chatkit/chat_session_workflow_param"
+require_relative "openai/models/beta/chatkit/session_cancel_params"
+require_relative "openai/models/beta/chatkit/session_create_params"
+require_relative "openai/models/beta/chatkit/thread_delete_params"
+require_relative "openai/models/beta/chatkit/thread_delete_response"
+require_relative "openai/models/beta/chatkit/thread_list_items_params"
+require_relative "openai/models/beta/chatkit/thread_list_params"
+require_relative "openai/models/beta/chatkit/thread_retrieve_params"
+require_relative "openai/models/beta/chatkit_upload_file_params"
+require_relative "openai/models/beta/chatkit_upload_file_response"
+require_relative "openai/models/beta/chatkit_workflow"
 require_relative "openai/models/beta/code_interpreter_tool"
+require_relative "openai/models/beta/file_part"
 require_relative "openai/models/beta/file_search_tool"
 require_relative "openai/models/beta/function_tool"
+require_relative "openai/models/beta/image_part"
 require_relative "openai/models/beta/message_stream_event"
 require_relative "openai/models/beta/run_step_stream_event"
 require_relative "openai/models/beta/run_stream_event"
@@ -642,6 +672,18 @@ require_relative "openai/models/vector_stores/vector_store_file_deleted"
 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_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_list_params"
+require_relative "openai/models/video_model"
+require_relative "openai/models/video_remix_params"
+require_relative "openai/models/video_retrieve_params"
+require_relative "openai/models/video_seconds"
+require_relative "openai/models/video_size"
 require_relative "openai/models/webhooks/batch_cancelled_webhook_event"
 require_relative "openai/models/webhooks/batch_completed_webhook_event"
 require_relative "openai/models/webhooks/batch_expired_webhook_event"
@@ -667,6 +709,9 @@ require_relative "openai/resources/audio/translations"
 require_relative "openai/resources/batches"
 require_relative "openai/resources/beta"
 require_relative "openai/resources/beta/assistants"
+require_relative "openai/resources/beta/chatkit"
+require_relative "openai/resources/beta/chatkit/sessions"
+require_relative "openai/resources/beta/chatkit/threads"
 require_relative "openai/resources/beta/threads"
 require_relative "openai/resources/beta/threads/messages"
 require_relative "openai/resources/beta/threads/runs"
@@ -708,6 +753,7 @@ require_relative "openai/resources/uploads/parts"
 require_relative "openai/resources/vector_stores"
 require_relative "openai/resources/vector_stores/file_batches"
 require_relative "openai/resources/vector_stores/files"
+require_relative "openai/resources/videos"
 require_relative "openai/resources/webhooks"
 require_relative "openai/helpers/streaming/response_events"
 require_relative "openai/helpers/streaming/response_stream"

data/rbi/openai/client.rbi

@@ -79,6 +79,9 @@ module OpenAI
     sig { returns(OpenAI::Resources::Containers) }
     attr_reader :containers
 
+    sig { returns(OpenAI::Resources::Videos) }
+    attr_reader :videos
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/openai/models/all_models.rbi

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

data/rbi/openai/models/beta/chatkit/chat_session.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatSession < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatSession,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Identifier for the ChatKit session.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Resolved ChatKit feature configuration for the session.
+          sig do
+            returns(OpenAI::Beta::ChatKit::ChatSessionChatKitConfiguration)
+          end
+          attr_reader :chatkit_configuration
+
+          sig do
+            params(
+              chatkit_configuration:
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfiguration::OrHash
+            ).void
+          end
+          attr_writer :chatkit_configuration
+
+          # Ephemeral client secret that authenticates session requests.
+          sig { returns(String) }
+          attr_accessor :client_secret
+
+          # Unix timestamp (in seconds) for when the session expires.
+          sig { returns(Integer) }
+          attr_accessor :expires_at
+
+          # Convenience copy of the per-minute request limit.
+          sig { returns(Integer) }
+          attr_accessor :max_requests_per_1_minute
+
+          # Type discriminator that is always `chatkit.session`.
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # Resolved rate limit values.
+          sig { returns(OpenAI::Beta::ChatKit::ChatSessionRateLimits) }
+          attr_reader :rate_limits
+
+          sig do
+            params(
+              rate_limits: OpenAI::Beta::ChatKit::ChatSessionRateLimits::OrHash
+            ).void
+          end
+          attr_writer :rate_limits
+
+          # Current lifecycle state of the session.
+          sig do
+            returns(OpenAI::Beta::ChatKit::ChatSessionStatus::TaggedSymbol)
+          end
+          attr_accessor :status
+
+          # User identifier associated with the session.
+          sig { returns(String) }
+          attr_accessor :user
+
+          # Workflow metadata for the session.
+          sig { returns(OpenAI::Beta::ChatKitWorkflow) }
+          attr_reader :workflow
+
+          sig { params(workflow: OpenAI::Beta::ChatKitWorkflow::OrHash).void }
+          attr_writer :workflow
+
+          # Represents a ChatKit session and its resolved configuration.
+          sig do
+            params(
+              id: String,
+              chatkit_configuration:
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfiguration::OrHash,
+              client_secret: String,
+              expires_at: Integer,
+              max_requests_per_1_minute: Integer,
+              rate_limits: OpenAI::Beta::ChatKit::ChatSessionRateLimits::OrHash,
+              status: OpenAI::Beta::ChatKit::ChatSessionStatus::OrSymbol,
+              user: String,
+              workflow: OpenAI::Beta::ChatKitWorkflow::OrHash,
+              object: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Identifier for the ChatKit session.
+            id:,
+            # Resolved ChatKit feature configuration for the session.
+            chatkit_configuration:,
+            # Ephemeral client secret that authenticates session requests.
+            client_secret:,
+            # Unix timestamp (in seconds) for when the session expires.
+            expires_at:,
+            # Convenience copy of the per-minute request limit.
+            max_requests_per_1_minute:,
+            # Resolved rate limit values.
+            rate_limits:,
+            # Current lifecycle state of the session.
+            status:,
+            # User identifier associated with the session.
+            user:,
+            # Workflow metadata for the session.
+            workflow:,
+            # Type discriminator that is always `chatkit.session`.
+            object: :"chatkit.session"
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                chatkit_configuration:
+                  OpenAI::Beta::ChatKit::ChatSessionChatKitConfiguration,
+                client_secret: String,
+                expires_at: Integer,
+                max_requests_per_1_minute: Integer,
+                object: Symbol,
+                rate_limits: OpenAI::Beta::ChatKit::ChatSessionRateLimits,
+                status: OpenAI::Beta::ChatKit::ChatSessionStatus::TaggedSymbol,
+                user: String,
+                workflow: OpenAI::Beta::ChatKitWorkflow
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/chatkit/chat_session_automatic_thread_titling.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatSessionAutomaticThreadTitling < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatSessionAutomaticThreadTitling,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Whether automatic thread titling is enabled.
+          sig { returns(T::Boolean) }
+          attr_accessor :enabled
+
+          # Automatic thread title preferences for the session.
+          sig { params(enabled: T::Boolean).returns(T.attached_class) }
+          def self.new(
+            # Whether automatic thread titling is enabled.
+            enabled:
+          )
+          end
+
+          sig { override.returns({ enabled: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/chatkit/chat_session_chatkit_configuration.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatSessionChatKitConfiguration < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfiguration,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Automatic thread titling preferences.
+          sig do
+            returns(OpenAI::Beta::ChatKit::ChatSessionAutomaticThreadTitling)
+          end
+          attr_reader :automatic_thread_titling
+
+          sig do
+            params(
+              automatic_thread_titling:
+                OpenAI::Beta::ChatKit::ChatSessionAutomaticThreadTitling::OrHash
+            ).void
+          end
+          attr_writer :automatic_thread_titling
+
+          # Upload settings for the session.
+          sig { returns(OpenAI::Beta::ChatKit::ChatSessionFileUpload) }
+          attr_reader :file_upload
+
+          sig do
+            params(
+              file_upload: OpenAI::Beta::ChatKit::ChatSessionFileUpload::OrHash
+            ).void
+          end
+          attr_writer :file_upload
+
+          # History retention configuration.
+          sig { returns(OpenAI::Beta::ChatKit::ChatSessionHistory) }
+          attr_reader :history
+
+          sig do
+            params(
+              history: OpenAI::Beta::ChatKit::ChatSessionHistory::OrHash
+            ).void
+          end
+          attr_writer :history
+
+          # ChatKit configuration for the session.
+          sig do
+            params(
+              automatic_thread_titling:
+                OpenAI::Beta::ChatKit::ChatSessionAutomaticThreadTitling::OrHash,
+              file_upload: OpenAI::Beta::ChatKit::ChatSessionFileUpload::OrHash,
+              history: OpenAI::Beta::ChatKit::ChatSessionHistory::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Automatic thread titling preferences.
+            automatic_thread_titling:,
+            # Upload settings for the session.
+            file_upload:,
+            # History retention configuration.
+            history:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                automatic_thread_titling:
+                  OpenAI::Beta::ChatKit::ChatSessionAutomaticThreadTitling,
+                file_upload: OpenAI::Beta::ChatKit::ChatSessionFileUpload,
+                history: OpenAI::Beta::ChatKit::ChatSessionHistory
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end