openai 0.87.0 → 0.88.0

data/lib/openai/models/beta/beta_web_search_preview_tool.rb

@@ -33,20 +33,22 @@ module OpenAI
         optional :user_location, -> { OpenAI::Beta::BetaWebSearchPreviewTool::UserLocation }, nil?: true
 
         # @!method initialize(type:, search_content_types: nil, search_context_size: nil, user_location: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaWebSearchPreviewTool} for more details.
-        #
         #   This tool searches the web for relevant results to use in a response. Learn more
         #   about the
-        #   [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
+        #   [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
         #
-        #   @param type [Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::Type] The type of the web search tool. One of `web_search_preview` or `web_search_prev
+        #   @param type [Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::Type]
+        #     The type of the web search tool. One of `web_search_preview` or
+        #     `web_search_preview_2025_03_11`.
         #
         #   @param search_content_types [Array<Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::SearchContentType>]
         #
-        #   @param search_context_size [Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::SearchContextSize] High level guidance for the amount of context window space to use for the search
+        #   @param search_context_size [Symbol, OpenAI::Models::Beta::BetaWebSearchPreviewTool::SearchContextSize]
+        #     High level guidance for the amount of context window space to use for the
+        #     search. One of `low`, `medium`, or `high`. `medium` is the default.
         #
-        #   @param user_location [OpenAI::Models::Beta::BetaWebSearchPreviewTool::UserLocation, nil] The user's location.
+        #   @param user_location [OpenAI::Models::Beta::BetaWebSearchPreviewTool::UserLocation, nil]
+        #     The user's location.
 
         # The type of the web search tool. One of `web_search_preview` or
         # `web_search_preview_2025_03_11`.
@@ -122,20 +124,24 @@ module OpenAI
           optional :timezone, String, nil?: true
 
           # @!method initialize(city: nil, country: nil, region: nil, timezone: nil, type: :approximate)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::BetaWebSearchPreviewTool::UserLocation} for more details.
-          #
           #   The user's location.
           #
-          #   @param city [String, nil] Free text input for the city of the user, e.g. `San Francisco`.
+          #   @param city [String, nil]
+          #     Free text input for the city of the user, e.g. `San Francisco`.
           #
-          #   @param country [String, nil] The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of t
+          #   @param country [String, nil]
+          #     The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+          #     the user, e.g. `US`.
           #
-          #   @param region [String, nil] Free text input for the region of the user, e.g. `California`.
+          #   @param region [String, nil]
+          #     Free text input for the region of the user, e.g. `California`.
           #
-          #   @param timezone [String, nil] The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user
+          #   @param timezone [String, nil]
+          #     The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+          #     user, e.g. `America/Los_Angeles`.
           #
-          #   @param type [Symbol, :approximate] The type of location approximation. Always `approximate`.
+          #   @param type [Symbol, :approximate]
+          #     The type of location approximation. Always `approximate`.
         end
       end
     end

data/lib/openai/models/beta/beta_web_search_tool.rb

@@ -38,21 +38,26 @@ module OpenAI
         optional :user_location, -> { OpenAI::Beta::BetaWebSearchTool::UserLocation }, nil?: true
 
         # @!method initialize(type:, external_web_access: nil, filters: nil, search_context_size: nil, user_location: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Beta::BetaWebSearchTool} for more details.
-        #
         #   Search the Internet for sources related to the prompt. Learn more about the
-        #   [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
+        #   [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
         #
-        #   @param type [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::Type] The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
+        #   @param type [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::Type]
+        #     The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
         #
-        #   @param external_web_access [Boolean] Allow live internet access for web search. Defaults to true when omitted. When f
+        #   @param external_web_access [Boolean]
+        #     Allow live internet access for web search. Defaults to true when omitted. When
+        #     false, the web search tool runs in offline/cache-only mode and will not fetch
+        #     new external content.
         #
-        #   @param filters [OpenAI::Models::Beta::BetaWebSearchTool::Filters, nil] Filters for the search.
+        #   @param filters [OpenAI::Models::Beta::BetaWebSearchTool::Filters, nil]
+        #     Filters for the search.
         #
