openai 0.29.0 → 0.30.0

data/lib/openai/models/beta/chatkit/chatkit_attachment.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatKitAttachment < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifier for the attachment.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute mime_type
+          #   MIME type of the attachment.
+          #
+          #   @return [String]
+          required :mime_type, String
+
+          # @!attribute name
+          #   Original display name for the attachment.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute preview_url
+          #   Preview URL for rendering the attachment inline.
+          #
+          #   @return [String, nil]
+          required :preview_url, String, nil?: true
+
+          # @!attribute type
+          #   Attachment discriminator.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitAttachment::Type]
+          required :type, enum: -> { OpenAI::Beta::ChatKit::ChatKitAttachment::Type }
+
+          # @!method initialize(id:, mime_type:, name:, preview_url:, type:)
+          #   Attachment metadata included on thread items.
+          #
+          #   @param id [String] Identifier for the attachment.
+          #
+          #   @param mime_type [String] MIME type of the attachment.
+          #
+          #   @param name [String] Original display name for the attachment.
+          #
+          #   @param preview_url [String, nil] Preview URL for rendering the attachment inline.
+          #
+          #   @param type [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitAttachment::Type] Attachment discriminator.
+
+          # Attachment discriminator.
+          #
+          # @see OpenAI::Models::Beta::ChatKit::ChatKitAttachment#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            IMAGE = :image
+            FILE = :file
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
+      ChatKitAttachment = ChatKit::ChatKitAttachment
+    end
+  end
+end

data/lib/openai/models/beta/chatkit/chatkit_response_output_text.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatKitResponseOutputText < OpenAI::Internal::Type::BaseModel
+          # @!attribute annotations
+          #   Ordered list of annotations attached to the response text.
+          #
+          #   @return [Array<OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File, OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL>]
+          required :annotations,
+                   -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation] }
+
+          # @!attribute text
+          #   Assistant generated text.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   Type discriminator that is always `output_text`.
+          #
+          #   @return [Symbol, :output_text]
+          required :type, const: :output_text
+
+          # @!method initialize(annotations:, text:, type: :output_text)
+          #   Assistant response text accompanied by optional annotations.
+          #
+          #   @param annotations [Array<OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File, OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL>] Ordered list of annotations attached to the response text.
+          #
+          #   @param text [String] Assistant generated text.
+          #
+          #   @param type [Symbol, :output_text] Type discriminator that is always `output_text`.
+
+          # Annotation object describing a cited source.
+          module Annotation
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # Annotation that references an uploaded file.
+            variant :file, -> { OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File }
+
+            # Annotation that references a URL.
+            variant :url, -> { OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL }
+
+            class File < OpenAI::Internal::Type::BaseModel
+              # @!attribute source
+              #   File attachment referenced by the annotation.
+              #
+              #   @return [OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::Source]
+              required :source, -> { OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::Source }
+
+              # @!attribute type
+              #   Type discriminator that is always `file` for this annotation.
+              #
+              #   @return [Symbol, :file]
+              required :type, const: :file
+
+              # @!method initialize(source:, type: :file)
+              #   Annotation that references an uploaded file.
+              #
+              #   @param source [OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::Source] File attachment referenced by the annotation.
+              #
+              #   @param type [Symbol, :file] Type discriminator that is always `file` for this annotation.
+
+              # @see OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File#source
+              class Source < OpenAI::Internal::Type::BaseModel
+                # @!attribute filename
+                #   Filename referenced by the annotation.
+                #
+                #   @return [String]
+                required :filename, String
+
+                # @!attribute type
+                #   Type discriminator that is always `file`.
+                #
+                #   @return [Symbol, :file]
+                required :type, const: :file
+
+                # @!method initialize(filename:, type: :file)
+                #   File attachment referenced by the annotation.
+                #
+                #   @param filename [String] Filename referenced by the annotation.
+                #
+                #   @param type [Symbol, :file] Type discriminator that is always `file`.
+              end
+            end
+
+            class URL < OpenAI::Internal::Type::BaseModel
+              # @!attribute source
+              #   URL referenced by the annotation.
+              #
+              #   @return [OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::Source]
+              required :source, -> { OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::Source }
+
+              # @!attribute type
+              #   Type discriminator that is always `url` for this annotation.
+              #
+              #   @return [Symbol, :url]
+              required :type, const: :url
+
+              # @!method initialize(source:, type: :url)
+              #   Annotation that references a URL.
+              #
+              #   @param source [OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::Source] URL referenced by the annotation.
+              #
+              #   @param type [Symbol, :url] Type discriminator that is always `url` for this annotation.
+
+              # @see OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL#source
+              class Source < OpenAI::Internal::Type::BaseModel
+                # @!attribute type
+                #   Type discriminator that is always `url`.
+                #
+                #   @return [Symbol, :url]
+                required :type, const: :url
+
+                # @!attribute url
+                #   URL referenced by the annotation.
+                #
+                #   @return [String]
+                required :url, String
+
+                # @!method initialize(url:, type: :url)
+                #   URL referenced by the annotation.
+                #
+                #   @param url [String] URL referenced by the annotation.
+                #
+                #   @param type [Symbol, :url] Type discriminator that is always `url`.
+              end
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File, OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL)]
+          end
+        end
+      end
+
+      ChatKitResponseOutputText = ChatKit::ChatKitResponseOutputText
+    end
+  end
+end

