openai 0.87.0 → 0.89.0

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

@@ -27,16 +27,18 @@ module OpenAI
         )
 
         # @!method initialize(image_url:, prompt_cache_breakpoint: nil, type: :image_url)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletionContentPartImage} for more details.
-        #
-        #   Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
+        #   Learn about
+        #   [image inputs](https://developers.openai.com/api/docs/guides/images-vision).
         #
         #   @param image_url [OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL]
         #
-        #   @param prompt_cache_breakpoint [OpenAI::Models::Chat::ChatCompletionContentPartImage::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Chat::ChatCompletionContentPartImage::PromptCacheBreakpoint]
+        #     Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #     from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        #     token block.
         #
-        #   @param type [Symbol, :image_url] The type of the content part.
+        #   @param type [Symbol, :image_url]
+        #     The type of the content part.
 
         # @see OpenAI::Models::Chat::ChatCompletionContentPartImage#image_url
         class ImageURL < OpenAI::Internal::Type::BaseModel
@@ -48,22 +50,21 @@ module OpenAI
 
           # @!attribute detail
           #   Specifies the detail level of the image. Learn more in the
-          #   [Vision guide](https://platform.openai.com/docs/guides/vision#low-or-high-fidelity-image-understanding).
+          #   [Vision guide](https://developers.openai.com/api/docs/guides/images-vision#choose-an-image-detail-level).
           #
           #   @return [Symbol, OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::Detail, nil]
           optional :detail, enum: -> { OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail }
 
           # @!method initialize(url:, detail: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL} for more
-          #   details.
-          #
-          #   @param url [String] Either a URL of the image or the base64 encoded image data.
+          #   @param url [String]
+          #     Either a URL of the image or the base64 encoded image data.
           #
-          #   @param detail [Symbol, OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::Detail] Specifies the detail level of the image. Learn more in the [Vision guide](https:
+          #   @param detail [Symbol, OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::Detail]
+          #     Specifies the detail level of the image. Learn more in the
+          #     [Vision guide](https://developers.openai.com/api/docs/guides/images-vision#choose-an-image-detail-level).
 
           # Specifies the detail level of the image. Learn more in the
-          # [Vision guide](https://platform.openai.com/docs/guides/vision#low-or-high-fidelity-image-understanding).
+          # [Vision guide](https://developers.openai.com/api/docs/guides/images-vision#choose-an-image-detail-level).
           #
           # @see OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL#detail
           module Detail
@@ -91,7 +92,8 @@ module OpenAI
           #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
           #   token block.
           #
-          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+          #   @param mode [Symbol, :explicit]
+          #     The breakpoint mode. Always `explicit`.
         end
       end
     end

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

@@ -27,16 +27,17 @@ module OpenAI
         )
 
         # @!method initialize(input_audio:, prompt_cache_breakpoint: nil, type: :input_audio)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletionContentPartInputAudio} for more details.
-        #
-        #   Learn about [audio inputs](https://platform.openai.com/docs/guides/audio).
+        #   Learn about [audio inputs](https://developers.openai.com/api/docs/guides/audio).
         #
         #   @param input_audio [OpenAI::Models::Chat::ChatCompletionContentPartInputAudio::InputAudio]
         #
-        #   @param prompt_cache_breakpoint [OpenAI::Models::Chat::ChatCompletionContentPartInputAudio::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Chat::ChatCompletionContentPartInputAudio::PromptCacheBreakpoint]
+        #     Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #     from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        #     token block.
         #
-        #   @param type [Symbol, :input_audio] The type of the content part. Always `input_audio`.
+        #   @param type [Symbol, :input_audio]
+        #     The type of the content part. Always `input_audio`.
 
         # @see OpenAI::Models::Chat::ChatCompletionContentPartInputAudio#input_audio
         class InputAudio < OpenAI::Internal::Type::BaseModel
@@ -57,13 +58,11 @@ module OpenAI
           )
 
           # @!method initialize(data:, format_:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::ChatCompletionContentPartInputAudio::InputAudio} for more
-          #   details.
-          #
-          #   @param data [String] Base64 encoded audio data.
+          #   @param data [String]
+          #     Base64 encoded audio data.
           #
