openai 0.92.0 → 0.94.0

data/sig/openai/models/beta/chatkit/chat_session_workflow_param.rbs

@@ -11,24 +11,45 @@ module OpenAI
           }
 
         class ChatSessionWorkflowParam < OpenAI::Internal::Type::BaseModel
+          # Identifier for the workflow invoked by the session.
           attr_accessor id: String
 
+          # 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.
           attr_reader state_variables: ::Hash[Symbol, OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam::state_variable]?
 
+          # 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.
           def state_variables=: (
             ::Hash[Symbol, OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam::state_variable]
           ) -> ::Hash[Symbol, OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam::state_variable]
 
+          # Optional tracing overrides for the workflow invocation. When omitted, tracing is
+          # enabled by default.
           attr_reader tracing: OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::Tracing?
 
+          # Optional tracing overrides for the workflow invocation. When omitted, tracing is
+          # enabled by default.
           def tracing=: (
             OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::Tracing
           ) -> OpenAI::Beta::ChatKit::ChatSessionWorkflowParam::Tracing
 
+          # Specific workflow version to run. Defaults to the latest deployed version.
           attr_reader version: String?
 
+          # Specific workflow version to run. Defaults to the latest deployed version.
           def version=: (String) -> String
 
+          # @param id
+          #   Identifier for the workflow invoked by the session.
+          # @param state_variables
+          #   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.
+          # @param tracing
+          #   Optional tracing overrides for the workflow invocation. When omitted, tracing is
+          #   enabled by default.
+          # @param version
+          #   Specific workflow version to run. Defaults to the latest deployed version.
           def initialize: (
             id: String,
             ?state_variables: ::Hash[Symbol, OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam::state_variable],
@@ -54,10 +75,14 @@ module OpenAI
           type tracing = { ?enabled: bool }
 
           class Tracing < OpenAI::Internal::Type::BaseModel
+            # Whether tracing is enabled during the session. Defaults to true.
             attr_reader enabled: bool?
 
+            # Whether tracing is enabled during the session. Defaults to true.
             def enabled=: (bool) -> bool
 
+            # @param enabled
+            #   Whether tracing is enabled during the session. Defaults to true.
             def initialize: (?enabled: bool) -> void
 
             def to_hash: -> { ?enabled: bool }

data/sig/openai/models/beta/chatkit/chatkit_attachment.rbs

@@ -14,16 +14,31 @@ module OpenAI
           }
 
         class ChatKitAttachment < OpenAI::Internal::Type::BaseModel
+          # Identifier for the attachment.
           attr_accessor id: String
 
+          # MIME type of the attachment.
           attr_accessor mime_type: String
 
+          # Original display name for the attachment.
           attr_accessor name: String
 
+          # Preview URL for rendering the attachment inline.
           attr_accessor preview_url: String?
 
+          # Attachment discriminator.
           attr_accessor type: OpenAI::Models::Beta::ChatKit::ChatKitAttachment::type_
 
+          # @param id
+          #   Identifier for the attachment.
+          # @param mime_type
+          #   MIME type of the attachment.
+          # @param name
+          #   Original display name for the attachment.
+          # @param preview_url
+          #   Preview URL for rendering the attachment inline.
+          # @param type
+          #   Attachment discriminator.
           def initialize: (
             id: String,
             mime_type: String,

data/sig/openai/models/beta/chatkit/chatkit_response_output_text.rbs

@@ -12,12 +12,21 @@ module OpenAI
           }
 
         class ChatKitResponseOutputText < OpenAI::Internal::Type::BaseModel
+          # Ordered list of annotations attached to the response text.
           attr_accessor annotations: ::Array[OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::annotation]
 
+          # Assistant generated text.
           attr_accessor text: String
 
+          # Type discriminator that is always `output_text`.
           attr_accessor type: :output_text
 
+          # @param annotations
+          #   Ordered list of annotations attached to the response text.
+          # @param text
+          #   Assistant generated text.
+          # @param type
+          #   Type discriminator that is always `output_text`.
           def initialize: (
             annotations: ::Array[OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText::annotation],
             text: String,
@@ -44,10 +53,16 @@ module OpenAI
               }
 
             class File < OpenAI::Internal::Type::BaseModel
+              # File attachment referenced by the annotation.
               attr_accessor source: OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::Source
 
+              # Type discriminator that is always `file` for this annotation.
               attr_accessor type: :file
 
