openai 0.87.0 → 0.89.0

data/lib/openai/models/beta/threads/runs/tool_call_delta_object.rb

@@ -24,14 +24,15 @@ module OpenAI
             )
 
             # @!method initialize(tool_calls: nil, type: :tool_calls)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::Threads::Runs::ToolCallDeltaObject} for more details.
-            #
             #   Details of the tool call.
             #
-            #   @param tool_calls [Array<OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCallDelta, OpenAI::Models::Beta::Threads::Runs::FunctionToolCallDelta>] An array of tool calls the run step was involved in. These can be associated wit
+            #   @param tool_calls [Array<OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCallDelta, OpenAI::Models::Beta::Threads::Runs::FunctionToolCallDelta>]
+            #     An array of tool calls the run step was involved in. These can be associated
+            #     with one of three types of tools: `code_interpreter`, `file_search`, or
+            #     `function`.
             #
-            #   @param type [Symbol, :tool_calls] Always `tool_calls`.
+            #   @param type [Symbol, :tool_calls]
+            #     Always `tool_calls`.
           end
         end
       end

data/lib/openai/models/beta/threads/runs/tool_calls_step_details.rb

@@ -21,14 +21,15 @@ module OpenAI
             required :type, const: :tool_calls
 
             # @!method initialize(tool_calls:, type: :tool_calls)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::Threads::Runs::ToolCallsStepDetails} for more details.
-            #
             #   Details of the tool call.
             #
-            #   @param tool_calls [Array<OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall, OpenAI::Models::Beta::Threads::Runs::FunctionToolCall>] An array of tool calls the run step was involved in. These can be associated wit
+            #   @param tool_calls [Array<OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall, OpenAI::Models::Beta::Threads::Runs::FunctionToolCall>]
+            #     An array of tool calls the run step was involved in. These can be associated
+            #     with one of three types of tools: `code_interpreter`, `file_search`, or
+            #     `function`.
             #
-            #   @param type [Symbol, :tool_calls] Always `tool_calls`.
+            #   @param type [Symbol, :tool_calls]
+            #     Always `tool_calls`.
           end
         end
       end

data/lib/openai/models/beta/threads/text.rb

@@ -19,7 +19,8 @@ module OpenAI
           # @!method initialize(annotations:, value:)
           #   @param annotations [Array<OpenAI::Models::Beta::Threads::FileCitationAnnotation, OpenAI::Models::Beta::Threads::FilePathAnnotation>]
           #
-          #   @param value [String] The data that makes up the text.
+          #   @param value [String]
+          #     The data that makes up the text.
         end
       end
     end

data/lib/openai/models/beta/threads/text_content_block.rb

@@ -21,7 +21,8 @@ module OpenAI
           #
           #   @param text [OpenAI::Models::Beta::Threads::Text]
           #
-          #   @param type [Symbol, :text] Always `text`.
+          #   @param type [Symbol, :text]
+          #     Always `text`.
         end
       end
     end

data/lib/openai/models/beta/threads/text_content_block_param.rb

@@ -20,9 +20,11 @@ module OpenAI
           # @!method initialize(text:, type: :text)
           #   The text content that is part of a message.
           #
-          #   @param text [String] Text content to be sent to the model
+          #   @param text [String]
+          #     Text content to be sent to the model
           #
-          #   @param type [Symbol, :text] Always `text`.
+          #   @param type [Symbol, :text]
+          #     Always `text`.
         end
       end
     end

data/lib/openai/models/beta/threads/text_delta.rb

@@ -22,7 +22,8 @@ module OpenAI
           # @!method initialize(annotations: nil, value: nil)
           #   @param annotations [Array<OpenAI::Models::Beta::Threads::FileCitationDeltaAnnotation, OpenAI::Models::Beta::Threads::FilePathDeltaAnnotation>]
           #
-          #   @param value [String] The data that makes up the text.
+          #   @param value [String]
+          #     The data that makes up the text.
         end
       end
     end

data/lib/openai/models/beta/threads/text_delta_block.rb