-          #   @param format_ [Symbol, OpenAI::Models::Chat::ChatCompletionContentPartInputAudio::InputAudio::Format] The format of the encoded audio data. Currently supports "wav" and "mp3".
+          #   @param format_ [Symbol, OpenAI::Models::Chat::ChatCompletionContentPartInputAudio::InputAudio::Format]
+          #     The format of the encoded audio data. Currently supports "wav" and "mp3".
 
           # The format of the encoded audio data. Currently supports "wav" and "mp3".
           #
@@ -92,7 +91,8 @@ module OpenAI
           #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
           #   token block.
           #
-          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+          #   @param mode [Symbol, :explicit]
+          #     The breakpoint mode. Always `explicit`.
         end
       end
     end

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

@@ -17,9 +17,11 @@ module OpenAI
         required :type, const: :refusal
 
         # @!method initialize(refusal:, type: :refusal)
-        #   @param refusal [String] The refusal message generated by the model.
+        #   @param refusal [String]
+        #     The refusal message generated by the model.
         #
-        #   @param type [Symbol, :refusal] The type of the content part.
+        #   @param type [Symbol, :refusal]
+        #     The type of the content part.
       end
     end
 

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

@@ -28,17 +28,18 @@ module OpenAI
         )
 
         # @!method initialize(text:, prompt_cache_breakpoint: nil, type: :text)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletionContentPartText} for more details.
+        #   Learn about [text inputs](https://developers.openai.com/api/docs/guides/text).
         #
-        #   Learn about
-        #   [text inputs](https://platform.openai.com/docs/guides/text-generation).
+        #   @param text [String]
+        #     The text content.
         #
-        #   @param text [String] The text content.
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Chat::ChatCompletionContentPartText::PromptCacheBreakpoint]
+        #     Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #     from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        #     token block.
         #
-        #   @param prompt_cache_breakpoint [OpenAI::Models::Chat::ChatCompletionContentPartText::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
-        #
-        #   @param type [Symbol, :text] The type of the content part.
+        #   @param type [Symbol, :text]
+        #     The type of the content part.
 
         # @see OpenAI::Models::Chat::ChatCompletionContentPartText#prompt_cache_breakpoint
         class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
@@ -53,7 +54,8 @@ module OpenAI
           #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
           #   token block.
           #
-          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+          #   @param mode [Symbol, :explicit]
+          #     The breakpoint mode. Always `explicit`.
         end
       end
     end

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

@@ -17,14 +17,13 @@ module OpenAI
         required :type, const: :custom
 
         # @!method initialize(custom:, type: :custom)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletionCustomTool} for more details.
-        #
         #   A custom tool that processes input using a specified format.
         #
-        #   @param custom [OpenAI::Models::Chat::ChatCompletionCustomTool::Custom] Properties of the custom tool.
+        #   @param custom [OpenAI::Models::Chat::ChatCompletionCustomTool::Custom]
+        #     Properties of the custom tool.
         #
-        #   @param type [Symbol, :custom] The type of the custom tool. Always `custom`.
+        #   @param type [Symbol, :custom]
+        #     The type of the custom tool. Always `custom`.
 
         # @see OpenAI::Models::Chat::ChatCompletionCustomTool#custom
         class Custom < OpenAI::Internal::Type::BaseModel
@@ -53,16 +52,16 @@ module OpenAI
           )
 
           # @!method initialize(name:, description: nil, format_: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::ChatCompletionCustomTool::Custom} for more details.
-          #
           #   Properties of the custom tool.
           #
-          #   @param name [String] The name of the custom tool, used to identify it in tool calls.
+          #   @param name [String]
+          #     The name of the custom tool, used to identify it in tool calls.
           #
-          #   @param description [String] Optional description of the custom tool, used to provide more context.
+          #   @param description [String]
+          #     Optional description of the custom tool, used to provide more context.
           #
-          #   @param format_ [OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Text, OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar] The input format for the custom tool. Default is unconstrained text.
+          #   @param format_ [OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Text, OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar]
+          #     The input format for the custom tool. Default is unconstrained text.
 
           # The input format for the custom tool. Default is unconstrained text.
           #
@@ -88,7 +87,8 @@ module OpenAI
               # @!method initialize(type: :text)
               #   Unconstrained free-form text.
               #
-              #   @param type [Symbol, :text] Unconstrained text format. Always `text`.
+              #   @param type [Symbol, :text]
+              #     Unconstrained text format. Always `text`.
             end
 
             class Grammar < OpenAI::Internal::Type::BaseModel
@@ -107,9 +107,11 @@ module OpenAI
               # @!method initialize(grammar:, type: :grammar)
               #   A grammar defined by the user.
               #