-        #   @param search_context_size [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::SearchContextSize] High level guidance for the amount of context window space to use for the search
+        #   @param search_context_size [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::SearchContextSize]
+        #     High level guidance for the amount of context window space to use for the
+        #     search. One of `low`, `medium`, or `high`. `medium` is the default.
         #
-        #   @param user_location [OpenAI::Models::Beta::BetaWebSearchTool::UserLocation, nil] The approximate location of the user.
+        #   @param user_location [OpenAI::Models::Beta::BetaWebSearchTool::UserLocation, nil]
+        #     The approximate location of the user.
 
         # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
         #
@@ -79,12 +84,13 @@ module OpenAI
           optional :allowed_domains, OpenAI::Internal::Type::ArrayOf[String], nil?: true
 
           # @!method initialize(allowed_domains: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::BetaWebSearchTool::Filters} for more details.
-          #
           #   Filters for the search.
           #
-          #   @param allowed_domains [Array<String>, nil] Allowed domains for the search. If not provided, all domains are allowed.
+          #   @param allowed_domains [Array<String>, nil]
+          #     Allowed domains for the search. If not provided, all domains are allowed.
+          #     Subdomains of the provided domains are allowed as well.
+          #
+          #     Example: `["pubmed.ncbi.nlm.nih.gov"]`
         end
 
         # High level guidance for the amount of context window space to use for the
@@ -137,20 +143,24 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Beta::BetaWebSearchTool::UserLocation::Type }
 
           # @!method initialize(city: nil, country: nil, region: nil, timezone: nil, type: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::BetaWebSearchTool::UserLocation} for more details.
-          #
           #   The approximate location of the user.
           #
-          #   @param city [String, nil] Free text input for the city of the user, e.g. `San Francisco`.
+          #   @param city [String, nil]
+          #     Free text input for the city of the user, e.g. `San Francisco`.
           #
-          #   @param country [String, nil] The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of t
+          #   @param country [String, nil]
+          #     The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+          #     the user, e.g. `US`.
           #
-          #   @param region [String, nil] Free text input for the region of the user, e.g. `California`.
+          #   @param region [String, nil]
+          #     Free text input for the region of the user, e.g. `California`.
           #
-          #   @param timezone [String, nil] The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user
+          #   @param timezone [String, nil]
+          #     The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+          #     user, e.g. `America/Los_Angeles`.
           #
-          #   @param type [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::UserLocation::Type] The type of location approximation. Always `approximate`.
+          #   @param type [Symbol, OpenAI::Models::Beta::BetaWebSearchTool::UserLocation::Type]
+          #     The type of location approximation. Always `approximate`.
 
           # The type of location approximation. Always `approximate`.
           #

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

@@ -68,25 +68,35 @@ module OpenAI
           # @!method initialize(id:, chatkit_configuration:, client_secret:, expires_at:, max_requests_per_1_minute:, rate_limits:, status:, user:, workflow:, object: :"chatkit.session")
           #   Represents a ChatKit session and its resolved configuration.
           #
-          #   @param id [String] Identifier for the ChatKit session.
+          #   @param id [String]
+          #     Identifier for the ChatKit session.
           #
-          #   @param chatkit_configuration [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfiguration] Resolved ChatKit feature configuration for the session.
+          #   @param chatkit_configuration [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfiguration]
+          #     Resolved ChatKit feature configuration for the session.
           #
-          #   @param client_secret [String] Ephemeral client secret that authenticates session requests.
+          #   @param client_secret [String]
+          #     Ephemeral client secret that authenticates session requests.
           #
-          #   @param expires_at [Integer] Unix timestamp (in seconds) for when the session expires.
+          #   @param expires_at [Integer]
+          #     Unix timestamp (in seconds) for when the session expires.
           #
-          #   @param max_requests_per_1_minute [Integer] Convenience copy of the per-minute request limit.
+          #   @param max_requests_per_1_minute [Integer]
+          #     Convenience copy of the per-minute request limit.
           #
