openai 0.28.1 → 0.30.0

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

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

@@ -0,0 +1,116 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      ChatKitAttachment = ChatKit::ChatKitAttachment
+
+      module ChatKit
+        class ChatKitAttachment < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatKitAttachment,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Identifier for the attachment.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # MIME type of the attachment.
+          sig { returns(String) }
+          attr_accessor :mime_type
+
+          # Original display name for the attachment.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # Preview URL for rendering the attachment inline.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :preview_url
+
+          # Attachment discriminator.
+          sig do
+            returns(
+              OpenAI::Beta::ChatKit::ChatKitAttachment::Type::TaggedSymbol
+            )
+          end
+          attr_accessor :type
+
+          # Attachment metadata included on thread items.
+          sig do
+            params(
+              id: String,
+              mime_type: String,
+              name: String,
+              preview_url: T.nilable(String),
+              type: OpenAI::Beta::ChatKit::ChatKitAttachment::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Identifier for the attachment.
+            id:,
+            # MIME type of the attachment.
+            mime_type:,
+            # Original display name for the attachment.
+            name:,
+            # Preview URL for rendering the attachment inline.
+            preview_url:,
+            # Attachment discriminator.
+            type:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                mime_type: String,
+                name: String,
+                preview_url: T.nilable(String),
+                type:
+                  OpenAI::Beta::ChatKit::ChatKitAttachment::Type::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Attachment discriminator.
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Beta::ChatKit::ChatKitAttachment::Type)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            IMAGE =
+              T.let(
+                :image,
+                OpenAI::Beta::ChatKit::ChatKitAttachment::Type::TaggedSymbol
+              )
+            FILE =
+              T.let(
+                :file,
+                OpenAI::Beta::ChatKit::ChatKitAttachment::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Beta::ChatKit::ChatKitAttachment::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,287 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      ChatKitResponseOutputText = ChatKit::ChatKitResponseOutputText
+
+      module ChatKit
+        class ChatKitResponseOutputText < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatKitResponseOutputText,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Ordered list of annotations attached to the response text.
+          sig do
+            returns(
+              T::Array[
+                OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::Variants
+              ]
+            )
+          end
+          attr_accessor :annotations
+
+          # Assistant generated text.
+          sig { returns(String) }
+          attr_accessor :text
+
+          # Type discriminator that is always `output_text`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Assistant response text accompanied by optional annotations.
+          sig do
+            params(
+              annotations:
+                T::Array[
+                  T.any(
+                    OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::OrHash,
+                    OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::OrHash
+                  )
+                ],
+              text: String,
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Ordered list of annotations attached to the response text.
+            annotations:,
+            # Assistant generated text.
+            text:,
+            # Type discriminator that is always `output_text`.
+            type: :output_text
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                annotations:
+                  T::Array[
+                    OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::Variants
+                  ],
+                text: String,
+                type: Symbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Annotation object describing a cited source.
+          module Annotation
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File,
+                  OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL
+                )
+              end
+
+            class File < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # File attachment referenced by the annotation.
+              sig do
+                returns(
+                  OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::Source
+                )
+              end
+              attr_reader :source
+
+              sig do
+                params(
+                  source:
+                    OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::Source::OrHash
+                ).void
+              end
+              attr_writer :source
+
+              # Type discriminator that is always `file` for this annotation.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Annotation that references an uploaded file.
+              sig do
+                params(
+                  source:
+                    OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::Source::OrHash,
+                  type: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # File attachment referenced by the annotation.
+                source:,
+                # Type discriminator that is always `file` for this annotation.
+                type: :file
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    source:
+                      OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::Source,
+                    type: Symbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class Source < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::Source,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                # Filename referenced by the annotation.
+                sig { returns(String) }
+                attr_accessor :filename
+
+                # Type discriminator that is always `file`.
+                sig { returns(Symbol) }
+                attr_accessor :type
+
+                # File attachment referenced by the annotation.
+                sig do
+                  params(filename: String, type: Symbol).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  # Filename referenced by the annotation.
+                  filename:,
+                  # Type discriminator that is always `file`.
+                  type: :file
+                )
+                end
+
+                sig { override.returns({ filename: String, type: Symbol }) }
+                def to_hash
+                end
+              end
+            end
+
+            class URL < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # URL referenced by the annotation.
+              sig do
+                returns(
+                  OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::Source
+                )
+              end
+              attr_reader :source
+
+              sig do
+                params(
+                  source:
+                    OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::Source::OrHash
+                ).void
+              end
+              attr_writer :source
+
+              # Type discriminator that is always `url` for this annotation.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Annotation that references a URL.
+              sig do
+                params(
+                  source:
+                    OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::Source::OrHash,
+                  type: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # URL referenced by the annotation.
+                source:,
+                # Type discriminator that is always `url` for this annotation.
+                type: :url
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    source:
+                      OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::Source,
+                    type: Symbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class Source < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::Source,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                # Type discriminator that is always `url`.
+                sig { returns(Symbol) }
+                attr_accessor :type
+
+                # URL referenced by the annotation.
+                sig { returns(String) }
+                attr_accessor :url
+
+                # URL referenced by the annotation.
+                sig do
+                  params(url: String, type: Symbol).returns(T.attached_class)
+                end
+                def self.new(
+                  # URL referenced by the annotation.
+                  url:,
+                  # Type discriminator that is always `url`.
+                  type: :url
+                )
+                end
+
+                sig { override.returns({ type: Symbol, url: String }) }
+                def to_hash
+                end
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+        end
+      end
+    end
+  end
+end