openai 0.29.0 → 0.30.0

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

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

@@ -0,0 +1,37 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatSessionRateLimits < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatSessionRateLimits,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Maximum allowed requests per one-minute window.
+          sig { returns(Integer) }
+          attr_accessor :max_requests_per_1_minute
+
+          # Active per-minute request limit for the session.
+          sig do
+            params(max_requests_per_1_minute: Integer).returns(T.attached_class)
+          end
+          def self.new(
+            # Maximum allowed requests per one-minute window.
+            max_requests_per_1_minute:
+          )
+          end
+
+          sig { override.returns({ max_requests_per_1_minute: Integer }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatSessionRateLimitsParam < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatSessionRateLimitsParam,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Maximum number of requests allowed per minute for the session. Defaults to 10.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :max_requests_per_1_minute
+
+          sig { params(max_requests_per_1_minute: Integer).void }
+          attr_writer :max_requests_per_1_minute
+
+          # Controls request rate limits for the session.
+          sig do
+            params(max_requests_per_1_minute: Integer).returns(T.attached_class)
+          end
+          def self.new(
+            # Maximum number of requests allowed per minute for the session. Defaults to 10.
+            max_requests_per_1_minute: nil
+          )
+          end
+
+          sig { override.returns({ max_requests_per_1_minute: Integer }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        module ChatSessionStatus
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Beta::ChatKit::ChatSessionStatus)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTIVE =
+            T.let(
+              :active,
+              OpenAI::Beta::ChatKit::ChatSessionStatus::TaggedSymbol
+            )
+          EXPIRED =
+            T.let(
+              :expired,
+              OpenAI::Beta::ChatKit::ChatSessionStatus::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :cancelled,
+              OpenAI::Beta::ChatKit::ChatSessionStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Beta::ChatKit::ChatSessionStatus::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,166 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatSessionWorkflowParam < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatSessionWorkflowParam,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Identifier for the workflow invoked by the session.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # State variables forwarded to the workflow. Keys may be up to 64 characters,
+          # values must be primitive types, and the map defaults to an empty object.
+          sig do
+            returns(
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::StateVariable::Variants
+                ]
+              )
+            )
+          end
+          attr_reader :state_variables
+
+          sig do
+            params(
+              state_variables:
+                T::Hash[
+                  Symbol,
+                  OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::StateVariable::Variants
+                ]
+            ).void
+          end
+          attr_writer :state_variables
+
+          # Optional tracing overrides for the workflow invocation. When omitted, tracing is
+          # enabled by default.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::Tracing
+              )
+            )
+          end
+          attr_reader :tracing
+
+          sig do
+            params(
+              tracing:
+                OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::Tracing::OrHash
+            ).void
+          end
+          attr_writer :tracing
+
+          # Specific workflow version to run. Defaults to the latest deployed version.
+          sig { returns(T.nilable(String)) }
+          attr_reader :version
+
+          sig { params(version: String).void }
+          attr_writer :version
+
+          # Workflow reference and overrides applied to the chat session.
+          sig do
+            params(
+              id: String,
+              state_variables:
+                T::Hash[
+                  Symbol,
+                  OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::StateVariable::Variants
+                ],
+              tracing:
+                OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::Tracing::OrHash,
+              version: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Identifier for the workflow invoked by the session.
+            id:,
+            # State variables forwarded to the workflow. Keys may be up to 64 characters,
+            # values must be primitive types, and the map defaults to an empty object.
+            state_variables: nil,
+            # Optional tracing overrides for the workflow invocation. When omitted, tracing is
+            # enabled by default.
+            tracing: nil,
+            # Specific workflow version to run. Defaults to the latest deployed version.
+            version: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                state_variables:
+                  T::Hash[
+                    Symbol,
+                    OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::StateVariable::Variants
+                  ],
+                tracing:
+                  OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::Tracing,
+                version: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module StateVariable
+            extend OpenAI::Internal::Type::Union
+
+            Variants = T.type_alias { T.any(String, T::Boolean, Float) }
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::StateVariable::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
+          class Tracing < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::Tracing,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Whether tracing is enabled during the session. Defaults to true.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :enabled
+
+            sig { params(enabled: T::Boolean).void }
+            attr_writer :enabled
+
+            # Optional tracing overrides for the workflow invocation. When omitted, tracing is
+            # enabled by default.
+            sig { params(enabled: T::Boolean).returns(T.attached_class) }
+            def self.new(
+              # Whether tracing is enabled during the session. Defaults to true.
+              enabled: nil
+            )
+            end
+
+            sig { override.returns({ enabled: T::Boolean }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end