data/lib/openai/models/beta/chatkit/chatkit_thread.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        # @see OpenAI::Resources::Beta::ChatKit::Threads#retrieve
+        class ChatKitThread < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifier of the thread.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   Unix timestamp (in seconds) for when the thread was created.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute object
+          #   Type discriminator that is always `chatkit.thread`.
+          #
+          #   @return [Symbol, :"chatkit.thread"]
+          required :object, const: :"chatkit.thread"
+
+          # @!attribute status
+          #   Current status for the thread. Defaults to `active` for newly created threads.
+          #
+          #   @return [OpenAI::Models::Beta::ChatKit::ChatKitThread::Status::Active, OpenAI::Models::Beta::ChatKit::ChatKitThread::Status::Locked, OpenAI::Models::Beta::ChatKit::ChatKitThread::Status::Closed]
+          required :status, union: -> { OpenAI::Beta::ChatKit::ChatKitThread::Status }
+
+          # @!attribute title
+          #   Optional human-readable title for the thread. Defaults to null when no title has
+          #   been generated.
+          #
+          #   @return [String, nil]
+          required :title, String, nil?: true
+
+          # @!attribute user
+          #   Free-form string that identifies your end user who owns the thread.
+          #
+          #   @return [String]
+          required :user, String
+
+          # @!method initialize(id:, created_at:, status:, title:, user:, object: :"chatkit.thread")
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Beta::ChatKit::ChatKitThread} for more details.
+          #
+          #   Represents a ChatKit thread and its current status.
+          #
+          #   @param id [String] Identifier of the thread.
+          #
+          #   @param created_at [Integer] Unix timestamp (in seconds) for when the thread was created.
+          #
+          #   @param status [OpenAI::Models::Beta::ChatKit::ChatKitThread::Status::Active, OpenAI::Models::Beta::ChatKit::ChatKitThread::Status::Locked, OpenAI::Models::Beta::ChatKit::ChatKitThread::Status::Closed] Current status for the thread. Defaults to `active` for newly created threads.
+          #
+          #   @param title [String, nil] Optional human-readable title for the thread. Defaults to null when no title has
+          #
+          #   @param user [String] Free-form string that identifies your end user who owns the thread.
+          #
+          #   @param object [Symbol, :"chatkit.thread"] Type discriminator that is always `chatkit.thread`.
+
+          # Current status for the thread. Defaults to `active` for newly created threads.
+          #
+          # @see OpenAI::Models::Beta::ChatKit::ChatKitThread#status
+          module Status
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # Indicates that a thread is active.
+            variant :active, -> { OpenAI::Beta::ChatKit::ChatKitThread::Status::Active }
+
+            # Indicates that a thread is locked and cannot accept new input.
+            variant :locked, -> { OpenAI::Beta::ChatKit::ChatKitThread::Status::Locked }
+
+            # Indicates that a thread has been closed.
+            variant :closed, -> { OpenAI::Beta::ChatKit::ChatKitThread::Status::Closed }
+
+            class Active < OpenAI::Internal::Type::BaseModel
+              # @!attribute type
+              #   Status discriminator that is always `active`.
+              #
+              #   @return [Symbol, :active]
+              required :type, const: :active
+
+              # @!method initialize(type: :active)
+              #   Indicates that a thread is active.
+              #
+              #   @param type [Symbol, :active] Status discriminator that is always `active`.
+            end
+
+            class Locked < OpenAI::Internal::Type::BaseModel
+              # @!attribute reason
+              #   Reason that the thread was locked. Defaults to null when no reason is recorded.
+              #
+              #   @return [String, nil]
+              required :reason, String, nil?: true
+
+              # @!attribute type
+              #   Status discriminator that is always `locked`.
+              #
+              #   @return [Symbol, :locked]
+              required :type, const: :locked
+
+              # @!method initialize(reason:, type: :locked)
+              #   Indicates that a thread is locked and cannot accept new input.
+              #
+              #   @param reason [String, nil] Reason that the thread was locked. Defaults to null when no reason is recorded.
+              #
+              #   @param type [Symbol, :locked] Status discriminator that is always `locked`.
+            end
+
+            class Closed < OpenAI::Internal::Type::BaseModel
+              # @!attribute reason
+              #   Reason that the thread was closed. Defaults to null when no reason is recorded.
+              #
+              #   @return [String, nil]
+              required :reason, String, nil?: true
+
+              # @!attribute type
+              #   Status discriminator that is always `closed`.
+              #
+              #   @return [Symbol, :closed]
+              required :type, const: :closed
+
+              # @!method initialize(reason:, type: :closed)
+              #   Indicates that a thread has been closed.
+              #
+              #   @param reason [String, nil] Reason that the thread was closed. Defaults to null when no reason is recorded.
+              #
+              #   @param type [Symbol, :closed] Status discriminator that is always `closed`.
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Beta::ChatKit::ChatKitThread::Status::Active, OpenAI::Models::Beta::ChatKit::ChatKitThread::Status::Locked, OpenAI::Models::Beta::ChatKit::ChatKitThread::Status::Closed)]
+          end
+        end
+      end
+
+      ChatKitThread = ChatKit::ChatKitThread
+    end
+  end
+end