@@ -25,11 +25,13 @@ module OpenAI
           # @!method initialize(index:, text: nil, type: :text)
           #   The text content that is part of a message.
           #
-          #   @param index [Integer] The index of the content part in the message.
+          #   @param index [Integer]
+          #     The index of the content part in the message.
           #
           #   @param text [OpenAI::Models::Beta::Threads::TextDelta]
           #
-          #   @param type [Symbol, :text] Always `text`.
+          #   @param type [Symbol, :text]
+          #     Always `text`.
         end
       end
     end

data/lib/openai/models/chat/chat_completion.rb

@@ -64,13 +64,15 @@ module OpenAI
         #     will use 'default'.
         #   - If set to 'default', then the request will be processed with the standard
         #     pricing and performance for the selected model.
-        #   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
-        #     then the request will be processed with the Flex Processing service tier.
-        #   - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
-        #     include the `service_tier=fast` or `service_tier=priority` parameter for
-        #     Responses or Chat Completions. The response will show `service_tier=priority`
-        #     regardless of if you specify `service_tier=fast` or `priority` in your
-        #     request.
+        #   - If set to
+        #     '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+        #     the request will be processed with the Flex Processing service tier.
+        #   - To opt-in to
+        #     [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+        #     request level, include the `service_tier=fast` or `service_tier=priority`
+        #     parameter for Responses or Chat Completions. The response will show
+        #     `service_tier=priority` regardless of if you specify `service_tier=fast` or
+        #     `priority` in your request.
         #   - When not set, the default behavior is 'auto'.
         #
         #   When the `service_tier` parameter is set, the response body will include the
@@ -99,32 +101,69 @@ module OpenAI
         optional :usage, -> { OpenAI::CompletionUsage }
 
         # @!method initialize(id:, choices:, created:, model:, metadata: nil, moderation: nil, service_tier: nil, system_fingerprint: nil, usage: nil, object: :"chat.completion")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletion} for more details.
-        #
         #   Represents a chat completion response returned by model, based on the provided
         #   input.
         #
-        #   @param id [String] A unique identifier for the chat completion.
+        #   @param id [String]
+        #     A unique identifier for the chat completion.
         #
-        #   @param choices [Array<OpenAI::Models::Chat::ChatCompletion::Choice>] A list of chat completion choices. Can be more than one if `n` is greater than 1
+        #   @param choices [Array<OpenAI::Models::Chat::ChatCompletion::Choice>]
+        #     A list of chat completion choices. Can be more than one if `n` is greater
+        #     than 1.
         #
-        #   @param created [Integer] The Unix timestamp (in seconds) of when the chat completion was created.
+        #   @param created [Integer]
+        #     The Unix timestamp (in seconds) of when the chat completion was created.
         #
-        #   @param model [String] The model used for the chat completion.
+        #   @param model [String]
+        #     The model used for the chat completion.
         #
-        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+        #   @param metadata [Hash{Symbol=>String}, nil]
+        #     Set of 16 key-value pairs that can be attached to an object. This can be useful
+        #     for storing additional information about the object in a structured format, and
+        #     querying for objects via API or the dashboard.
         #
-        #   @param moderation [OpenAI::Models::Chat::ChatCompletion::Moderation, nil] Moderation results for the request input and generated output, if moderated
+        #     Keys are strings with a maximum length of 64 characters. Values are strings with
+        #     a maximum length of 512 characters.
         #
-        #   @param service_tier [Symbol, OpenAI::Models::Chat::ChatCompletion::ServiceTier, nil] Specifies the processing type used for serving the request.
+        #   @param moderation [OpenAI::Models::Chat::ChatCompletion::Moderation, nil]
+        #     Moderation results for the request input and generated output, if moderated
+        #     completions were requested.
         #
-        #   @param system_fingerprint [String] This fingerprint represents the backend configuration that the model runs with.
+        #   @param service_tier [Symbol, OpenAI::Models::Chat::ChatCompletion::ServiceTier, nil]
+        #     Specifies the processing type used for serving the request.
         #