-              #   @param grammar [OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar] Your chosen grammar.
+              #   @param grammar [OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar]
+              #     Your chosen grammar.
               #
-              #   @param type [Symbol, :grammar] Grammar format. Always `grammar`.
+              #   @param type [Symbol, :grammar]
+              #     Grammar format. Always `grammar`.
 
               # @see OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar#grammar
               class Grammar < OpenAI::Internal::Type::BaseModel
@@ -131,9 +133,11 @@ module OpenAI
                 # @!method initialize(definition:, syntax:)
                 #   Your chosen grammar.
                 #
-                #   @param definition [String] The grammar definition.
+                #   @param definition [String]
+                #     The grammar definition.
                 #
-                #   @param syntax [Symbol, OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax] The syntax of the grammar definition. One of `lark` or `regex`.
+                #   @param syntax [Symbol, OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::Syntax]
+                #     The syntax of the grammar definition. One of `lark` or `regex`.
 
                 # The syntax of the grammar definition. One of `lark` or `regex`.
                 #

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

@@ -24,11 +24,14 @@ module OpenAI
         required :object, const: :"chat.completion.deleted"
 
         # @!method initialize(id:, deleted:, object: :"chat.completion.deleted")
-        #   @param id [String] The ID of the chat completion that was deleted.
+        #   @param id [String]
+        #     The ID of the chat completion that was deleted.
         #
-        #   @param deleted [Boolean] Whether the chat completion was deleted.
+        #   @param deleted [Boolean]
+        #     Whether the chat completion was deleted.
         #
-        #   @param object [Symbol, :"chat.completion.deleted"] The type of object being deleted.
+        #   @param object [Symbol, :"chat.completion.deleted"]
+        #     The type of object being deleted.
       end
     end
 

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

@@ -24,18 +24,19 @@ module OpenAI
         optional :name, String
 
         # @!method initialize(content:, name: nil, role: :developer)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam} for more details.
-        #
         #   Developer-provided instructions that the model should follow, regardless of
         #   messages sent by the user. With o1 models and newer, `developer` messages
         #   replace the previous `system` messages.
         #
-        #   @param content [String, Array<OpenAI::Models::Chat::ChatCompletionContentPartText>] The contents of the developer message.
+        #   @param content [String, Array<OpenAI::Models::Chat::ChatCompletionContentPartText>]
+        #     The contents of the developer message.
         #
-        #   @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 role [Symbol, :developer] The role of the messages author, in this case `developer`.
+        #   @param role [Symbol, :developer]
+        #     The role of the messages author, in this case `developer`.
 
         # The contents of the developer message.
         #

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

@@ -14,7 +14,8 @@ module OpenAI
         #   Specifying a particular function via `{"name": "my_function"}` forces the model
         #   to call that function.
         #
-        #   @param name [String] The name of the function to call.
+        #   @param name [String]
+        #     The name of the function to call.
       end
     end
 

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

@@ -24,11 +24,14 @@ module OpenAI
         required :role, const: :function
 
         # @!method initialize(content:, name:, role: :function)
-        #   @param content [String, nil] The contents of the function message.
+        #   @param content [String, nil]
+        #     The contents of the function message.
         #
-        #   @param name [String] The name of the function to call.
+        #   @param name [String]
+        #     The name of the function to call.
         #
-        #   @param role [Symbol, :function] The role of the messages author, in this case `function`.
+        #   @param role [Symbol, :function]
+        #     The role of the messages author, in this case `function`.
       end
     end
 

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

@@ -20,7 +20,8 @@ module OpenAI
         #
         #   @param function [OpenAI::Models::FunctionDefinition]
         #
-        #   @param type [Symbol, :function] The type of the tool. Currently, only `function` is supported.
+        #   @param type [Symbol, :function]
+        #     The type of the tool. Currently, only `function` is supported.
       end
     end
 

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

@@ -32,7 +32,7 @@ module OpenAI
 
         # @!attribute annotations
         #   Annotations for the message, when applicable, as when using the
