openai 0.29.0 → 0.30.0

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

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

@@ -0,0 +1,220 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      ChatKitThread = ChatKit::ChatKitThread
+
+      module ChatKit
+        class ChatKitThread < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatKitThread,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Identifier of the thread.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Unix timestamp (in seconds) for when the thread was created.
+          sig { returns(Integer) }
+          attr_accessor :created_at
+
+          # Type discriminator that is always `chatkit.thread`.
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # Current status for the thread. Defaults to `active` for newly created threads.
+          sig do
+            returns(OpenAI::Beta::ChatKit::ChatKitThread::Status::Variants)
+          end
+          attr_accessor :status
+
+          # Optional human-readable title for the thread. Defaults to null when no title has
+          # been generated.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :title
+
+          # Free-form string that identifies your end user who owns the thread.
+          sig { returns(String) }
+          attr_accessor :user
+
+          # Represents a ChatKit thread and its current status.
+          sig do
+            params(
+              id: String,
+              created_at: Integer,
+              status:
+                T.any(
+                  OpenAI::Beta::ChatKit::ChatKitThread::Status::Active::OrHash,
+                  OpenAI::Beta::ChatKit::ChatKitThread::Status::Locked::OrHash,
+                  OpenAI::Beta::ChatKit::ChatKitThread::Status::Closed::OrHash
+                ),
+              title: T.nilable(String),
+              user: String,
+              object: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Identifier of the thread.
+            id:,
+            # Unix timestamp (in seconds) for when the thread was created.
+            created_at:,
+            # Current status for the thread. Defaults to `active` for newly created threads.
+            status:,
+            # Optional human-readable title for the thread. Defaults to null when no title has
+            # been generated.
+            title:,
+            # Free-form string that identifies your end user who owns the thread.
+            user:,
+            # Type discriminator that is always `chatkit.thread`.
+            object: :"chatkit.thread"
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Integer,
+                object: Symbol,
+                status: OpenAI::Beta::ChatKit::ChatKitThread::Status::Variants,
+                title: T.nilable(String),
+                user: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Current status for the thread. Defaults to `active` for newly created threads.
+          module Status
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::ChatKit::ChatKitThread::Status::Active,
+                  OpenAI::Beta::ChatKit::ChatKitThread::Status::Locked,
+                  OpenAI::Beta::ChatKit::ChatKitThread::Status::Closed
+                )
+              end
+
+            class Active < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Beta::ChatKit::ChatKitThread::Status::Active,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # Status discriminator that is always `active`.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Indicates that a thread is active.
+              sig { params(type: Symbol).returns(T.attached_class) }
+              def self.new(
+                # Status discriminator that is always `active`.
+                type: :active
+              )
+              end
+
+              sig { override.returns({ type: Symbol }) }
+              def to_hash
+              end
+            end
+
+            class Locked < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Beta::ChatKit::ChatKitThread::Status::Locked,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # Reason that the thread was locked. Defaults to null when no reason is recorded.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :reason
+
+              # Status discriminator that is always `locked`.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Indicates that a thread is locked and cannot accept new input.
+              sig do
+                params(reason: T.nilable(String), type: Symbol).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # Reason that the thread was locked. Defaults to null when no reason is recorded.
+                reason:,
+                # Status discriminator that is always `locked`.
+                type: :locked
+              )
+              end
+
+              sig do
+                override.returns({ reason: T.nilable(String), type: Symbol })
+              end
+              def to_hash
+              end
+            end
+
+            class Closed < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Beta::ChatKit::ChatKitThread::Status::Closed,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # Reason that the thread was closed. Defaults to null when no reason is recorded.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :reason
+
+              # Status discriminator that is always `closed`.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Indicates that a thread has been closed.
+              sig do
+                params(reason: T.nilable(String), type: Symbol).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                # Reason that the thread was closed. Defaults to null when no reason is recorded.
+                reason:,
+                # Status discriminator that is always `closed`.
+                type: :closed
+              )
+              end
+
+              sig do
+                override.returns({ reason: T.nilable(String), type: Symbol })
+              end
+              def to_hash
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[OpenAI::Beta::ChatKit::ChatKitThread::Status::Variants]
+              )
+            end
+            def self.variants
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      ChatKitThreadAssistantMessageItem =
+        ChatKit::ChatKitThreadAssistantMessageItem
+
+      module ChatKit
+        class ChatKitThreadAssistantMessageItem < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ChatKitThreadAssistantMessageItem,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Identifier of the thread item.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Ordered assistant response segments.
+          sig do
+            returns(T::Array[OpenAI::Beta::ChatKit::ChatKitResponseOutputText])
+          end
+          attr_accessor :content
+
+          # Unix timestamp (in seconds) for when the item was created.
+          sig { returns(Integer) }
+          attr_accessor :created_at
+
+          # Type discriminator that is always `chatkit.thread_item`.
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # Identifier of the parent thread.
+          sig { returns(String) }
+          attr_accessor :thread_id
+
+          # Type discriminator that is always `chatkit.assistant_message`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Assistant-authored message within a thread.
+          sig do
+            params(
+              id: String,
+              content:
+                T::Array[
+                  OpenAI::Beta::ChatKit::ChatKitResponseOutputText::OrHash
+                ],
+              created_at: Integer,
+              thread_id: String,
+              object: Symbol,
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Identifier of the thread item.
+            id:,
+            # Ordered assistant response segments.
+            content:,
+            # Unix timestamp (in seconds) for when the item was created.
+            created_at:,
+            # Identifier of the parent thread.
+            thread_id:,
+            # Type discriminator that is always `chatkit.thread_item`.
+            object: :"chatkit.thread_item",
+            # Type discriminator that is always `chatkit.assistant_message`.
+            type: :"chatkit.assistant_message"
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                content:
+                  T::Array[OpenAI::Beta::ChatKit::ChatKitResponseOutputText],
+                created_at: Integer,
+                object: Symbol,
+                thread_id: String,
+                type: Symbol
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end