+              # @param source
+              #   File attachment referenced by the annotation.
+              # @param type
+              #   Type discriminator that is always `file` for this annotation.
               def initialize: (
                 source: OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::File::Source,
                 ?type: :file
@@ -61,10 +76,16 @@ module OpenAI
               type source = { filename: String, ?type: :file }
 
               class Source < OpenAI::Internal::Type::BaseModel
+                # Filename referenced by the annotation.
                 attr_accessor filename: String
 
+                # Type discriminator that is always `file`.
                 attr_accessor type: :file
 
+                # @param filename
+                #   Filename referenced by the annotation.
+                # @param type
+                #   Type discriminator that is always `file`.
                 def initialize: (filename: String, ?type: :file) -> void
 
                 def to_hash: -> { filename: String, ?type: :file }
@@ -78,10 +99,16 @@ module OpenAI
               }
 
             class URL < OpenAI::Internal::Type::BaseModel
+              # URL referenced by the annotation.
               attr_accessor source: OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::Source
 
+              # Type discriminator that is always `url` for this annotation.
               attr_accessor type: :url
 
+              # @param source
+              #   URL referenced by the annotation.
+              # @param type
+              #   Type discriminator that is always `url` for this annotation.
               def initialize: (
                 source: OpenAI::Beta::ChatKit::ChatKitResponseOutputText::Annotation::URL::Source,
                 ?type: :url
@@ -95,10 +122,16 @@ module OpenAI
               type source = { ?type: :url, url: String }
 
               class Source < OpenAI::Internal::Type::BaseModel
+                # Type discriminator that is always `url`.
                 attr_accessor type: :url
 
+                # URL referenced by the annotation.
                 attr_accessor url: String
 
+                # @param url
+                #   URL referenced by the annotation.
+                # @param type
+                #   Type discriminator that is always `url`.
                 def initialize: (url: String, ?type: :url) -> void
 
                 def to_hash: -> { ?type: :url, url: String }

data/sig/openai/models/beta/chatkit/chatkit_thread.rbs

@@ -15,18 +15,38 @@ module OpenAI
           }
 
         class ChatKitThread < OpenAI::Internal::Type::BaseModel
+          # Identifier of the thread.
           attr_accessor id: String
 
+          # Unix timestamp (in seconds) for when the thread was created.
           attr_accessor created_at: Integer
 
+          # Type discriminator that is always `chatkit.thread`.
           attr_accessor object: :"chatkit.thread"
 
+          # Current status for the thread. Defaults to `active` for newly created threads.
           attr_accessor status: OpenAI::Models::Beta::ChatKit::ChatKitThread::status
 
+          # Optional human-readable title for the thread. Defaults to null when no title has
+          # been generated.
           attr_accessor title: String?
 
+          # Free-form string that identifies your end user who owns the thread.
           attr_accessor user: String
 
+          # @param id
+          #   Identifier of the thread.
+          # @param created_at
+          #   Unix timestamp (in seconds) for when the thread was created.
+          # @param status
+          #   Current status for the thread. Defaults to `active` for newly created threads.
+          # @param title
+          #   Optional human-readable title for the thread. Defaults to null when no title has
+          #   been generated.
+          # @param user
+          #   Free-form string that identifies your end user who owns the thread.
+          # @param object
+          #   Type discriminator that is always `chatkit.thread`.
           def initialize: (
             id: String,
             created_at: Integer,
@@ -56,8 +76,11 @@ module OpenAI
             type active = { ?type: :active }
 
             class Active < OpenAI::Internal::Type::BaseModel
+              # Status discriminator that is always `active`.
               attr_accessor type: :active
 
+              # @param type
+              #   Status discriminator that is always `active`.
               def initialize: (?type: :active) -> void
 
               def to_hash: -> { ?type: :active }
@@ -66,10 +89,16 @@ module OpenAI
             type locked = { reason: String?, ?type: :locked }
 
             class Locked < OpenAI::Internal::Type::BaseModel
+              # Reason that the thread was locked. Defaults to null when no reason is recorded.
               attr_accessor reason: String?
 
+              # Status discriminator that is always `locked`.
               attr_accessor type: :locked
 
+              # @param reason
+              #   Reason that the thread was locked. Defaults to null when no reason is recorded.
+              # @param type
+              #   Status discriminator that is always `locked`.
               def initialize: (reason: String?, ?type: :locked) -> void
 
               def to_hash: -> { reason: String?, ?type: :locked }
@@ -78,10 +107,16 @@ module OpenAI
             type closed = { reason: String?, ?type: :closed }
 
             class Closed < OpenAI::Internal::Type::BaseModel
+              # Reason that the thread was closed. Defaults to null when no reason is recorded.
               attr_accessor reason: String?
 
+              # Status discriminator that is always `closed`.
               attr_accessor type: :closed
 
+              # @param reason
+              #   Reason that the thread was closed. Defaults to null when no reason is recorded.
+              # @param type
+              #   Status discriminator that is always `closed`.
               def initialize: (reason: String?, ?type: :closed) -> void
 
               def to_hash: -> { reason: String?, ?type: :closed }

data/sig/openai/models/beta/chatkit/chatkit_thread_assistant_message_item.rbs

@@ -15,18 +15,36 @@ module OpenAI
           }
 
         class ChatKitThreadAssistantMessageItem < OpenAI::Internal::Type::BaseModel