-        #   [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
+        #   [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
         #
         #   @return [Array<OpenAI::Models::Chat::ChatCompletionMessage::Annotation>, nil]
         optional(
@@ -43,7 +43,7 @@ module OpenAI
         # @!attribute audio
         #   If the audio output modality is requested, this object contains data about the
         #   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::ChatCompletionAudio, nil]
         optional :audio, -> { OpenAI::Chat::ChatCompletionAudio }, nil?: true
@@ -67,25 +67,32 @@ module OpenAI
         )
 
         # @!method initialize(content:, refusal:, annotations: nil, audio: nil, function_call: nil, tool_calls: nil, role: :assistant)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletionMessage} for more details.
-        #
         #   A chat completion message generated by the model.
         #
-        #   @param content [String, nil] The contents of the message.
+        #   @param content [String, nil]
+        #     The contents of the message.
         #
-        #   @param refusal [String, nil] The refusal message generated by the model.
+        #   @param refusal [String, nil]
+        #     The refusal message generated by the model.
         #
-        #   @param annotations [Array<OpenAI::Models::Chat::ChatCompletionMessage::Annotation>] Annotations for the message, when applicable, as when using the
+        #   @param annotations [Array<OpenAI::Models::Chat::ChatCompletionMessage::Annotation>]
+        #     Annotations for the message, when applicable, as when using the
+        #     [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
         #
-        #   @param audio [OpenAI::Models::Chat::ChatCompletionAudio, nil] If the audio output modality is requested, this object contains data
+        #   @param audio [OpenAI::Models::Chat::ChatCompletionAudio, nil]
+        #     If the audio output modality is requested, this object contains data about the
+        #     audio response from the model.
+        #     [Learn more](https://developers.openai.com/api/docs/guides/audio).
         #
-        #   @param function_call [OpenAI::Models::Chat::ChatCompletionMessage::FunctionCall] Deprecated and replaced by `tool_calls`. The name and arguments of a function th
+        #   @param function_call [OpenAI::Models::Chat::ChatCompletionMessage::FunctionCall]
+        #     Deprecated and replaced by `tool_calls`. The name and arguments of a function
+        #     that should be called, as generated by the model.
         #
-        #   @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 author of this message.
-
+        #   @param role [Symbol, :assistant]
+        #     The role of the author of this message.
         class Annotation < OpenAI::Internal::Type::BaseModel
           # @!attribute type
           #   The type of the URL citation. Always `url_citation`.
@@ -102,9 +109,11 @@ module OpenAI
           # @!method initialize(url_citation:, type: :url_citation)
           #   A URL citation when using web search.
           #
-          #   @param url_citation [OpenAI::Models::Chat::ChatCompletionMessage::Annotation::URLCitation] A URL citation when using web search.
+          #   @param url_citation [OpenAI::Models::Chat::ChatCompletionMessage::Annotation::URLCitation]
+          #     A URL citation when using web search.
           #
-          #   @param type [Symbol, :url_citation] The type of the URL citation. Always `url_citation`.
+          #   @param type [Symbol, :url_citation]
+          #     The type of the URL citation. Always `url_citation`.
 
           # @see OpenAI::Models::Chat::ChatCompletionMessage::Annotation#url_citation
           class URLCitation < OpenAI::Internal::Type::BaseModel
@@ -135,13 +144,17 @@ module OpenAI
             # @!method initialize(end_index:, start_index:, title:, url:)
             #   A URL citation when using web search.
             #
-            #   @param end_index [Integer] The index of the last character of the URL citation in the message.
+            #   @param end_index [Integer]
+            #     The index of the last character of the URL citation in the message.
             #
-            #   @param start_index [Integer] The index of the first character of the URL citation in the message.
+            #   @param start_index [Integer]
+            #     The index of the first character of the URL citation in the message.
             #
-            #   @param title [String] The title of the web resource.
+            #   @param title [String]
+            #     The title of the web resource.
             #
-            #   @param url [String] The URL of the web resource.
+            #   @param url [String]
+            #     The URL of the web resource.
           end
         end
 
@@ -165,15 +178,17 @@ module OpenAI
           required :name, String
 
           # @!method initialize(arguments:, name:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::ChatCompletionMessage::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

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

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(id:, custom:, type: :custom)
         #   A call to a custom tool created by the model.
         #
-        #   @param id [String] The ID of the tool call.
+        #   @param id [String]
+        #     The ID of the tool call.
         #
-        #   @param custom [OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall::Custom] The custom tool that the model called.
+        #   @param custom [OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall::Custom]
+        #     The custom tool that the model called.
         #