-        #   @param usage [OpenAI::Models::CompletionUsage] Usage statistics for the completion request.
+        #     - If set to 'auto', then the request will be processed with the service tier
+        #       configured in the Project settings. Unless otherwise configured, the Project
+        #       will use 'default'.
+        #     - If set to 'default', then the request will be processed with the standard
+        #       pricing and performance for the selected model.
+        #     - If set to
+        #       '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+        #       the request will be processed with the Flex Processing service tier.
+        #     - To opt-in to
+        #       [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+        #       request level, include the `service_tier=fast` or `service_tier=priority`
+        #       parameter for Responses or Chat Completions. The response will show
+        #       `service_tier=priority` regardless of if you specify `service_tier=fast` or
+        #       `priority` in your request.
+        #     - When not set, the default behavior is 'auto'.
         #
-        #   @param object [Symbol, :"chat.completion"] The object type, which is always `chat.completion`.
-
+        #     When the `service_tier` parameter is set, the response body will include the
+        #     `service_tier` value based on the processing mode actually used to serve the
+        #     request. This response value may be different from the value set in the
+        #     parameter.
+        #
+        #   @param system_fingerprint [String]
+        #     This fingerprint represents the backend configuration that the model runs with.
+        #
+        #     Can be used in conjunction with the `seed` request parameter to understand when
+        #     backend changes have been made that might impact determinism.
+        #
+        #   @param usage [OpenAI::Models::CompletionUsage]
+        #     Usage statistics for the completion request.
+        #
+        #   @param object [Symbol, :"chat.completion"]
+        #     The object type, which is always `chat.completion`.
         class Choice < OpenAI::Internal::Type::BaseModel
           # @!attribute finish_reason
           #   The reason the model stopped generating tokens. This will be `stop` if the model
@@ -157,16 +196,23 @@ module OpenAI
           required :message, -> { OpenAI::Chat::ChatCompletionMessage }
 
           # @!method initialize(finish_reason:, index:, logprobs:, message:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::ChatCompletion::Choice} for more details.
-          #
-          #   @param finish_reason [Symbol, OpenAI::Models::Chat::ChatCompletion::Choice::FinishReason] The reason the model stopped generating tokens. This will be `stop` if the model
+          #   @param finish_reason [Symbol, OpenAI::Models::Chat::ChatCompletion::Choice::FinishReason]
+          #     The reason the model stopped generating tokens. This will be `stop` if the model
+          #     hit a natural stop point or a provided stop sequence, `length` if the maximum
+          #     number of tokens specified in the request was reached, `content_filter` if
+          #     content was omitted due to a flag from our content filters, `tool_calls` if the
+          #     model called a tool, or `function_call` (deprecated) if the model called a
+          #     function. Read the [Model Spec](https://model-spec.openai.com/2025-12-18.html)
+          #     for more.
           #
-          #   @param index [Integer] The index of the choice in the list of choices.
+          #   @param index [Integer]
+          #     The index of the choice in the list of choices.
           #
-          #   @param logprobs [OpenAI::Models::Chat::ChatCompletion::Choice::Logprobs, nil] Log probability information for the choice.
+          #   @param logprobs [OpenAI::Models::Chat::ChatCompletion::Choice::Logprobs, nil]
+          #     Log probability information for the choice.
           #
-          #   @param message [OpenAI::Models::Chat::ChatCompletionMessage] A chat completion message generated by the model.
+          #   @param message [OpenAI::Models::Chat::ChatCompletionMessage]
+          #     A chat completion message generated by the model.
 
           # The reason the model stopped generating tokens. This will be `stop` if the model
           # hit a natural stop point or a provided stop sequence, `length` if the maximum
@@ -215,9 +261,11 @@ module OpenAI
             # @!method initialize(content:, refusal:)
             #   Log probability information for the choice.
             #
-            #   @param content [Array<OpenAI::Models::Chat::ChatCompletionTokenLogprob>, nil] A list of message content tokens with log probability information.
+            #   @param content [Array<OpenAI::Models::Chat::ChatCompletionTokenLogprob>, nil]
+            #     A list of message content tokens with log probability information.
             #