+          # Identifier of the thread item.
           attr_accessor id: String
 
+          # Ordered assistant response segments.
           attr_accessor content: ::Array[OpenAI::Beta::ChatKit::ChatKitResponseOutputText]
 
+          # Unix timestamp (in seconds) for when the item was created.
           attr_accessor created_at: Integer
 
+          # Type discriminator that is always `chatkit.thread_item`.
           attr_accessor object: :"chatkit.thread_item"
 
+          # Identifier of the parent thread.
           attr_accessor thread_id: String
 
+          # Type discriminator that is always `chatkit.assistant_message`.
           attr_accessor type: :"chatkit.assistant_message"
 
+          # @param id
+          #   Identifier of the thread item.
+          # @param content
+          #   Ordered assistant response segments.
+          # @param created_at
+          #   Unix timestamp (in seconds) for when the item was created.
+          # @param thread_id
+          #   Identifier of the parent thread.
+          # @param object
+          #   Type discriminator that is always `chatkit.thread_item`.
+          # @param type
+          #   Type discriminator that is always `chatkit.assistant_message`.
           def initialize: (
             id: String,
             content: ::Array[OpenAI::Beta::ChatKit::ChatKitResponseOutputText],

data/sig/openai/models/beta/chatkit/chatkit_thread_item_list.rbs

@@ -14,16 +14,31 @@ module OpenAI
           }
 
         class ChatKitThreadItemList < OpenAI::Internal::Type::BaseModel
+          # A list of items
           attr_accessor data: ::Array[OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::data]
 
+          # The ID of the first item in the list.
           attr_accessor first_id: String?
 
+          # Whether there are more items available.
           attr_accessor has_more: bool
 
+          # The ID of the last item in the list.
           attr_accessor last_id: String?
 
+          # The type of object returned, must be `list`.
           attr_accessor object: :list
 
+          # @param data
+          #   A list of items
+          # @param first_id
+          #   The ID of the first item in the list.
+          # @param has_more
+          #   Whether there are more items available.
+          # @param last_id
+          #   The ID of the last item in the list.
+          # @param object
+          #   The type of object returned, must be `list`.
           def initialize: (
             data: ::Array[OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::data],
             first_id: String?,
@@ -66,26 +81,58 @@ module OpenAI
               }
 
             class ChatKitClientToolCall < OpenAI::Internal::Type::BaseModel
+              # Identifier of the thread item.
               attr_accessor id: String
 
+              # JSON-encoded arguments that were sent to the tool.
               attr_accessor arguments: String
 
+              # Identifier for the client tool call.
               attr_accessor call_id: String
 
+              # Unix timestamp (in seconds) for when the item was created.
               attr_accessor created_at: Integer
 
+              # Tool name that was invoked.
               attr_accessor name: String
 
+              # Type discriminator that is always `chatkit.thread_item`.
               attr_accessor object: :"chatkit.thread_item"
 
+              # JSON-encoded output captured from the tool. Defaults to null while execution is
+              # in progress.
               attr_accessor output: String?
 
+              # Execution status for the tool call.
               attr_accessor status: OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitClientToolCall::status
 
+              # Identifier of the parent thread.
               attr_accessor thread_id: String
 
+              # Type discriminator that is always `chatkit.client_tool_call`.
               attr_accessor type: :"chatkit.client_tool_call"
 
+              # @param id
+              #   Identifier of the thread item.
+              # @param arguments
+              #   JSON-encoded arguments that were sent to the tool.
+              # @param call_id
+              #   Identifier for the client tool call.
+              # @param created_at
+              #   Unix timestamp (in seconds) for when the item was created.
+              # @param name
+              #   Tool name that was invoked.
+              # @param output
+              #   JSON-encoded output captured from the tool. Defaults to null while execution is
+              #   in progress.
+              # @param status
+              #   Execution status for the tool call.
+              # @param thread_id
+              #   Identifier of the parent thread.
+              # @param object
+              #   Type discriminator that is always `chatkit.thread_item`.
+              # @param type
+              #   Type discriminator that is always `chatkit.client_tool_call`.
               def initialize: (
                 id: String,
                 arguments: String,
@@ -137,22 +184,46 @@ module OpenAI
               }
 
             class ChatKitTask < OpenAI::Internal::Type::BaseModel
