openai 0.28.1 → 0.30.0

data/rbi/openai/models/video_download_content_params.rbi

@@ -0,0 +1,89 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoDownloadContentParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::VideoDownloadContentParams, OpenAI::Internal::AnyHash)
+        end
+
+      # Which downloadable asset to return. Defaults to the MP4 video.
+      sig do
+        returns(
+          T.nilable(OpenAI::VideoDownloadContentParams::Variant::OrSymbol)
+        )
+      end
+      attr_reader :variant
+
+      sig do
+        params(
+          variant: OpenAI::VideoDownloadContentParams::Variant::OrSymbol
+        ).void
+      end
+      attr_writer :variant
+
+      sig do
+        params(
+          variant: OpenAI::VideoDownloadContentParams::Variant::OrSymbol,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Which downloadable asset to return. Defaults to the MP4 video.
+        variant: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            variant: OpenAI::VideoDownloadContentParams::Variant::OrSymbol,
+            request_options: OpenAI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Which downloadable asset to return. Defaults to the MP4 video.
+      module Variant
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, OpenAI::VideoDownloadContentParams::Variant)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        VIDEO =
+          T.let(
+            :video,
+            OpenAI::VideoDownloadContentParams::Variant::TaggedSymbol
+          )
+        THUMBNAIL =
+          T.let(
+            :thumbnail,
+            OpenAI::VideoDownloadContentParams::Variant::TaggedSymbol
+          )
+        SPRITESHEET =
+          T.let(
+            :spritesheet,
+            OpenAI::VideoDownloadContentParams::Variant::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::VideoDownloadContentParams::Variant::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/video_list_params.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoListParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::VideoListParams, OpenAI::Internal::AnyHash)
+        end
+
+      # Identifier for the last item from the previous pagination request
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # Number of items to retrieve
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+      # descending order.
+      sig { returns(T.nilable(OpenAI::VideoListParams::Order::OrSymbol)) }
+      attr_reader :order
+
+      sig { params(order: OpenAI::VideoListParams::Order::OrSymbol).void }
+      attr_writer :order
+
+      sig do
+        params(
+          after: String,
+          limit: Integer,
+          order: OpenAI::VideoListParams::Order::OrSymbol,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            limit: Integer,
+            order: OpenAI::VideoListParams::Order::OrSymbol,
+            request_options: OpenAI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Sort order of results by timestamp. Use `asc` for ascending order or `desc` for
+      # descending order.
+      module Order
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, OpenAI::VideoListParams::Order) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC = T.let(:asc, OpenAI::VideoListParams::Order::TaggedSymbol)
+        DESC = T.let(:desc, OpenAI::VideoListParams::Order::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::VideoListParams::Order::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/video_model.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module VideoModel
+      extend OpenAI::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::VideoModel) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      SORA_2 = T.let(:"sora-2", OpenAI::VideoModel::TaggedSymbol)
+      SORA_2_PRO = T.let(:"sora-2-pro", OpenAI::VideoModel::TaggedSymbol)
+
+      sig { override.returns(T::Array[OpenAI::VideoModel::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/openai/models/video_remix_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoRemixParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::VideoRemixParams, OpenAI::Internal::AnyHash)
+        end
+
+      # Updated text prompt that directs the remix generation.
+      sig { returns(String) }
+      attr_accessor :prompt
+
+      sig do
+        params(
+          prompt: String,
+          request_options: OpenAI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Updated text prompt that directs the remix generation.
+        prompt:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { prompt: String, request_options: OpenAI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/openai/models/video_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class VideoRetrieveParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::VideoRetrieveParams, 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_seconds.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module VideoSeconds
+      extend OpenAI::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::VideoSeconds) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      VIDEO_SECONDS_4 = T.let(:"4", OpenAI::VideoSeconds::TaggedSymbol)
+      VIDEO_SECONDS_8 = T.let(:"8", OpenAI::VideoSeconds::TaggedSymbol)
+      VIDEO_SECONDS_12 = T.let(:"12", OpenAI::VideoSeconds::TaggedSymbol)
+
+      sig { override.returns(T::Array[OpenAI::VideoSeconds::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/openai/models/video_size.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module VideoSize
+      extend OpenAI::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::VideoSize) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      VIDEO_SIZE_720X1280 = T.let(:"720x1280", OpenAI::VideoSize::TaggedSymbol)
+      VIDEO_SIZE_1280X720 = T.let(:"1280x720", OpenAI::VideoSize::TaggedSymbol)
+      VIDEO_SIZE_1024X1792 =
+        T.let(:"1024x1792", OpenAI::VideoSize::TaggedSymbol)
+      VIDEO_SIZE_1792X1024 =
+        T.let(:"1792x1024", OpenAI::VideoSize::TaggedSymbol)
+
+      sig { override.returns(T::Array[OpenAI::VideoSize::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/openai/models.rbi

@@ -224,5 +224,27 @@ module OpenAI
 
   VectorStoreUpdateParams = OpenAI::Models::VectorStoreUpdateParams
 
+  Video = OpenAI::Models::Video
+
+  VideoCreateError = OpenAI::Models::VideoCreateError
+
+  VideoCreateParams = OpenAI::Models::VideoCreateParams
+
+  VideoDeleteParams = OpenAI::Models::VideoDeleteParams
+
+  VideoDownloadContentParams = OpenAI::Models::VideoDownloadContentParams
+
+  VideoListParams = OpenAI::Models::VideoListParams
+
+  VideoModel = OpenAI::Models::VideoModel
+
+  VideoRemixParams = OpenAI::Models::VideoRemixParams
+
+  VideoRetrieveParams = OpenAI::Models::VideoRetrieveParams
+
+  VideoSeconds = OpenAI::Models::VideoSeconds
+
+  VideoSize = OpenAI::Models::VideoSize
+
   Webhooks = OpenAI::Models::Webhooks
 end

data/rbi/openai/resources/beta/chatkit/sessions.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Beta
+      class ChatKit
+        class Sessions
+          # Create a ChatKit session
+          sig do
+            params(
+              user: String,
+              workflow: OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::OrHash,
+              chatkit_configuration:
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::OrHash,
+              expires_after:
+                OpenAI::Beta::ChatKit::ChatSessionExpiresAfterParam::OrHash,
+              rate_limits:
+                OpenAI::Beta::ChatKit::ChatSessionRateLimitsParam::OrHash,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Beta::ChatKit::ChatSession)
+          end
+          def create(
+            # A free-form string that identifies your end user; ensures this Session can
+            # access other objects that have the same `user` scope.
+            user:,
+            # Workflow that powers the session.
+            workflow:,
+            # Optional overrides for ChatKit runtime configuration features
+            chatkit_configuration: nil,
+            # Optional override for session expiration timing in seconds from creation.
+            # Defaults to 10 minutes.
+            expires_after: nil,
+            # Optional override for per-minute request limits. When omitted, defaults to 10.
+            rate_limits: nil,
+            request_options: {}
+          )
+          end
+
+          # Cancel a ChatKit session
+          sig do
+            params(
+              session_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Beta::ChatKit::ChatSession)
+          end
+          def cancel(
+            # Unique identifier for the ChatKit session to cancel.
+            session_id,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: OpenAI::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/beta/chatkit/threads.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Beta
+      class ChatKit
+        class Threads
+          # Retrieve a ChatKit thread
+          sig do
+            params(
+              thread_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Beta::ChatKit::ChatKitThread)
+          end
+          def retrieve(
+            # Identifier of the ChatKit thread to retrieve.
+            thread_id,
+            request_options: {}
+          )
+          end
+
+          # List ChatKit threads
+          sig do
+            params(
+              after: String,
+              before: String,
+              limit: Integer,
+              order: OpenAI::Beta::ChatKit::ThreadListParams::Order::OrSymbol,
+              user: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::ConversationCursorPage[
+                OpenAI::Beta::ChatKit::ChatKitThread
+              ]
+            )
+          end
+          def list(
+            # List items created after this thread item ID. Defaults to null for the first
+            # page.
+            after: nil,
+            # List items created before this thread item ID. Defaults to null for the newest
+            # results.
+            before: nil,
+            # Maximum number of thread items to return. Defaults to 20.
+            limit: nil,
+            # Sort order for results by creation time. Defaults to `desc`.
+            order: nil,
+            # Filter threads that belong to this user identifier. Defaults to null to return
+            # all users.
+            user: nil,
+            request_options: {}
+          )
+          end
+
+          # Delete a ChatKit thread
+          sig do
+            params(
+              thread_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Models::Beta::ChatKit::ThreadDeleteResponse)
+          end
+          def delete(
+            # Identifier of the ChatKit thread to delete.
+            thread_id,
+            request_options: {}
+          )
+          end
+
+          # List ChatKit thread items
+          sig do
+            params(
+              thread_id: String,
+              after: String,
+              before: String,
+              limit: Integer,
+              order:
+                OpenAI::Beta::ChatKit::ThreadListItemsParams::Order::OrSymbol,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::ConversationCursorPage[
+                OpenAI::Beta::ChatKit::ChatKitThreadItemList::Data::Variants
+              ]
+            )
+          end
+          def list_items(
+            # Identifier of the ChatKit thread whose items are requested.
+            thread_id,
+            # List items created after this thread item ID. Defaults to null for the first
+            # page.
+            after: nil,
+            # List items created before this thread item ID. Defaults to null for the newest
+            # results.
+            before: nil,
+            # Maximum number of thread items to return. Defaults to 20.
+            limit: nil,
+            # Sort order for results by creation time. Defaults to `desc`.
+            order: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: OpenAI::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/beta/chatkit.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Beta
+      class ChatKit
+        sig { returns(OpenAI::Resources::Beta::ChatKit::Sessions) }
+        attr_reader :sessions
+
+        sig { returns(OpenAI::Resources::Beta::ChatKit::Threads) }
+        attr_reader :threads
+
+        # Upload a ChatKit file
+        sig do
+          params(
+            file: OpenAI::Internal::FileInput,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(OpenAI::Models::Beta::ChatKitUploadFileResponse::Variants)
+        end
+        def upload_file(
+          # Binary file contents to store with the ChatKit session. Supports PDFs and PNG,
+          # JPG, JPEG, GIF, or WEBP images.
+          file:,
+          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/beta.rbi

@@ -3,6 +3,9 @@
 module OpenAI
   module Resources
     class Beta
+      sig { returns(OpenAI::Resources::Beta::ChatKit) }
+      attr_reader :chatkit
+
       sig { returns(OpenAI::Resources::Beta::Assistants) }
       attr_reader :assistants
 

data/rbi/openai/resources/images.rbi

@@ -91,7 +91,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,
@@ -194,7 +195,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,