-          #   @param rate_limits [OpenAI::Models::Beta::ChatKit::ChatSessionRateLimits] Resolved rate limit values.
+          #   @param rate_limits [OpenAI::Models::Beta::ChatKit::ChatSessionRateLimits]
+          #     Resolved rate limit values.
           #
-          #   @param status [Symbol, OpenAI::Models::Beta::ChatKit::ChatSessionStatus] Current lifecycle state of the session.
+          #   @param status [Symbol, OpenAI::Models::Beta::ChatKit::ChatSessionStatus]
+          #     Current lifecycle state of the session.
           #
-          #   @param user [String] User identifier associated with the session.
+          #   @param user [String]
+          #     User identifier associated with the session.
           #
-          #   @param workflow [OpenAI::Models::Beta::ChatKitWorkflow] Workflow metadata for the session.
+          #   @param workflow [OpenAI::Models::Beta::ChatKitWorkflow]
+          #     Workflow metadata for the session.
           #
-          #   @param object [Symbol, :"chatkit.session"] Type discriminator that is always `chatkit.session`.
+          #   @param object [Symbol, :"chatkit.session"]
+          #     Type discriminator that is always `chatkit.session`.
         end
       end
     end

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

@@ -14,7 +14,8 @@ module OpenAI
           # @!method initialize(enabled:)
           #   Automatic thread title preferences for the session.
           #
-          #   @param enabled [Boolean] Whether automatic thread titling is enabled.
+          #   @param enabled [Boolean]
+          #     Whether automatic thread titling is enabled.
         end
       end
     end

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

@@ -26,11 +26,14 @@ module OpenAI
           # @!method initialize(automatic_thread_titling:, file_upload:, history:)
           #   ChatKit configuration for the session.
           #
-          #   @param automatic_thread_titling [OpenAI::Models::Beta::ChatKit::ChatSessionAutomaticThreadTitling] Automatic thread titling preferences.
+          #   @param automatic_thread_titling [OpenAI::Models::Beta::ChatKit::ChatSessionAutomaticThreadTitling]
+          #     Automatic thread titling preferences.
           #
-          #   @param file_upload [OpenAI::Models::Beta::ChatKit::ChatSessionFileUpload] Upload settings for the session.
+          #   @param file_upload [OpenAI::Models::Beta::ChatKit::ChatSessionFileUpload]
+          #     Upload settings for the session.
           #
-          #   @param history [OpenAI::Models::Beta::ChatKit::ChatSessionHistory] History retention configuration.
+          #   @param history [OpenAI::Models::Beta::ChatKit::ChatSessionHistory]
+          #     History retention configuration.
         end
       end
     end

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

@@ -30,17 +30,19 @@ module OpenAI
           optional :history, -> { OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History }
 
           # @!method initialize(automatic_thread_titling: nil, file_upload: nil, history: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam} for more
-          #   details.
-          #
           #   Optional per-session configuration settings for ChatKit behavior.
           #
-          #   @param automatic_thread_titling [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling] Configuration for automatic thread titling. When omitted, automatic thread titli
+          #   @param automatic_thread_titling [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam::AutomaticThreadTitling]
+          #     Configuration for automatic thread titling. When omitted, automatic thread
+          #     titling is enabled by default.
           #
-          #   @param file_upload [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload] Configuration for upload enablement and limits. When omitted, uploads are disabl
+          #   @param file_upload [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload]
+          #     Configuration for upload enablement and limits. When omitted, uploads are
+          #     disabled by default (max_files 10, max_file_size 512 MB).
           #
-          #   @param history [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History] Configuration for chat history retention. When omitted, history is enabled by de
+          #   @param history [OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History]
+          #     Configuration for chat history retention. When omitted, history is enabled by
+          #     default with no limit on recent_threads (null).
 
           # @see OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam#automatic_thread_titling
           class AutomaticThreadTitling < OpenAI::Internal::Type::BaseModel