-            #   @param refusal [Array<OpenAI::Models::Chat::ChatCompletionTokenLogprob>, nil] A list of message refusal tokens with log probability information.
+            #   @param refusal [Array<OpenAI::Models::Chat::ChatCompletionTokenLogprob>, nil]
+            #     A list of message refusal tokens with log probability information.
           end
         end
 
@@ -239,9 +287,11 @@ module OpenAI
           #   Moderation results for the request input and generated output, if moderated
           #   completions were requested.
           #
-          #   @param input [OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Input::Error] Moderation for the request input.
+          #   @param input [OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Input::Error]
+          #     Moderation for the request input.
           #
-          #   @param output [OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Output::Error] Moderation for the generated output.
+          #   @param output [OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults, OpenAI::Models::Chat::ChatCompletion::Moderation::Output::Error]
+          #     Moderation for the generated output.
 
           # Moderation for the request input.
           #
@@ -286,12 +336,14 @@ module OpenAI
               # @!method initialize(model:, results:, type: :moderation_results)
               #   Successful moderation results for the request input or generated output.
               #
-              #   @param model [String] The moderation model used to generate the results.
+              #   @param model [String]
+              #     The moderation model used to generate the results.
               #
-              #   @param results [Array<OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result>] A list of moderation results.
+              #   @param results [Array<OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result>]
+              #     A list of moderation results.
               #
-              #   @param type [Symbol, :moderation_results] The object type, which is always `moderation_results`.
-
+              #   @param type [Symbol, :moderation_results]
+              #     The object type, which is always `moderation_results`.
               class Result < OpenAI::Internal::Type::BaseModel
                 # @!attribute categories
                 #   A dictionary of moderation categories to booleans, True if the input is flagged
@@ -341,24 +393,27 @@ module OpenAI
                 required :type, const: :moderation_result
 
                 # @!method initialize(categories:, category_applied_input_types:, category_scores:, flagged:, model:, type: :moderation_result)
-                #   Some parameter documentations has been truncated, see
-                #   {OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result}
-                #   for more details.
-                #
                 #   A moderation result produced for the response input or output.
                 #
-                #   @param categories [Hash{Symbol=>Boolean}] A dictionary of moderation categories to booleans, True if the input is flagged
+                #   @param categories [Hash{Symbol=>Boolean}]
+                #     A dictionary of moderation categories to booleans, True if the input is flagged
+                #     under this category.
                 #
-                #   @param category_applied_input_types [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result::CategoryAppliedInputType>}] Which modalities of input are reflected by the score for each category.
+                #   @param category_applied_input_types [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletion::Moderation::Input::ModerationResults::Result::CategoryAppliedInputType>}]
+                #     Which modalities of input are reflected by the score for each category.
                 #
-                #   @param category_scores [Hash{Symbol=>Float}] A dictionary of moderation categories to scores.
+                #   @param category_scores [Hash{Symbol=>Float}]
+                #     A dictionary of moderation categories to scores.
                 #
-                #   @param flagged [Boolean] A boolean indicating whether the content was flagged by any category.
+                #   @param flagged [Boolean]
+                #     A boolean indicating whether the content was flagged by any category.
                 #
-                #   @param model [String] The moderation model that produced this result.
+                #   @param model [String]
+                #     The moderation model that produced this result.
                 #
-                #   @param type [Symbol, :moderation_result] The object type, which was always `moderation_result` for successful moderation
-
+                #   @param type [Symbol, :moderation_result]
+                #     The object type, which was always `moderation_result` for successful moderation
+                #     results.
                 module CategoryAppliedInputType
                   extend OpenAI::Internal::Type::Enum
 
@@ -393,11 +448,14 @@ module OpenAI
               # @!method initialize(code:, message:, type: :error)
               #   An error produced while attempting moderation.
               #
-              #   @param code [String] The error code.
+              #   @param code [String]
+              #     The error code.
               #
-              #   @param message [String] The error message.
+              #   @param message [String]
+              #     The error message.
               #
-              #   @param type [Symbol, :error] The object type, which is always `error`.
+              #   @param type [Symbol, :error]
+              #     The object type, which is always `error`.
             end
 
             # @!method self.variants
