openai 0.91.0 → 0.93.0

data/sig/openai/models/chat/chat_completion_content_part_input_audio.rbs

@@ -13,14 +13,27 @@ module OpenAI
       class ChatCompletionContentPartInputAudio < OpenAI::Internal::Type::BaseModel
         attr_accessor input_audio: OpenAI::Chat::ChatCompletionContentPartInputAudio::InputAudio
 
+        # The type of the content part. Always `input_audio`.
         attr_accessor type: :input_audio
 
+        # 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.
         attr_reader prompt_cache_breakpoint: OpenAI::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.
         def prompt_cache_breakpoint=: (
           OpenAI::Chat::ChatCompletionContentPartInputAudio::PromptCacheBreakpoint
         ) -> OpenAI::Chat::ChatCompletionContentPartInputAudio::PromptCacheBreakpoint
 
+        # @param prompt_cache_breakpoint
+        #   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
+        #   The type of the content part. Always `input_audio`.
         def initialize: (
           input_audio: OpenAI::Chat::ChatCompletionContentPartInputAudio::InputAudio,
           ?prompt_cache_breakpoint: OpenAI::Chat::ChatCompletionContentPartInputAudio::PromptCacheBreakpoint,
@@ -40,10 +53,16 @@ module OpenAI
           }
 
         class InputAudio < OpenAI::Internal::Type::BaseModel
+          # Base64 encoded audio data.
           attr_accessor data: String
 
+          # The format of the encoded audio data. Currently supports "wav" and "mp3".
           attr_accessor format_: OpenAI::Models::Chat::ChatCompletionContentPartInputAudio::InputAudio::format_
 
+          # @param data
+          #   Base64 encoded audio data.
+          # @param format_
+          #   The format of the encoded audio data. Currently supports "wav" and "mp3".
           def initialize: (
             data: String,
             format_: OpenAI::Models::Chat::ChatCompletionContentPartInputAudio::InputAudio::format_
@@ -69,8 +88,11 @@ module OpenAI
         type prompt_cache_breakpoint = { ?mode: :explicit }
 
         class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # The breakpoint mode. Always `explicit`.
           attr_accessor mode: :explicit
 
+          # @param mode
+          #   The breakpoint mode. Always `explicit`.
           def initialize: (?mode: :explicit) -> void
 
           def to_hash: -> { ?mode: :explicit }

data/sig/openai/models/chat/chat_completion_content_part_refusal.rbs

@@ -7,10 +7,16 @@ module OpenAI
         { refusal: String, ?type: :refusal }
 
       class ChatCompletionContentPartRefusal < OpenAI::Internal::Type::BaseModel
+        # The refusal message generated by the model.
         attr_accessor refusal: String
 
+        # The type of the content part.
         attr_accessor type: :refusal
 
+        # @param refusal
+        #   The refusal message generated by the model.
+        # @param type
+        #   The type of the content part.
         def initialize: (refusal: String, ?type: :refusal) -> void
 
         def to_hash: -> { refusal: String, ?type: :refusal }

data/sig/openai/models/chat/chat_completion_content_part_text.rbs

@@ -11,16 +11,32 @@ module OpenAI
         }
 
       class ChatCompletionContentPartText < OpenAI::Internal::Type::BaseModel
+        # The text content.
         attr_accessor text: String
 
+        # The type of the content part.
         attr_accessor type: :text
 
+        # 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.
         attr_reader prompt_cache_breakpoint: OpenAI::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.
         def prompt_cache_breakpoint=: (
           OpenAI::Chat::ChatCompletionContentPartText::PromptCacheBreakpoint
         ) -> OpenAI::Chat::ChatCompletionContentPartText::PromptCacheBreakpoint
 
+        # @param text
+        #   The text content.
+        # @param prompt_cache_breakpoint
+        #   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
+        #   The type of the content part.
         def initialize: (
           text: String,
           ?prompt_cache_breakpoint: OpenAI::Chat::ChatCompletionContentPartText::PromptCacheBreakpoint,
@@ -36,8 +52,11 @@ module OpenAI
         type prompt_cache_breakpoint = { ?mode: :explicit }
 
         class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # The breakpoint mode. Always `explicit`.
           attr_accessor mode: :explicit
 
+          # @param mode
+          #   The breakpoint mode. Always `explicit`.
           def initialize: (?mode: :explicit) -> void
 
           def to_hash: -> { ?mode: :explicit }

data/sig/openai/models/chat/chat_completion_custom_tool.rbs

@@ -10,10 +10,16 @@ module OpenAI
         }
 
       class ChatCompletionCustomTool < OpenAI::Internal::Type::BaseModel