@@ -54,7 +56,8 @@ module OpenAI
             #   Configuration for automatic thread titling. When omitted, automatic thread
             #   titling is enabled by default.
             #
-            #   @param enabled [Boolean] Enable automatic thread title generation. Defaults to true.
+            #   @param enabled [Boolean]
+            #     Enable automatic thread title generation. Defaults to true.
           end
 
           # @see OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam#file_upload
@@ -79,18 +82,18 @@ module OpenAI
             optional :max_files, Integer
 
             # @!method initialize(enabled: nil, max_file_size: nil, max_files: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam::FileUpload}
-            #   for more details.
-            #
             #   Configuration for upload enablement and limits. When omitted, uploads are
             #   disabled by default (max_files 10, max_file_size 512 MB).
             #
-            #   @param enabled [Boolean] Enable uploads for this session. Defaults to false.
+            #   @param enabled [Boolean]
+            #     Enable uploads for this session. Defaults to false.
             #
-            #   @param max_file_size [Integer] Maximum size in megabytes for each uploaded file. Defaults to 512 MB, which is t
+            #   @param max_file_size [Integer]
+            #     Maximum size in megabytes for each uploaded file. Defaults to 512 MB, which is
+            #     the maximum allowable size.
             #
-            #   @param max_files [Integer] Maximum number of files that can be uploaded to the session. Defaults to 10.
+            #   @param max_files [Integer]
+            #     Maximum number of files that can be uploaded to the session. Defaults to 10.
           end
 
           # @see OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam#history
@@ -109,16 +112,15 @@ module OpenAI
             optional :recent_threads, Integer
 
             # @!method initialize(enabled: nil, recent_threads: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::ChatKit::ChatSessionChatKitConfigurationParam::History}
-            #   for more details.
-            #
             #   Configuration for chat history retention. When omitted, history is enabled by
             #   default with no limit on recent_threads (null).
             #
-            #   @param enabled [Boolean] Enables chat users to access previous ChatKit threads. Defaults to true.
+            #   @param enabled [Boolean]
+            #     Enables chat users to access previous ChatKit threads. Defaults to true.
             #
-            #   @param recent_threads [Integer] Number of recent ChatKit threads users have access to. Defaults to unlimited whe
+            #   @param recent_threads [Integer]
+            #     Number of recent ChatKit threads users have access to. Defaults to unlimited
+            #     when unset.
           end
         end
       end

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

@@ -20,9 +20,11 @@ module OpenAI
           # @!method initialize(seconds:, anchor: :created_at)
           #   Controls when the session expires relative to an anchor timestamp.
           #
-          #   @param seconds [Integer] Number of seconds after the anchor when the session expires.
+          #   @param seconds [Integer]
+          #     Number of seconds after the anchor when the session expires.
           #
-          #   @param anchor [Symbol, :created_at] Base timestamp used to calculate expiration. Currently fixed to `created_at`.
+          #   @param anchor [Symbol, :created_at]
+          #     Base timestamp used to calculate expiration. Currently fixed to `created_at`.
         end
       end
     end

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

@@ -26,11 +26,14 @@ module OpenAI
           # @!method initialize(enabled:, max_file_size:, max_files:)
           #   Upload permissions and limits applied to the session.
           #
-          #   @param enabled [Boolean] Indicates if uploads are enabled for the session.
+          #   @param enabled [Boolean]
+          #     Indicates if uploads are enabled for the session.
           #
-          #   @param max_file_size [Integer, nil] Maximum upload size in megabytes.
+          #   @param max_file_size [Integer, nil]
+          #     Maximum upload size in megabytes.
           #
-          #   @param max_files [Integer, nil] Maximum number of uploads allowed during the session.
+          #   @param max_files [Integer, nil]
+          #     Maximum number of uploads allowed during the session.
         end
       end
     end

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

@@ -19,14 +19,14 @@ module OpenAI
           required :recent_threads, Integer, nil?: true
 
           # @!method initialize(enabled:, recent_threads:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::ChatKit::ChatSessionHistory} for more details.