@@ -447,12 +505,14 @@ module OpenAI
               # @!method initialize(model:, results:, type: :moderation_results)
               #   Successful moderation results for the request input or generated output.
               #
-              #   @param model [String] The moderation model used to generate the results.
+              #   @param model [String]
+              #     The moderation model used to generate the results.
               #
-              #   @param results [Array<OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result>] A list of moderation results.
+              #   @param results [Array<OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result>]
+              #     A list of moderation results.
               #
-              #   @param type [Symbol, :moderation_results] The object type, which is always `moderation_results`.
-
+              #   @param type [Symbol, :moderation_results]
+              #     The object type, which is always `moderation_results`.
               class Result < OpenAI::Internal::Type::BaseModel
                 # @!attribute categories
                 #   A dictionary of moderation categories to booleans, True if the input is flagged
@@ -502,24 +562,27 @@ module OpenAI
                 required :type, const: :moderation_result
 
                 # @!method initialize(categories:, category_applied_input_types:, category_scores:, flagged:, model:, type: :moderation_result)
-                #   Some parameter documentations has been truncated, see
-                #   {OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result}
-                #   for more details.
-                #
                 #   A moderation result produced for the response input or output.
                 #
-                #   @param categories [Hash{Symbol=>Boolean}] A dictionary of moderation categories to booleans, True if the input is flagged
+                #   @param categories [Hash{Symbol=>Boolean}]
+                #     A dictionary of moderation categories to booleans, True if the input is flagged
+                #     under this category.
                 #
-                #   @param category_applied_input_types [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result::CategoryAppliedInputType>}] Which modalities of input are reflected by the score for each category.
+                #   @param category_applied_input_types [Hash{Symbol=>Array<Symbol, OpenAI::Models::Chat::ChatCompletion::Moderation::Output::ModerationResults::Result::CategoryAppliedInputType>}]
+                #     Which modalities of input are reflected by the score for each category.
                 #
-                #   @param category_scores [Hash{Symbol=>Float}] A dictionary of moderation categories to scores.
+                #   @param category_scores [Hash{Symbol=>Float}]
+                #     A dictionary of moderation categories to scores.
                 #
-                #   @param flagged [Boolean] A boolean indicating whether the content was flagged by any category.
+                #   @param flagged [Boolean]
+                #     A boolean indicating whether the content was flagged by any category.
                 #
-                #   @param model [String] The moderation model that produced this result.
+                #   @param model [String]
+                #     The moderation model that produced this result.
                 #
-                #   @param type [Symbol, :moderation_result] The object type, which was always `moderation_result` for successful moderation
-
+                #   @param type [Symbol, :moderation_result]
+                #     The object type, which was always `moderation_result` for successful moderation
+                #     results.
                 module CategoryAppliedInputType
                   extend OpenAI::Internal::Type::Enum
 
@@ -554,11 +617,14 @@ module OpenAI
               # @!method initialize(code:, message:, type: :error)
               #   An error produced while attempting moderation.
               #
-              #   @param code [String] The error code.
+              #   @param code [String]
+              #     The error code.
               #
-              #   @param message [String] The error message.
+              #   @param message [String]
+              #     The error message.
               #
-              #   @param type [Symbol, :error] The object type, which is always `error`.
+              #   @param type [Symbol, :error]
+              #     The object type, which is always `error`.
             end
 
             # @!method self.variants
@@ -573,13 +639,15 @@ module OpenAI
         #   will use 'default'.
         # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
-        # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)',
-        #   then the request will be processed with the Flex Processing service tier.
-        # - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level,
-        #   include the `service_tier=fast` or `service_tier=priority` parameter for
-        #   Responses or Chat Completions. The response will show `service_tier=priority`
-        #   regardless of if you specify `service_tier=fast` or `priority` in your
-        #   request.
+        # - If set to
+        #   '[flex](https://developers.openai.com/api/docs/guides/flex-processing)', then
+        #   the request will be processed with the Flex Processing service tier.
+        # - To opt-in to
+        #   [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+        #   request level, include the `service_tier=fast` or `service_tier=priority`
+        #   parameter for Responses or Chat Completions. The response will show
+        #   `service_tier=priority` regardless of if you specify `service_tier=fast` or
+        #   `priority` in your request.
         # - When not set, the default behavior is 'auto'.
         #
         # When the `service_tier` parameter is set, the response body will include the