+              # Identifier of the thread item.
               attr_accessor id: String
 
+              # Unix timestamp (in seconds) for when the item was created.
               attr_accessor created_at: Integer
 
+              # Optional heading for the task. Defaults to null when not provided.
               attr_accessor heading: String?
 
+              # Type discriminator that is always `chatkit.thread_item`.
               attr_accessor object: :"chatkit.thread_item"
 
+              # Optional summary that describes the task. Defaults to null when omitted.
               attr_accessor summary: String?
 
+              # Subtype for the task.
               attr_accessor task_type: OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTask::task_type
 
+              # Identifier of the parent thread.
               attr_accessor thread_id: String
 
+              # Type discriminator that is always `chatkit.task`.
               attr_accessor type: :"chatkit.task"
 
+              # @param id
+              #   Identifier of the thread item.
+              # @param created_at
+              #   Unix timestamp (in seconds) for when the item was created.
+              # @param heading
+              #   Optional heading for the task. Defaults to null when not provided.
+              # @param summary
+              #   Optional summary that describes the task. Defaults to null when omitted.
+              # @param task_type
+              #   Subtype for the task.
+              # @param thread_id
+              #   Identifier of the parent thread.
+              # @param object
+              #   Type discriminator that is always `chatkit.thread_item`.
+              # @param type
+              #   Type discriminator that is always `chatkit.task`.
               def initialize: (
                 id: String,
                 created_at: Integer,
@@ -198,18 +269,36 @@ module OpenAI
               }
 
             class ChatKitTaskGroup < OpenAI::Internal::Type::BaseModel
+              # Identifier of the thread item.
               attr_accessor id: String
 
+              # Unix timestamp (in seconds) for when the item was created.
               attr_accessor created_at: Integer
 
+              # Type discriminator that is always `chatkit.thread_item`.
               attr_accessor object: :"chatkit.thread_item"
 
+              # Tasks included in the group.
               attr_accessor tasks: ::Array[OpenAI::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task]
 
+              # Identifier of the parent thread.
               attr_accessor thread_id: String
 
+              # Type discriminator that is always `chatkit.task_group`.
               attr_accessor type: :"chatkit.task_group"
 
+              # @param id
+              #   Identifier of the thread item.
+              # @param created_at
+              #   Unix timestamp (in seconds) for when the item was created.
+              # @param tasks
+              #   Tasks included in the group.
+              # @param thread_id
+              #   Identifier of the parent thread.
+              # @param object
+              #   Type discriminator that is always `chatkit.thread_item`.
+              # @param type
+              #   Type discriminator that is always `chatkit.task_group`.
               def initialize: (
                 id: String,
                 created_at: Integer,
@@ -236,12 +325,21 @@ module OpenAI
                 }
 
               class Task < OpenAI::Internal::Type::BaseModel
+                # Optional heading for the grouped task. Defaults to null when not provided.
                 attr_accessor heading: String?
 
+                # Optional summary that describes the grouped task. Defaults to null when omitted.
                 attr_accessor summary: String?
 
+                # Subtype for the grouped task.
                 attr_accessor type: OpenAI::Models::Beta::ChatKit::ChatKitThreadItemList::Data::ChatKitTaskGroup::Task::type_
 
+                # @param heading
+                #   Optional heading for the grouped task. Defaults to null when not provided.
+                # @param summary
+                #   Optional summary that describes the grouped task. Defaults to null when omitted.
+                # @param type
+                #   Subtype for the grouped task.
                 def initialize: (
                   heading: String?,
                   summary: String?,

data/sig/openai/models/beta/chatkit/chatkit_thread_user_message_item.rbs

@@ -17,22 +17,43 @@ module OpenAI
           }
 
         class ChatKitThreadUserMessageItem < OpenAI::Internal::Type::BaseModel
+          # Identifier of the thread item.
           attr_accessor id: String
 
+          # Attachments associated with the user message. Defaults to an empty list.
           attr_accessor attachments: ::Array[OpenAI::Beta::ChatKit::ChatKitAttachment]
 
+          # Ordered content elements supplied by the user.
           attr_accessor content: ::Array[OpenAI::Models::Beta::ChatKit::ChatKitThreadUserMessageItem::content]
 
+          # Unix timestamp (in seconds) for when the item was created.
           attr_accessor created_at: Integer
 
+          # Inference overrides applied to the message. Defaults to null when unset.
           attr_accessor inference_options: OpenAI::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions?
 