data/lib/openai/models/beta/chatkit/chatkit_thread_assistant_message_item.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ChatKitThreadAssistantMessageItem < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifier of the thread item.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute content
+          #   Ordered assistant response segments.
+          #
+          #   @return [Array<OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText>]
+          required :content,
+                   -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::ChatKit::ChatKitResponseOutputText] }
+
+          # @!attribute created_at
+          #   Unix timestamp (in seconds) for when the item was created.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute object
+          #   Type discriminator that is always `chatkit.thread_item`.
+          #
+          #   @return [Symbol, :"chatkit.thread_item"]
+          required :object, const: :"chatkit.thread_item"
+
+          # @!attribute thread_id
+          #   Identifier of the parent thread.
+          #
+          #   @return [String]
+          required :thread_id, String
+
+          # @!attribute type
+          #   Type discriminator that is always `chatkit.assistant_message`.
+          #
+          #   @return [Symbol, :"chatkit.assistant_message"]
+          required :type, const: :"chatkit.assistant_message"
+
+          # @!method initialize(id:, content:, created_at:, thread_id:, object: :"chatkit.thread_item", type: :"chatkit.assistant_message")
+          #   Assistant-authored message within a thread.
+          #
+          #   @param id [String] Identifier of the thread item.
+          #
+          #   @param content [Array<OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText>] Ordered assistant response segments.
+          #
+          #   @param created_at [Integer] Unix timestamp (in seconds) for when the item was created.
+          #
+          #   @param thread_id [String] Identifier of the parent thread.
+          #
+          #   @param object [Symbol, :"chatkit.thread_item"] Type discriminator that is always `chatkit.thread_item`.
+          #
+          #   @param type [Symbol, :"chatkit.assistant_message"] Type discriminator that is always `chatkit.assistant_message`.
+        end
+      end
+
+      ChatKitThreadAssistantMessageItem = ChatKit::ChatKitThreadAssistantMessageItem
+    end
+  end
+end