-        #   @param type [Symbol, :custom] The type of the tool. Always `custom`.
+        #   @param type [Symbol, :custom]
+        #     The type of the tool. Always `custom`.
 
         # @see OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall#custom
         class Custom < OpenAI::Internal::Type::BaseModel
@@ -48,9 +51,11 @@ module OpenAI
           # @!method initialize(input:, name:)
           #   The custom tool that the model called.
           #
-          #   @param input [String] The input for the custom tool call generated by the model.
+          #   @param input [String]
+          #     The input for the custom tool call generated by the model.
           #
-          #   @param name [String] The name of the custom tool to call.
+          #   @param name [String]
+          #     The name of the custom tool to call.
         end
       end
     end

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

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(id:, function:, type: :function)
         #   A call to a function tool created by the model.
         #
-        #   @param id [String] The ID of the tool call.
+        #   @param id [String]
+        #     The ID of the tool call.
         #
-        #   @param function [OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall::Function] The function that the model called.
+        #   @param function [OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall::Function]
+        #     The function that the model called.
         #
-        #   @param type [Symbol, :function] The type of the tool. Currently, only `function` is supported.
+        #   @param type [Symbol, :function]
+        #     The type of the tool. Currently, only `function` is supported.
 
         # @see OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall#function
         class Function < OpenAI::Internal::Type::BaseModel
@@ -57,15 +60,16 @@ module OpenAI
           required :name, String
 
           # @!method initialize(arguments:, name:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall::Function} for more
-          #   details.
-          #
           #   The function that the model called.
           #
-          #   @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

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

@@ -21,7 +21,8 @@ module OpenAI
         #
         #   @param function [OpenAI::Models::Chat::ChatCompletionNamedToolChoice::Function]
         #
-        #   @param type [Symbol, :function] For function calling, the type is always `function`.
+        #   @param type [Symbol, :function]
+        #     For function calling, the type is always `function`.
 
         # @see OpenAI::Models::Chat::ChatCompletionNamedToolChoice#function
         class Function < OpenAI::Internal::Type::BaseModel
@@ -32,7 +33,8 @@ module OpenAI
           required :name, String
 
           # @!method initialize(name:)
-          #   @param name [String] The name of the function to call.
+          #   @param name [String]
+          #     The name of the function to call.
         end
       end
     end

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

@@ -21,7 +21,8 @@ module OpenAI
         #
         #   @param custom [OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom::Custom]
         #
-        #   @param type [Symbol, :custom] For custom tool calling, the type is always `custom`.
+        #   @param type [Symbol, :custom]
+        #     For custom tool calling, the type is always `custom`.
 
         # @see OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom#custom
         class Custom < OpenAI::Internal::Type::BaseModel
@@ -32,7 +33,8 @@ module OpenAI
           required :name, String
 
           # @!method initialize(name:)
-          #   @param name [String] The name of the custom tool to call.
+          #   @param name [String]
+          #     The name of the custom tool to call.
         end
       end
     end

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

@@ -20,15 +20,17 @@ module OpenAI
         required :type, const: :content
 
         # @!method initialize(content:, type: :content)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletionPredictionContent} for more details.
-        #
         #   Static predicted output content, such as the content of a text file that is
         #   being regenerated.
         #
-        #   @param content [String, Array<OpenAI::Models::Chat::ChatCompletionContentPartText>] The content that should be matched when generating a model response.
+        #   @param content [String, Array<OpenAI::Models::Chat::ChatCompletionContentPartText>]
+        #     The content that should be matched when generating a model response. If
+        #     generated tokens would match this content, the entire model response can be
+        #     returned much more quickly.
         #
-        #   @param type [Symbol, :content] The type of the predicted content you want to provide. This type is
+        #   @param type [Symbol, :content]
+        #     The type of the predicted content you want to provide. This type is currently
+        #     always `content`.
 
         # The content that should be matched when generating a model response. If
         # generated tokens would match this content, the entire model response can be
@@ -42,7 +44,7 @@ module OpenAI
           # text of a file you are regenerating with minor changes.
           variant String
 
-          # An array of content parts with a defined type. Supported options differ based on the [model](https://platform.openai.com/docs/models) being used to generate the response. Can contain text inputs.
+          # An array of content parts with a defined type. Supported options differ based on the [model](https://developers.openai.com/api/docs/models) being used to generate the response. Can contain text inputs.
           variant(
             -> { OpenAI::Models::Chat::ChatCompletionPredictionContent::Content::ChatCompletionContentPartTextArray }
           )