+        # Properties of the custom tool.
         attr_accessor custom: OpenAI::Chat::ChatCompletionCustomTool::Custom
 
+        # The type of the custom tool. Always `custom`.
         attr_accessor type: :custom
 
+        # @param custom
+        #   Properties of the custom tool.
+        # @param type
+        #   The type of the custom tool. Always `custom`.
         def initialize: (
           custom: OpenAI::Chat::ChatCompletionCustomTool::Custom,
           ?type: :custom
@@ -32,18 +38,29 @@ module OpenAI
           }
 
         class Custom < OpenAI::Internal::Type::BaseModel
+          # The name of the custom tool, used to identify it in tool calls.
           attr_accessor name: String
 
+          # Optional description of the custom tool, used to provide more context.
           attr_reader description: String?
 
+          # Optional description of the custom tool, used to provide more context.
           def description=: (String) -> String
 
+          # The input format for the custom tool. Default is unconstrained text.
           attr_reader format_: OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::format_?
 
+          # The input format for the custom tool. Default is unconstrained text.
           def format_=: (
             OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::format_
           ) -> OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::format_
 
+          # @param name
+          #   The name of the custom tool, used to identify it in tool calls.
+          # @param description
+          #   Optional description of the custom tool, used to provide more context.
+          # @param format_
+          #   The input format for the custom tool. Default is unconstrained text.
           def initialize: (
             name: String,
             ?description: String,
@@ -66,8 +83,11 @@ module OpenAI
             type text = { ?type: :text }
 
             class Text < OpenAI::Internal::Type::BaseModel
+              # Unconstrained text format. Always `text`.
               attr_accessor type: :text
 
+              # @param type
+              #   Unconstrained text format. Always `text`.
               def initialize: (?type: :text) -> void
 
               def to_hash: -> { ?type: :text }
@@ -80,10 +100,16 @@ module OpenAI
               }
 
             class Grammar < OpenAI::Internal::Type::BaseModel
+              # Your chosen grammar.
               attr_accessor grammar: OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar
 
+              # Grammar format. Always `grammar`.
               attr_accessor type: :grammar
 
+              # @param grammar
+              #   Your chosen grammar.
+              # @param type
+              #   Grammar format. Always `grammar`.
               def initialize: (
                 grammar: OpenAI::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar,
                 ?type: :grammar
@@ -101,10 +127,16 @@ module OpenAI
                 }
 
               class Grammar < OpenAI::Internal::Type::BaseModel
+                # The grammar definition.
                 attr_accessor definition: String
 
+                # The syntax of the grammar definition. One of `lark` or `regex`.
                 attr_accessor syntax: OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::syntax
 