data/lib/openai/models/chat/chat_completion_allowed_tool_choice.rb

@@ -17,14 +17,13 @@ module OpenAI
         required :type, const: :allowed_tools
 
         # @!method initialize(allowed_tools:, type: :allowed_tools)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletionAllowedToolChoice} for more details.
-        #
         #   Constrains the tools available to the model to a pre-defined set.
         #
-        #   @param allowed_tools [OpenAI::Models::Chat::ChatCompletionAllowedTools] Constrains the tools available to the model to a pre-defined set.
+        #   @param allowed_tools [OpenAI::Models::Chat::ChatCompletionAllowedTools]
+        #     Constrains the tools available to the model to a pre-defined set.
         #
-        #   @param type [Symbol, :allowed_tools] Allowed tool configuration type. Always `allowed_tools`.
+        #   @param type [Symbol, :allowed_tools]
+        #     Allowed tool configuration type. Always `allowed_tools`.
       end
     end
 

data/lib/openai/models/chat/chat_completion_allowed_tools.rb

@@ -34,14 +34,27 @@ module OpenAI
         )
 
         # @!method initialize(mode:, tools:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletionAllowedTools} for more details.
-        #
         #   Constrains the tools available to the model to a pre-defined set.
         #
-        #   @param mode [Symbol, OpenAI::Models::Chat::ChatCompletionAllowedTools::Mode] Constrains the tools available to the model to a pre-defined set.
+        #   @param mode [Symbol, OpenAI::Models::Chat::ChatCompletionAllowedTools::Mode]
+        #     Constrains the tools available to the model to a pre-defined set.
+        #
+        #     `auto` allows the model to pick from among the allowed tools and generate a
+        #     message.
+        #
+        #     `required` requires the model to call one or more of the allowed tools.
+        #
+        #   @param tools [Array<Hash{Symbol=>Object}>]
+        #     A list of tool definitions that the model should be allowed to call.
+        #
+        #     For the Chat Completions API, the list of tool definitions might look like:
         #
-        #   @param tools [Array<Hash{Symbol=>Object}>] A list of tool definitions that the model should be allowed to call.
+        #     ```json
+        #     [
+        #       { "type": "function", "function": { "name": "get_weather" } },
+        #       { "type": "function", "function": { "name": "get_time" } }
+        #     ]
+        #     ```
 
         # Constrains the tools available to the model to a pre-defined set.
         #

data/lib/openai/models/chat/chat_completion_assistant_message_param.rb

@@ -12,7 +12,7 @@ module OpenAI
 
         # @!attribute audio
         #   Data about a previous audio response from the model.
-        #   [Learn more](https://platform.openai.com/docs/guides/audio).
+        #   [Learn more](https://developers.openai.com/api/docs/guides/audio).
         #
         #   @return [OpenAI::Models::Chat::ChatCompletionAssistantMessageParam::Audio, nil]
         optional :audio, -> { OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio }, nil?: true
@@ -66,24 +66,32 @@ module OpenAI
         )
 
         # @!method initialize(audio: nil, content: nil, function_call: nil, name: nil, refusal: nil, tool_calls: nil, role: :assistant)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletionAssistantMessageParam} for more details.
-        #
         #   Messages sent by the model in response to user messages.
         #
-        #   @param audio [OpenAI::Models::Chat::ChatCompletionAssistantMessageParam::Audio, nil] Data about a previous audio response from the model.
+        #   @param audio [OpenAI::Models::Chat::ChatCompletionAssistantMessageParam::Audio, nil]
+        #     Data about a previous audio response from the model.
+        #     [Learn more](https://developers.openai.com/api/docs/guides/audio).
         #