-          #
           #   History retention preferences returned for the session.
           #
-          #   @param enabled [Boolean] Indicates if chat history is persisted for the session.
+          #   @param enabled [Boolean]
+          #     Indicates if chat history is persisted for the session.
           #
-          #   @param recent_threads [Integer, nil] Number of prior threads surfaced in history views. Defaults to null when all his
+          #   @param recent_threads [Integer, nil]
+          #     Number of prior threads surfaced in history views. Defaults to null when all
+          #     history is retained.
         end
       end
     end

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

@@ -14,7 +14,8 @@ module OpenAI
           # @!method initialize(max_requests_per_1_minute:)
           #   Active per-minute request limit for the session.
           #
-          #   @param max_requests_per_1_minute [Integer] Maximum allowed requests per one-minute window.
+          #   @param max_requests_per_1_minute [Integer]
+          #     Maximum allowed requests per one-minute window.
         end
       end
     end

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

@@ -14,7 +14,8 @@ module OpenAI
           # @!method initialize(max_requests_per_1_minute: nil)
           #   Controls request rate limits for the session.
           #
-          #   @param max_requests_per_1_minute [Integer] Maximum number of requests allowed per minute for the session. Defaults to 10.
+          #   @param max_requests_per_1_minute [Integer]
+          #     Maximum number of requests allowed per minute for the session. Defaults to 10.
         end
       end
     end

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

@@ -37,19 +37,21 @@ module OpenAI
           optional :version, String
 
           # @!method initialize(id:, state_variables: nil, tracing: nil, version: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam} for more details.
-          #
           #   Workflow reference and overrides applied to the chat session.
           #
-          #   @param id [String] Identifier for the workflow invoked by the session.
+          #   @param id [String]
+          #     Identifier for the workflow invoked by the session.
           #
-          #   @param state_variables [Hash{Symbol=>String, Boolean, Float}] State variables forwarded to the workflow. Keys may be up to 64 characters, valu
+          #   @param state_variables [Hash{Symbol=>String, Boolean, Float}]
+          #     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 [OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam::Tracing] Optional tracing overrides for the workflow invocation. When omitted, tracing is
+          #   @param tracing [OpenAI::Models::Beta::ChatKit::ChatSessionWorkflowParam::Tracing]
+          #     Optional tracing overrides for the workflow invocation. When omitted, tracing is
+          #     enabled by default.
           #
-          #   @param version [String] Specific workflow version to run. Defaults to the latest deployed version.
-
+          #   @param version [String]
+          #     Specific workflow version to run. Defaults to the latest deployed version.
           module StateVariable
             extend OpenAI::Internal::Type::Union
 
@@ -75,7 +77,8 @@ module OpenAI
             #   Optional tracing overrides for the workflow invocation. When omitted, tracing is
             #   enabled by default.
             #
-            #   @param enabled [Boolean] Whether tracing is enabled during the session. Defaults to true.
+            #   @param enabled [Boolean]
+            #     Whether tracing is enabled during the session. Defaults to true.
           end
         end
       end

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

@@ -38,15 +38,20 @@ module OpenAI
           # @!method initialize(id:, mime_type:, name:, preview_url:, type:)
           #   Attachment metadata included on thread items.
           #
-          #   @param id [String] Identifier for the attachment.
+          #   @param id [String]
+          #     Identifier for the attachment.
           #
-          #   @param mime_type [String] MIME type of the attachment.
+          #   @param mime_type [String]
+          #     MIME type of the attachment.
           #
-          #   @param name [String] Original display name for the attachment.
+          #   @param name [String]
+          #     Original display name for the attachment.
           #
-          #   @param preview_url [String, nil] Preview URL for rendering the attachment inline.
+          #   @param preview_url [String, nil]
+          #     Preview URL for rendering the attachment inline.
           #
-          #   @param type [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitAttachment::Type] Attachment discriminator.
+          #   @param type [Symbol, OpenAI::Models::Beta::ChatKit::ChatKitAttachment::Type]
+          #     Attachment discriminator.
 
           # Attachment discriminator.
           #

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