+          # Type discriminator that is always `chatkit.thread_item`.
           attr_accessor object: :"chatkit.thread_item"
 
+          # Identifier of the parent thread.
           attr_accessor thread_id: String
 
           attr_accessor type: :"chatkit.user_message"
 
+          # @param id
+          #   Identifier of the thread item.
+          # @param attachments
+          #   Attachments associated with the user message. Defaults to an empty list.
+          # @param content
+          #   Ordered content elements supplied by the user.
+          # @param created_at
+          #   Unix timestamp (in seconds) for when the item was created.
+          # @param inference_options
+          #   Inference overrides applied to the message. Defaults to null when unset.
+          # @param thread_id
+          #   Identifier of the parent thread.
+          # @param object
+          #   Type discriminator that is always `chatkit.thread_item`.
           def initialize: (
             id: String,
             attachments: ::Array[OpenAI::Beta::ChatKit::ChatKitAttachment],
@@ -65,10 +86,16 @@ module OpenAI
             type input_text = { text: String, ?type: :input_text }
 
             class InputText < OpenAI::Internal::Type::BaseModel
+              # Plain-text content supplied by the user.
               attr_accessor text: String
 
+              # Type discriminator that is always `input_text`.
               attr_accessor type: :input_text
 
+              # @param text
+              #   Plain-text content supplied by the user.
+              # @param type
+              #   Type discriminator that is always `input_text`.
               def initialize: (text: String, ?type: :input_text) -> void
 
               def to_hash: -> { text: String, ?type: :input_text }
@@ -77,10 +104,16 @@ module OpenAI
             type quoted_text = { text: String, ?type: :quoted_text }
 
             class QuotedText < OpenAI::Internal::Type::BaseModel
+              # Quoted text content.
               attr_accessor text: String
 
+              # Type discriminator that is always `quoted_text`.
               attr_accessor type: :quoted_text
 
+              # @param text
+              #   Quoted text content.
+              # @param type
+              #   Type discriminator that is always `quoted_text`.
               def initialize: (text: String, ?type: :quoted_text) -> void
 
               def to_hash: -> { text: String, ?type: :quoted_text }
@@ -96,10 +129,18 @@ module OpenAI
             }
 
           class InferenceOptions < OpenAI::Internal::Type::BaseModel
+            # Model name that generated the response. Defaults to null when using the session
+            # default.
             attr_accessor model: String?
 
+            # Preferred tool to invoke. Defaults to null when ChatKit should auto-select.
             attr_accessor tool_choice: OpenAI::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions::ToolChoice?
 
+            # @param model
+            #   Model name that generated the response. Defaults to null when using the session
+            #   default.
+            # @param tool_choice
+            #   Preferred tool to invoke. Defaults to null when ChatKit should auto-select.
             def initialize: (
               model: String?,
               tool_choice: OpenAI::Beta::ChatKit::ChatKitThreadUserMessageItem::InferenceOptions::ToolChoice?
@@ -113,8 +154,11 @@ module OpenAI
             type tool_choice = { id: String }
 
             class ToolChoice < OpenAI::Internal::Type::BaseModel
+              # Identifier of the requested tool.
               attr_accessor id: String
 
+              # @param id
+              #   Identifier of the requested tool.
               def initialize: (id: String) -> void
 
               def to_hash: -> { id: String }

data/sig/openai/models/beta/chatkit/chatkit_widget_item.rbs

@@ -15,18 +15,36 @@ module OpenAI
           }
 
         class ChatKitWidgetItem < OpenAI::Internal::Type::BaseModel
+          # Identifier of the thread item.
           attr_accessor id: String
 
+          # Unix timestamp (in seconds) for when the item was created.
           attr_accessor created_at: Integer
 
+          # Type discriminator that is always `chatkit.thread_item`.
           attr_accessor object: :"chatkit.thread_item"
 
+          # Identifier of the parent thread.
           attr_accessor thread_id: String
 
+          # Type discriminator that is always `chatkit.widget`.
           attr_accessor type: :"chatkit.widget"
 
+          # Serialized widget payload rendered in the UI.
           attr_accessor widget: String
 
+          # @param id
+          #   Identifier of the thread item.
+          # @param created_at
+          #   Unix timestamp (in seconds) for when the item was created.
+          # @param thread_id
+          #   Identifier of the parent thread.
+          # @param widget
+          #   Serialized widget payload rendered in the UI.
+          # @param object
+          #   Type discriminator that is always `chatkit.thread_item`.
+          # @param type
+          #   Type discriminator that is always `chatkit.widget`.
           def initialize: (
             id: String,
             created_at: Integer,