-        #   @param content [String, Array<OpenAI::Models::Chat::ChatCompletionContentPartText, OpenAI::Models::Chat::ChatCompletionContentPartRefusal>, nil] The contents of the assistant message. Required unless `tool_calls` or `function
+        #   @param content [String, Array<OpenAI::Models::Chat::ChatCompletionContentPartText, OpenAI::Models::Chat::ChatCompletionContentPartRefusal>, nil]
+        #     The contents of the assistant message. Required unless `tool_calls` or
+        #     `function_call` is specified.
         #
-        #   @param function_call [OpenAI::Models::Chat::ChatCompletionAssistantMessageParam::FunctionCall, nil] Deprecated and replaced by `tool_calls`. The name and arguments of a function th
+        #   @param function_call [OpenAI::Models::Chat::ChatCompletionAssistantMessageParam::FunctionCall, nil]
+        #     Deprecated and replaced by `tool_calls`. The name and arguments of a function
+        #     that should be called, as generated by the model.
         #
-        #   @param name [String] An optional name for the participant. Provides the model information to differen
+        #   @param name [String]
+        #     An optional name for the participant. Provides the model information to
+        #     differentiate between participants of the same role.
         #
-        #   @param refusal [String, nil] The refusal message by the assistant.
+        #   @param refusal [String, nil]
+        #     The refusal message by the assistant.
         #
-        #   @param tool_calls [Array<OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall, OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall>] The tool calls generated by the model, such as function calls.
+        #   @param tool_calls [Array<OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall, OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall>]
+        #     The tool calls generated by the model, such as function calls.
         #
-        #   @param role [Symbol, :assistant] The role of the messages author, in this case `assistant`.
+        #   @param role [Symbol, :assistant]
+        #     The role of the messages author, in this case `assistant`.
 
         # @see OpenAI::Models::Chat::ChatCompletionAssistantMessageParam#audio
         class Audio < OpenAI::Internal::Type::BaseModel
@@ -94,14 +102,11 @@ module OpenAI
           required :id, String
 
           # @!method initialize(id:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::ChatCompletionAssistantMessageParam::Audio} for more
-          #   details.
-          #
           #   Data about a previous audio response from the model.
-          #   [Learn more](https://platform.openai.com/docs/guides/audio).
+          #   [Learn more](https://developers.openai.com/api/docs/guides/audio).
           #
-          #   @param id [String] Unique identifier for a previous audio response from the model.
+          #   @param id [String]
+          #     Unique identifier for a previous audio response from the model.
         end
 
         # The contents of the assistant message. Required unless `tool_calls` or
@@ -117,14 +122,13 @@ module OpenAI
           # An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`.
           variant -> { OpenAI::Models::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPartArray }
 
-          # Learn about
-          # [text inputs](https://platform.openai.com/docs/guides/text-generation).
+          # Learn about [text inputs](https://developers.openai.com/api/docs/guides/text).
           module ArrayOfContentPart
             extend OpenAI::Internal::Type::Union
 
             discriminator :type
 
-            # Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation).
+            # Learn about [text inputs](https://developers.openai.com/api/docs/guides/text).
             variant :text, -> { OpenAI::Chat::ChatCompletionContentPartText }
 
             variant :refusal, -> { OpenAI::Chat::ChatCompletionContentPartRefusal }
@@ -164,16 +168,17 @@ module OpenAI
           required :name, String
 
           # @!method initialize(arguments:, name:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::ChatCompletionAssistantMessageParam::FunctionCall} for
-          #   more details.
-          #
           #   Deprecated and replaced by `tool_calls`. The name and arguments of a function
           #   that should be called, as generated by the model.
           #
-          #   @param arguments [String] The arguments to call the function with, as generated by the model in JSON forma
+          #   @param arguments [String]
+          #     The arguments to call the function with, as generated by the model in JSON
+          #     format. Note that the model does not always generate valid JSON, and may
+          #     hallucinate parameters not defined by your function schema. Validate the
+          #     arguments in your code before calling your function.
           #
-          #   @param name [String] The name of the function to call.
+          #   @param name [String]
+          #     The name of the function to call.
         end
       end
     end