openai 0.28.1 → 0.30.0

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

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

@@ -0,0 +1,256 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatSessionChatKitConfigurationParam < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Configuration for automatic thread titling. When omitted, automatic thread
+          # titling is enabled by default.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling
+              )
+            )
+          end
+          attr_reader :automatic_thread_titling
+
+          sig do
+            params(
+              automatic_thread_titling:
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling::OrHash
+            ).void
+          end
+          attr_writer :automatic_thread_titling
+
+          # Configuration for upload enablement and limits. When omitted, uploads are
+          # disabled by default (max_files 10, max_file_size 512 MB).
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload
+              )
+            )
+          end
+          attr_reader :file_upload
+
+          sig do
+            params(
+              file_upload:
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload::OrHash
+            ).void
+          end
+          attr_writer :file_upload
+
+          # Configuration for chat history retention. When omitted, history is enabled by
+          # default with no limit on recent_threads (null).
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History
+              )
+            )
+          end
+          attr_reader :history
+
+          sig do
+            params(
+              history:
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History::OrHash
+            ).void
+          end
+          attr_writer :history
+
+          # Optional per-session configuration settings for ChatKit behavior.
+          sig do
+            params(
+              automatic_thread_titling:
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling::OrHash,
+              file_upload:
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload::OrHash,
+              history:
+                OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Configuration for automatic thread titling. When omitted, automatic thread
+            # titling is enabled by default.
+            automatic_thread_titling: nil,
+            # Configuration for upload enablement and limits. When omitted, uploads are
+            # disabled by default (max_files 10, max_file_size 512 MB).
+            file_upload: nil,
+            # Configuration for chat history retention. When omitted, history is enabled by
+            # default with no limit on recent_threads (null).
+            history: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                automatic_thread_titling:
+                  OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling,
+                file_upload:
+                  OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload,
+                history:
+                  OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class AutomaticThreadTitling < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Enable automatic thread title generation. Defaults to true.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :enabled
+
+            sig { params(enabled: T::Boolean).void }
+            attr_writer :enabled
+
+            # Configuration for automatic thread titling. When omitted, automatic thread
+            # titling is enabled by default.
+            sig { params(enabled: T::Boolean).returns(T.attached_class) }
+            def self.new(
+              # Enable automatic thread title generation. Defaults to true.
+              enabled: nil
+            )
+            end
+
+            sig { override.returns({ enabled: T::Boolean }) }
+            def to_hash
+            end
+          end
+
+          class FileUpload < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Enable uploads for this session. Defaults to false.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :enabled
+
+            sig { params(enabled: T::Boolean).void }
+            attr_writer :enabled
+
+            # Maximum size in megabytes for each uploaded file. Defaults to 512 MB, which is
+            # the maximum allowable size.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :max_file_size
+
+            sig { params(max_file_size: Integer).void }
+            attr_writer :max_file_size
+
+            # Maximum number of files that can be uploaded to the session. Defaults to 10.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :max_files
+
+            sig { params(max_files: Integer).void }
+            attr_writer :max_files
+
+            # Configuration for upload enablement and limits. When omitted, uploads are
+            # disabled by default (max_files 10, max_file_size 512 MB).
+            sig do
+              params(
+                enabled: T::Boolean,
+                max_file_size: Integer,
+                max_files: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Enable uploads for this session. Defaults to false.
+              enabled: nil,
+              # Maximum size in megabytes for each uploaded file. Defaults to 512 MB, which is
+              # the maximum allowable size.
+              max_file_size: nil,
+              # Maximum number of files that can be uploaded to the session. Defaults to 10.
+              max_files: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  enabled: T::Boolean,
+                  max_file_size: Integer,
+                  max_files: Integer
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class History < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Enables chat users to access previous ChatKit threads. Defaults to true.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :enabled
+
+            sig { params(enabled: T::Boolean).void }
+            attr_writer :enabled
+
+            # Number of recent ChatKit threads users have access to. Defaults to unlimited
+            # when unset.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :recent_threads
+
+            sig { params(recent_threads: Integer).void }
+            attr_writer :recent_threads
+
+            # Configuration for chat history retention. When omitted, history is enabled by
+            # default with no limit on recent_threads (null).
+            sig do
+              params(enabled: T::Boolean, recent_threads: Integer).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # Enables chat users to access previous ChatKit threads. Defaults to true.
+              enabled: nil,
+              # Number of recent ChatKit threads users have access to. Defaults to unlimited
+              # when unset.
+              recent_threads: nil
+            )
+            end
+
+            sig do
+              override.returns({ enabled: T::Boolean, recent_threads: Integer })
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatSessionExpiresAfterParam < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatSessionExpiresAfterParam,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Base timestamp used to calculate expiration. Currently fixed to `created_at`.
+          sig { returns(Symbol) }
+          attr_accessor :anchor
+
+          # Number of seconds after the anchor when the session expires.
+          sig { returns(Integer) }
+          attr_accessor :seconds
+
+          # Controls when the session expires relative to an anchor timestamp.
+          sig do
+            params(seconds: Integer, anchor: Symbol).returns(T.attached_class)
+          end
+          def self.new(
+            # Number of seconds after the anchor when the session expires.
+            seconds:,
+            # Base timestamp used to calculate expiration. Currently fixed to `created_at`.
+            anchor: :created_at
+          )
+          end
+
+          sig { override.returns({ anchor: Symbol, seconds: Integer }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatSessionFileUpload < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatSessionFileUpload,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Indicates if uploads are enabled for the session.
+          sig { returns(T::Boolean) }
+          attr_accessor :enabled
+
+          # Maximum upload size in megabytes.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :max_file_size
+
+          # Maximum number of uploads allowed during the session.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :max_files
+
+          # Upload permissions and limits applied to the session.
+          sig do
+            params(
+              enabled: T::Boolean,
+              max_file_size: T.nilable(Integer),
+              max_files: T.nilable(Integer)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Indicates if uploads are enabled for the session.
+            enabled:,
+            # Maximum upload size in megabytes.
+            max_file_size:,
+            # Maximum number of uploads allowed during the session.
+            max_files:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                enabled: T::Boolean,
+                max_file_size: T.nilable(Integer),
+                max_files: T.nilable(Integer)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatSessionHistory < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatSessionHistory,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Indicates if chat history is persisted for the session.
+          sig { returns(T::Boolean) }
+          attr_accessor :enabled
+
+          # Number of prior threads surfaced in history views. Defaults to null when all
+          # history is retained.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :recent_threads
+
+          # History retention preferences returned for the session.
+          sig do
+            params(
+              enabled: T::Boolean,
+              recent_threads: T.nilable(Integer)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Indicates if chat history is persisted for the session.
+            enabled:,
+            # Number of prior threads surfaced in history views. Defaults to null when all
+            # history is retained.
+            recent_threads:
+          )
+          end
+
+          sig do
+            override.returns(
+              { enabled: T::Boolean, recent_threads: T.nilable(Integer) }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end