+                # @param definition
+                #   The grammar definition.
+                # @param syntax
+                #   The syntax of the grammar definition. One of `lark` or `regex`.
                 def initialize: (
                   definition: String,
                   syntax: OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Grammar::Grammar::syntax

data/sig/openai/models/chat/chat_completion_deleted.rbs

@@ -7,12 +7,21 @@ module OpenAI
         { id: String, deleted: bool, ?object: :"chat.completion.deleted" }
 
       class ChatCompletionDeleted < OpenAI::Internal::Type::BaseModel
+        # The ID of the chat completion that was deleted.
         attr_accessor id: String
 
+        # Whether the chat completion was deleted.
         attr_accessor deleted: bool
 
+        # The type of object being deleted.
         attr_accessor object: :"chat.completion.deleted"
 
+        # @param id
+        #   The ID of the chat completion that was deleted.
+        # @param deleted
+        #   Whether the chat completion was deleted.
+        # @param object
+        #   The type of object being deleted.
         def initialize: (
           id: String,
           deleted: bool,

data/sig/openai/models/chat/chat_completion_developer_message_param.rbs

@@ -11,14 +11,27 @@ module OpenAI
         }
 
       class ChatCompletionDeveloperMessageParam < OpenAI::Internal::Type::BaseModel
+        # The contents of the developer message.
         attr_accessor content: OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam::content
 
+        # The role of the messages author, in this case `developer`.
         attr_accessor role: :developer
 
+        # An optional name for the participant. Provides the model information to
+        # differentiate between participants of the same role.
         attr_reader name: String?
 
+        # An optional name for the participant. Provides the model information to
+        # differentiate between participants of the same role.
         def name=: (String) -> String
 
+        # @param content
+        #   The contents of the developer message.
+        # @param name
+        #   An optional name for the participant. Provides the model information to
+        #   differentiate between participants of the same role.
+        # @param role
+        #   The role of the messages author, in this case `developer`.
         def initialize: (
           content: OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam::content,
           ?name: String,

data/sig/openai/models/chat/chat_completion_function_call_option.rbs

@@ -6,8 +6,11 @@ module OpenAI
       type chat_completion_function_call_option = { name: String }
 
       class ChatCompletionFunctionCallOption < OpenAI::Internal::Type::BaseModel
+        # The name of the function to call.
         attr_accessor name: String
 
+        # @param name
+        #   The name of the function to call.
         def initialize: (name: String) -> void
 
         def to_hash: -> { name: String }

data/sig/openai/models/chat/chat_completion_function_message_param.rbs

@@ -7,12 +7,21 @@ module OpenAI
         { content: String?, name: String, ?role: :function }
 
       class ChatCompletionFunctionMessageParam < OpenAI::Internal::Type::BaseModel
+        # The contents of the function message.
         attr_accessor content: String?
 
+        # The name of the function to call.
         attr_accessor name: String
 
+        # The role of the messages author, in this case `function`.
         attr_accessor role: :function
 
+        # @param content
+        #   The contents of the function message.
+        # @param name
+        #   The name of the function to call.
+        # @param role
+        #   The role of the messages author, in this case `function`.
         def initialize: (
           content: String?,
           name: String,

data/sig/openai/models/chat/chat_completion_function_tool.rbs

@@ -9,8 +9,11 @@ module OpenAI
       class ChatCompletionFunctionTool < OpenAI::Internal::Type::BaseModel
         attr_accessor function: OpenAI::FunctionDefinition
 
+        # The type of the tool. Currently, only `function` is supported.
         attr_accessor type: :function
 
+        # @param type
+        #   The type of the tool. Currently, only `function` is supported.
         def initialize: (
           function: OpenAI::FunctionDefinition,
           ?type: :function

data/sig/openai/models/chat/chat_completion_message.rbs

@@ -15,32 +15,66 @@ module OpenAI
         }
 
       class ChatCompletionMessage < OpenAI::Internal::Type::BaseModel
+        # The contents of the message.
         attr_accessor content: String?
 
+        # The refusal message generated by the model.
         attr_accessor refusal: String?
 
+        # The role of the author of this message.
         attr_accessor role: :assistant
 
+        # Annotations for the message, when applicable, as when using the
+        # [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search).
         attr_reader annotations: ::Array[OpenAI::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).
         def annotations=: (
           ::Array[OpenAI::Chat::ChatCompletionMessage::Annotation]
         ) -> ::Array[OpenAI::Chat::ChatCompletionMessage::Annotation]
 
+        # 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).
         attr_accessor audio: OpenAI::Chat::ChatCompletionAudio?
 
+        # Deprecated and replaced by `tool_calls`. The name and arguments of a function
+        # that should be called, as generated by the model.
         attr_reader function_call: OpenAI::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.
         def function_call=: (
           OpenAI::Chat::ChatCompletionMessage::FunctionCall
         ) -> OpenAI::Chat::ChatCompletionMessage::FunctionCall
 
+        # The tool calls generated by the model, such as function calls.
         attr_reader tool_calls: ::Array[OpenAI::Models::Chat::chat_completion_message_tool_call]?
 
+        # The tool calls generated by the model, such as function calls.
         def tool_calls=: (
           ::Array[OpenAI::Models::Chat::chat_completion_message_tool_call]
         ) -> ::Array[OpenAI::Models::Chat::chat_completion_message_tool_call]
 
+        # @param content
+        #   The contents of the message.
+        # @param refusal
+        #   The refusal message generated by the model.
+        # @param annotations
+        #   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
+        #   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
+        #   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
+        #   The tool calls generated by the model, such as function calls.
+        # @param role
+        #   The role of the author of this message.
         def initialize: (
           content: String?,
           refusal: String?,
@@ -68,10 +102,16 @@ module OpenAI
           }
 
         class Annotation < OpenAI::Internal::Type::BaseModel
+          # The type of the URL citation. Always `url_citation`.
           attr_accessor type: :url_citation
 
+          # A URL citation when using web search.
           attr_accessor url_citation: OpenAI::Chat::ChatCompletionMessage::Annotation::URLCitation
 
+          # @param url_citation
+          #   A URL citation when using web search.
+          # @param type
+          #   The type of the URL citation. Always `url_citation`.
           def initialize: (
             url_citation: OpenAI::Chat::ChatCompletionMessage::Annotation::URLCitation,
             ?type: :url_citation
@@ -91,14 +131,26 @@ module OpenAI
             }
 
           class URLCitation < OpenAI::Internal::Type::BaseModel
+            # The index of the last character of the URL citation in the message.
             attr_accessor end_index: Integer
 
+            # The index of the first character of the URL citation in the message.
             attr_accessor start_index: Integer
 
+            # The title of the web resource.
             attr_accessor title: String
 
+            # The URL of the web resource.
             attr_accessor url: String
 
+            # @param end_index
+            #   The index of the last character of the URL citation in the message.
+            # @param start_index
+            #   The index of the first character of the URL citation in the message.
+            # @param title
+            #   The title of the web resource.
+            # @param url
+            #   The URL of the web resource.
             def initialize: (
               end_index: Integer,
               start_index: Integer,
@@ -118,10 +170,22 @@ module OpenAI
         type function_call = { arguments: String, name: String }
 
         class FunctionCall < OpenAI::Internal::Type::BaseModel
+          # 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.
           attr_accessor arguments: String
 
+          # The name of the function to call.
           attr_accessor name: String
 
+          # @param arguments
+          #   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
+          #   The name of the function to call.
           def initialize: (arguments: String, name: String) -> void
 
           def to_hash: -> { arguments: String, name: String }

data/sig/openai/models/chat/chat_completion_message_custom_tool_call.rbs

@@ -11,12 +11,21 @@ module OpenAI
         }
 
       class ChatCompletionMessageCustomToolCall < OpenAI::Internal::Type::BaseModel
+        # The ID of the tool call.
         attr_accessor id: String
 
+        # The custom tool that the model called.
         attr_accessor custom: OpenAI::Chat::ChatCompletionMessageCustomToolCall::Custom
 
+        # The type of the tool. Always `custom`.
         attr_accessor type: :custom
 
+        # @param id
+        #   The ID of the tool call.
+        # @param custom
+        #   The custom tool that the model called.
+        # @param type
+        #   The type of the tool. Always `custom`.
         def initialize: (
           id: String,
           custom: OpenAI::Chat::ChatCompletionMessageCustomToolCall::Custom,
@@ -32,10 +41,16 @@ module OpenAI
         type custom = { input: String, name: String }
 
         class Custom < OpenAI::Internal::Type::BaseModel
+          # The input for the custom tool call generated by the model.
           attr_accessor input: String
 
+          # The name of the custom tool to call.
           attr_accessor name: String
 
+          # @param input
+          #   The input for the custom tool call generated by the model.
+          # @param name
+          #   The name of the custom tool to call.
           def initialize: (input: String, name: String) -> void
 
           def to_hash: -> { input: String, name: String }

data/sig/openai/models/chat/chat_completion_message_function_tool_call.rbs

@@ -11,12 +11,21 @@ module OpenAI
         }
 
       class ChatCompletionMessageFunctionToolCall < OpenAI::Internal::Type::BaseModel
+        # The ID of the tool call.
         attr_accessor id: String
 
+        # The function that the model called.
         attr_accessor function: OpenAI::Chat::ChatCompletionMessageFunctionToolCall::Function
 
+        # The type of the tool. Currently, only `function` is supported.
         attr_accessor type: :function
 
+        # @param id
+        #   The ID of the tool call.
+        # @param function
+        #   The function that the model called.
+        # @param type
+        #   The type of the tool. Currently, only `function` is supported.
         def initialize: (
           id: String,
           function: OpenAI::Chat::ChatCompletionMessageFunctionToolCall::Function,
@@ -32,10 +41,22 @@ module OpenAI
         type function = { arguments: String, name: String }
 
         class Function < OpenAI::Internal::Type::BaseModel
+          # 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.
           attr_accessor arguments: String
 
+          # The name of the function to call.
           attr_accessor name: String
 
+          # @param arguments
+          #   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
+          #   The name of the function to call.
           def initialize: (arguments: String, name: String) -> void
 
           def to_hash: -> { arguments: String, name: String }

data/sig/openai/models/chat/chat_completion_named_tool_choice.rbs

@@ -12,8 +12,11 @@ module OpenAI
       class ChatCompletionNamedToolChoice < OpenAI::Internal::Type::BaseModel
         attr_accessor function: OpenAI::Chat::ChatCompletionNamedToolChoice::Function
 
+        # For function calling, the type is always `function`.
         attr_accessor type: :function
 
+        # @param type
+        #   For function calling, the type is always `function`.
         def initialize: (
           function: OpenAI::Chat::ChatCompletionNamedToolChoice::Function,
           ?type: :function
@@ -27,8 +30,11 @@ module OpenAI
         type function = { name: String }
 
         class Function < OpenAI::Internal::Type::BaseModel
+          # The name of the function to call.
           attr_accessor name: String
 
+          # @param name
+          #   The name of the function to call.
           def initialize: (name: String) -> void
 
           def to_hash: -> { name: String }

data/sig/openai/models/chat/chat_completion_named_tool_choice_custom.rbs

@@ -12,8 +12,11 @@ module OpenAI
       class ChatCompletionNamedToolChoiceCustom < OpenAI::Internal::Type::BaseModel
         attr_accessor custom: OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::Custom
 
+        # For custom tool calling, the type is always `custom`.
         attr_accessor type: :custom
 
+        # @param type
+        #   For custom tool calling, the type is always `custom`.
         def initialize: (
           custom: OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::Custom,
           ?type: :custom
@@ -27,8 +30,11 @@ module OpenAI
         type custom = { name: String }
 
         class Custom < OpenAI::Internal::Type::BaseModel
+          # The name of the custom tool to call.
           attr_accessor name: String
 
+          # @param name
+          #   The name of the custom tool to call.
           def initialize: (name: String) -> void
 
           def to_hash: -> { name: String }

data/sig/openai/models/chat/chat_completion_prediction_content.rbs

@@ -10,10 +10,22 @@ module OpenAI
         }
 
       class ChatCompletionPredictionContent < OpenAI::Internal::Type::BaseModel
+        # 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.
         attr_accessor content: OpenAI::Models::Chat::ChatCompletionPredictionContent::content
 
+        # The type of the predicted content you want to provide. This type is currently
+        # always `content`.
         attr_accessor type: :content
 
+        # @param 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
+        #   returned much more quickly.
+        # @param type
+        #   The type of the predicted content you want to provide. This type is currently
+        #   always `content`.
         def initialize: (
           content: OpenAI::Models::Chat::ChatCompletionPredictionContent::content,
           ?type: :content

data/sig/openai/models/chat/chat_completion_store_message.rbs

@@ -17,16 +17,45 @@ module OpenAI
         }
 
       class ChatCompletionStoreMessage < OpenAI::Models::Chat::ChatCompletionMessage
+        # The identifier of the chat message.
         def id: -> String
 
+        # The identifier of the chat message.
         def id=: (String _) -> String
 
+        # If a content parts array was provided, this is an array of `text` and
+        # `image_url` parts. Otherwise, null.
         def content_parts: -> ::Array[OpenAI::Models::Chat::ChatCompletionStoreMessage::content_part]?
 
+        # If a content parts array was provided, this is an array of `text` and
+        # `image_url` parts. Otherwise, null.
         def content_parts=: (
           ::Array[OpenAI::Models::Chat::ChatCompletionStoreMessage::content_part]? _
         ) -> ::Array[OpenAI::Models::Chat::ChatCompletionStoreMessage::content_part]?
 
+        # @param content
+        #   The contents of the message.
+        # @param refusal
+        #   The refusal message generated by the model.
+        # @param id
+        #   The identifier of the chat message.
+        # @param annotations
+        #   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
+        #   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
+        #   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
+        #   The tool calls generated by the model, such as function calls.
+        # @param content_parts
+        #   If a content parts array was provided, this is an array of `text` and
+        #   `image_url` parts. Otherwise, null.
+        # @param role
+        #   The role of the author of this message.
         def initialize: (
           content: String?,
           refusal: String?,