@@ -29,11 +29,14 @@ module OpenAI
           # @!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 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 text [String]
+          #     Assistant generated text.
           #
-          #   @param type [Symbol, :output_text] Type discriminator that is always `output_text`.
+          #   @param type [Symbol, :output_text]
+          #     Type discriminator that is always `output_text`.
 
           # Annotation object describing a cited source.
           module Annotation
@@ -63,9 +66,11 @@ module OpenAI
               # @!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 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.
+              #   @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
@@ -84,9 +89,11 @@ module OpenAI
                 # @!method initialize(filename:, type: :file)
                 #   File attachment referenced by the annotation.
                 #
-                #   @param filename [String] Filename referenced by the annotation.
+                #   @param filename [String]
+                #     Filename referenced by the annotation.
                 #
-                #   @param type [Symbol, :file] Type discriminator that is always `file`.
+                #   @param type [Symbol, :file]
+                #     Type discriminator that is always `file`.
               end
             end
 
@@ -106,9 +113,11 @@ module OpenAI
               # @!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 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.
+              #   @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
@@ -127,9 +136,11 @@ module OpenAI
                 # @!method initialize(url:, type: :url)
                 #   URL referenced by the annotation.
                 #
-                #   @param url [String] URL referenced by the annotation.
+                #   @param url [String]
+                #     URL referenced by the annotation.
                 #
-                #   @param type [Symbol, :url] Type discriminator that is always `url`.
+                #   @param type [Symbol, :url]
+                #     Type discriminator that is always `url`.
               end
             end
 

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

@@ -44,22 +44,26 @@ module OpenAI
           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 id [String]
+          #     Identifier of the thread.
           #
-          #   @param created_at [Integer] Unix timestamp (in seconds) for when the thread was created.
+          #   @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 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 title [String, nil]
+          #     Optional human-readable title for the thread. Defaults to null when no title has
+          #     been generated.
           #
-          #   @param user [String] Free-form string that identifies your end user who owns the thread.
+          #   @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`.
+          #   @param object [Symbol, :"chatkit.thread"]
+          #     Type discriminator that is always `chatkit.thread`.
 
           # Current status for the thread. Defaults to `active` for newly created threads.
           #
@@ -88,7 +92,8 @@ module OpenAI
               # @!method initialize(type: :active)
               #   Indicates that a thread is active.
               #
-              #   @param type [Symbol, :active] Status discriminator that is always `active`.
+              #   @param type [Symbol, :active]
+              #     Status discriminator that is always `active`.
             end
 
             class Locked < OpenAI::Internal::Type::BaseModel
@@ -107,9 +112,11 @@ module OpenAI
               # @!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 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`.
+              #   @param type [Symbol, :locked]
+              #     Status discriminator that is always `locked`.
             end
 
             class Closed < OpenAI::Internal::Type::BaseModel
@@ -128,9 +135,11 @@ module OpenAI
               # @!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 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`.
+              #   @param type [Symbol, :closed]
+              #     Status discriminator that is always `closed`.
             end
 
             # @!method self.variants

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

@@ -47,17 +47,23 @@ module OpenAI
           # @!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 id [String]
+          #     Identifier of the thread item.
           #
-          #   @param content [Array<OpenAI::Models::Beta::ChatKit::ChatKitResponseOutputText>] Ordered assistant response segments.
+          #   @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 created_at [Integer]
+          #     Unix timestamp (in seconds) for when the item was created.
           #
-          #   @param thread_id [String] Identifier of the parent thread.
+          #   @param thread_id [String]
+          #     Identifier of the parent thread.
           #
-          #   @param object [Symbol, :"chatkit.thread_item"] Type discriminator that is always `chatkit.thread_item`.
+          #   @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`.
+          #   @param type [Symbol, :"chatkit.assistant_message"]
+          #     Type discriminator that is always `chatkit.assistant_message`.
         end
       end