openai 0.86.0 → 0.88.0

data/lib/openai/models/realtime/realtime_audio_formats.rb

@@ -34,9 +34,11 @@ module OpenAI
           # @!method initialize(rate: nil, type: nil)
           #   The PCM audio format. Only a 24kHz sample rate is supported.
           #
-          #   @param rate [Integer, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM::Rate] The sample rate of the audio. Always `24000`.
+          #   @param rate [Integer, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM::Rate]
+          #     The sample rate of the audio. Always `24000`.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM::Type] The audio format. Always `audio/pcm`.
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM::Type]
+          #     The audio format. Always `audio/pcm`.
 
           # The sample rate of the audio. Always `24000`.
           #
@@ -73,7 +75,8 @@ module OpenAI
           # @!method initialize(type: nil)
           #   The G.711 μ-law format.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU::Type] The audio format. Always `audio/pcmu`.
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU::Type]
+          #     The audio format. Always `audio/pcmu`.
 
           # The audio format. Always `audio/pcmu`.
           #
@@ -98,7 +101,8 @@ module OpenAI
           # @!method initialize(type: nil)
           #   The G.711 A-law format.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA::Type] The audio format. Always `audio/pcma`.
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA::Type]
+          #     The audio format. Always `audio/pcma`.
 
           # The audio format. Always `audio/pcma`.
           #

data/lib/openai/models/realtime/realtime_audio_input_turn_detection.rb

@@ -101,26 +101,56 @@ module OpenAI
           optional :threshold, Float
 
           # @!method initialize(create_response: nil, idle_timeout_ms: nil, interrupt_response: nil, prefix_padding_ms: nil, silence_duration_ms: nil, threshold: nil, type: :server_vad)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::ServerVad} for more
-          #   details.
-          #
           #   Server-side voice activity detection (VAD) which flips on when user speech is
           #   detected and off after a period of silence.
           #
-          #   @param create_response [Boolean] Whether or not to automatically generate a response when a VAD stop event occurs
-          #
-          #   @param idle_timeout_ms [Integer, nil] Optional timeout after which a model response will be triggered automatically. T
-          #
-          #   @param interrupt_response [Boolean] Whether or not to automatically interrupt (cancel) any ongoing response with out
-          #
-          #   @param prefix_padding_ms [Integer] Used only for `server_vad` mode. Amount of audio to include before the VAD detec
-          #
-          #   @param silence_duration_ms [Integer] Used only for `server_vad` mode. Duration of silence to detect speech stop (in m
-          #
-          #   @param threshold [Float] Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this
-          #
-          #   @param type [Symbol, :server_vad] Type of turn detection, `server_vad` to turn on simple Server VAD.
+          #   @param create_response [Boolean]
+          #     Whether or not to automatically generate a response when a VAD stop event
+          #     occurs. If `interrupt_response` is set to `false` this may fail to create a
+          #     response if the model is already responding.
+          #
+          #     If both `create_response` and `interrupt_response` are set to `false`, the model
+          #     will never respond automatically but VAD events will still be emitted.
+          #
+          #   @param idle_timeout_ms [Integer, nil]
+          #     Optional timeout after which a model response will be triggered automatically.
+          #     This is useful for situations in which a long pause from the user is unexpected,
+          #     such as a phone call. The model will effectively prompt the user to continue the
+          #     conversation based on the current context.
+          #
+          #     The timeout value will be applied after the last model response's audio has
+          #     finished playing, i.e. it's set to the `response.done` time plus audio playback
+          #     duration.
+          #
+          #     An `input_audio_buffer.timeout_triggered` event (plus events associated with the
+          #     Response) will be emitted when the timeout is reached. Idle timeout is currently
+          #     only supported for `server_vad` mode.
+          #
+          #   @param interrupt_response [Boolean]
+          #     Whether or not to automatically interrupt (cancel) any ongoing response with
+          #     output to the default conversation (i.e. `conversation` of `auto`) when a VAD
+          #     start event occurs. If `true` then the response will be cancelled, otherwise it
+          #     will continue until complete.
+          #
+          #     If both `create_response` and `interrupt_response` are set to `false`, the model
+          #     will never respond automatically but VAD events will still be emitted.
+          #
+          #   @param prefix_padding_ms [Integer]
+          #     Used only for `server_vad` mode. Amount of audio to include before the VAD
+          #     detected speech (in milliseconds). Defaults to 300ms.
+          #
+          #   @param silence_duration_ms [Integer]
+          #     Used only for `server_vad` mode. Duration of silence to detect speech stop (in
+          #     milliseconds). Defaults to 500ms. With shorter values the model will respond
+          #     more quickly, but may jump in on short pauses from the user.
+          #
+          #   @param threshold [Float]
+          #     Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this
+          #     defaults to 0.5. A higher threshold will require louder audio to activate the
+          #     model, and thus might perform better in noisy environments.
+          #
+          #   @param type [Symbol, :server_vad]
+          #     Type of turn detection, `server_vad` to turn on simple Server VAD.
         end
 
         class SemanticVad < OpenAI::Internal::Type::BaseModel
@@ -158,20 +188,26 @@ module OpenAI
           optional :interrupt_response, OpenAI::Internal::Type::Boolean
 
           # @!method initialize(create_response: nil, eagerness: nil, interrupt_response: nil, type: :semantic_vad)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::SemanticVad} for
-          #   more details.
-          #
           #   Server-side semantic turn detection which uses a model to determine when the
           #   user has finished speaking.
           #
-          #   @param create_response [Boolean] Whether or not to automatically generate a response when a VAD stop event occurs
+          #   @param create_response [Boolean]
+          #     Whether or not to automatically generate a response when a VAD stop event
+          #     occurs.
           #
-          #   @param eagerness [Symbol, OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::SemanticVad::Eagerness] Used only for `semantic_vad` mode. The eagerness of the model to respond. `low`
+          #   @param eagerness [Symbol, OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::SemanticVad::Eagerness]
+          #     Used only for `semantic_vad` mode. The eagerness of the model to respond. `low`
+          #     will wait longer for the user to continue speaking, `high` will respond more
+          #     quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`,
+          #     and `high` have max timeouts of 8s, 4s, and 2s respectively.
           #
-          #   @param interrupt_response [Boolean] Whether or not to automatically interrupt any ongoing response with output to th
+          #   @param interrupt_response [Boolean]
+          #     Whether or not to automatically interrupt any ongoing response with output to
+          #     the default conversation (i.e. `conversation` of `auto`) when a VAD start event
+          #     occurs.
           #
-          #   @param type [Symbol, :semantic_vad] Type of turn detection, `semantic_vad` to turn on Semantic VAD.
+          #   @param type [Symbol, :semantic_vad]
+          #     Type of turn detection, `semantic_vad` to turn on Semantic VAD.
 
           # Used only for `semantic_vad` mode. The eagerness of the model to respond. `low`
           # will wait longer for the user to continue speaking, `high` will respond more

data/lib/openai/models/realtime/realtime_client_event.rb

@@ -66,7 +66,7 @@ module OpenAI
         # stop generating audio and emit a `output_audio_buffer.cleared` event. This
         # event should be preceded by a `response.cancel` client event to stop the
         # generation of the current response.
-        # [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+        # [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
         variant :"output_audio_buffer.clear", -> { OpenAI::Realtime::OutputAudioBufferClearEvent }
 
         # Send this event to commit the user input audio buffer, which will create a  new user message item in the conversation. This event will produce an error  if the input audio buffer is empty. When in Server VAD mode, the client does  not need to send this event, the server will commit the audio buffer  automatically.

data/lib/openai/models/realtime/realtime_conversation_item_assistant_message.rb

@@ -46,24 +46,27 @@ module OpenAI
         optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status }
 
         # @!method initialize(content:, id: nil, object: nil, status: nil, role: :assistant, type: :message)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage} for more
-        #   details.
-        #
         #   An assistant message item in a Realtime conversation.
         #
-        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content>] The content of the message.
+        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content>]
+        #     The content of the message.
         #
-        #   @param id [String] The unique ID of the item. This may be provided by the client or generated by th
+        #   @param id [String]
+        #     The unique ID of the item. This may be provided by the client or generated by
+        #     the server.
         #
-        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Object] Identifier for the API object being returned - always `realtime.item`. Optional
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Object]
+        #     Identifier for the API object being returned - always `realtime.item`. Optional
+        #     when creating a new item.
         #
-        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Status] The status of the item. Has no effect on the conversation.
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Status]
+        #     The status of the item. Has no effect on the conversation.
         #
-        #   @param role [Symbol, :assistant] The role of the message sender. Always `assistant`.
+        #   @param role [Symbol, :assistant]
+        #     The role of the message sender. Always `assistant`.
         #
-        #   @param type [Symbol, :message] The type of the item. Always `message`.
-
+        #   @param type [Symbol, :message]
+        #     The type of the item. Always `message`.
         class Content < OpenAI::Internal::Type::BaseModel
           # @!attribute audio
           #   Base64-encoded audio bytes, these will be parsed as the format specified in the
@@ -94,17 +97,21 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type }
 
           # @!method initialize(audio: nil, text: nil, transcript: nil, type: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content}
-          #   for more details.
-          #
-          #   @param audio [String] Base64-encoded audio bytes, these will be parsed as the format specified in the
+          #   @param audio [String]
+          #     Base64-encoded audio bytes, these will be parsed as the format specified in the
+          #     session output audio type configuration. This defaults to PCM 16-bit 24kHz mono
+          #     if not specified.
           #
-          #   @param text [String] The text content.
+          #   @param text [String]
+          #     The text content.
           #
-          #   @param transcript [String] The transcript of the audio content, this will always be present if the output t
+          #   @param transcript [String]
+          #     The transcript of the audio content, this will always be present if the output
+          #     type is `audio`.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::Type] The content type, `output_text` or `output_audio` depending on the session `outp
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::Type]
+          #     The content type, `output_text` or `output_audio` depending on the session
+          #     `output_modalities` configuration.
 
           # The content type, `output_text` or `output_audio` depending on the session
           # `output_modalities` configuration.

data/lib/openai/models/realtime/realtime_conversation_item_function_call.rb

@@ -51,25 +51,32 @@ module OpenAI
         optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status }
 
         # @!method initialize(arguments:, name:, id: nil, call_id: nil, object: nil, status: nil, type: :function_call)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall} for more
-        #   details.
-        #
         #   A function call item in a Realtime conversation.
         #
-        #   @param arguments [String] The arguments of the function call. This is a JSON-encoded string representing t
+        #   @param arguments [String]
+        #     The arguments of the function call. This is a JSON-encoded string representing
+        #     the arguments passed to the function, for example
+        #     `{"arg1": "value1", "arg2": 42}`.
         #
-        #   @param name [String] The name of the function being called.
+        #   @param name [String]
+        #     The name of the function being called.
         #
-        #   @param id [String] The unique ID of the item. This may be provided by the client or generated by th
+        #   @param id [String]
+        #     The unique ID of the item. This may be provided by the client or generated by
+        #     the server.
         #
-        #   @param call_id [String] The ID of the function call.
+        #   @param call_id [String]
+        #     The ID of the function call.
         #
-        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Object] Identifier for the API object being returned - always `realtime.item`. Optional
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Object]
+        #     Identifier for the API object being returned - always `realtime.item`. Optional
+        #     when creating a new item.
         #
-        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Status] The status of the item. Has no effect on the conversation.
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Status]
+        #     The status of the item. Has no effect on the conversation.
         #
-        #   @param type [Symbol, :function_call] The type of the item. Always `function_call`.
+        #   @param type [Symbol, :function_call]
+        #     The type of the item. Always `function_call`.
 
         # Identifier for the API object being returned - always `realtime.item`. Optional
         # when creating a new item.

data/lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb

@@ -44,23 +44,28 @@ module OpenAI
         optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput::Status }
 
         # @!method initialize(call_id:, output:, id: nil, object: nil, status: nil, type: :function_call_output)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput} for more
-        #   details.
-        #
         #   A function call output item in a Realtime conversation.
         #
-        #   @param call_id [String] The ID of the function call this output is for.
+        #   @param call_id [String]
+        #     The ID of the function call this output is for.
         #
-        #   @param output [String] The output of the function call, this is free text and can contain any informati
+        #   @param output [String]
+        #     The output of the function call, this is free text and can contain any
+        #     information or simply be empty.
         #
-        #   @param id [String] The unique ID of the item. This may be provided by the client or generated by th
+        #   @param id [String]
+        #     The unique ID of the item. This may be provided by the client or generated by
+        #     the server.
         #
-        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Object] Identifier for the API object being returned - always `realtime.item`. Optional
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Object]
+        #     Identifier for the API object being returned - always `realtime.item`. Optional
+        #     when creating a new item.
         #
-        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Status] The status of the item. Has no effect on the conversation.
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Status]
+        #     The status of the item. Has no effect on the conversation.
         #
-        #   @param type [Symbol, :function_call_output] The type of the item. Always `function_call_output`.
+        #   @param type [Symbol, :function_call_output]
+        #     The type of the item. Always `function_call_output`.
 
         # Identifier for the API object being returned - always `realtime.item`. Optional
         # when creating a new item.

data/lib/openai/models/realtime/realtime_conversation_item_system_message.rb

@@ -46,10 +46,6 @@ module OpenAI
         optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemSystemMessage::Status }
 
         # @!method initialize(content:, id: nil, object: nil, status: nil, role: :system, type: :message)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage} for more
-        #   details.
-        #
         #   A system message in a Realtime conversation can be used to provide additional
         #   context or instructions to the model. This is similar but distinct from the
         #   instruction prompt provided at the start of a conversation, as system messages
@@ -57,18 +53,25 @@ module OpenAI
         #   conversation's behavior, use instructions, but for smaller updates (e.g. "the
         #   user is now asking about a different topic"), use system messages.
         #
-        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content>] The content of the message.
+        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content>]
+        #     The content of the message.
         #
-        #   @param id [String] The unique ID of the item. This may be provided by the client or generated by th
+        #   @param id [String]
+        #     The unique ID of the item. This may be provided by the client or generated by
+        #     the server.
         #
-        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Object] Identifier for the API object being returned - always `realtime.item`. Optional
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Object]
+        #     Identifier for the API object being returned - always `realtime.item`. Optional
+        #     when creating a new item.
         #
-        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Status] The status of the item. Has no effect on the conversation.
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Status]
+        #     The status of the item. Has no effect on the conversation.
         #
-        #   @param role [Symbol, :system] The role of the message sender. Always `system`.
+        #   @param role [Symbol, :system]
+        #     The role of the message sender. Always `system`.
         #
-        #   @param type [Symbol, :message] The type of the item. Always `message`.
-
+        #   @param type [Symbol, :message]
+        #     The type of the item. Always `message`.
         class Content < OpenAI::Internal::Type::BaseModel
           # @!attribute text
           #   The text content.
@@ -83,9 +86,11 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemSystemMessage::Content::Type }
 
           # @!method initialize(text: nil, type: nil)
-          #   @param text [String] The text content.
+          #   @param text [String]
+          #     The text content.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content::Type] The content type. Always `input_text` for system messages.
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content::Type]
+          #     The content type. Always `input_text` for system messages.
 
           # The content type. Always `input_text` for system messages.
           #

data/lib/openai/models/realtime/realtime_conversation_item_user_message.rb

@@ -46,24 +46,27 @@ module OpenAI
         optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Status }
 
         # @!method initialize(content:, id: nil, object: nil, status: nil, role: :user, type: :message)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeConversationItemUserMessage} for more
-        #   details.
-        #
         #   A user message item in a Realtime conversation.
         #
-        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content>] The content of the message.
+        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content>]
+        #     The content of the message.
         #
-        #   @param id [String] The unique ID of the item. This may be provided by the client or generated by th
+        #   @param id [String]
+        #     The unique ID of the item. This may be provided by the client or generated by
+        #     the server.
         #
-        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Object] Identifier for the API object being returned - always `realtime.item`. Optional
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Object]
+        #     Identifier for the API object being returned - always `realtime.item`. Optional
+        #     when creating a new item.
         #
-        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Status] The status of the item. Has no effect on the conversation.
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Status]
+        #     The status of the item. Has no effect on the conversation.
         #
-        #   @param role [Symbol, :user] The role of the message sender. Always `user`.
+        #   @param role [Symbol, :user]
+        #     The role of the message sender. Always `user`.
         #
-        #   @param type [Symbol, :message] The type of the item. Always `message`.
-
+        #   @param type [Symbol, :message]
+        #     The type of the item. Always `message`.
         class Content < OpenAI::Internal::Type::BaseModel
           # @!attribute audio
           #   Base64-encoded audio bytes (for `input_audio`), these will be parsed as the
@@ -108,21 +111,29 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type }
 
           # @!method initialize(audio: nil, detail: nil, image_url: nil, text: nil, transcript: nil, type: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content} for
-          #   more details.
-          #
-          #   @param audio [String] Base64-encoded audio bytes (for `input_audio`), these will be parsed as the form
+          #   @param audio [String]
+          #     Base64-encoded audio bytes (for `input_audio`), these will be parsed as the
+          #     format specified in the session input audio type configuration. This defaults to
+          #     PCM 16-bit 24kHz mono if not specified.
           #
-          #   @param detail [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Detail] The detail level of the image (for `input_image`). `auto` will default to `high`
+          #   @param detail [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Detail]
+          #     The detail level of the image (for `input_image`). `auto` will default to
+          #     `high`.
           #
-          #   @param image_url [String] Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:
+          #   @param image_url [String]
+          #     Base64-encoded image bytes (for `input_image`) as a data URI. For example
+          #     `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG
+          #     and JPEG.
           #
-          #   @param text [String] The text content (for `input_text`).
+          #   @param text [String]
+          #     The text content (for `input_text`).
           #
-          #   @param transcript [String] Transcript of the audio (for `input_audio`). This is not sent to the model, but
+          #   @param transcript [String]
+          #     Transcript of the audio (for `input_audio`). This is not sent to the model, but
+          #     will be attached to the message item for reference.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Type] The content type (`input_text`, `input_audio`, or `input_image`).
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Type]
+          #     The content type (`input_text`, `input_audio`, or `input_image`).
 
           # The detail level of the image (for `input_image`). `auto` will default to
           # `high`.

data/lib/openai/models/realtime/realtime_error.rb

@@ -35,20 +35,22 @@ module OpenAI
         optional :param, String, nil?: true
 
         # @!method initialize(message:, type:, code: nil, event_id: nil, param: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeError} for more details.
-        #
         #   Details of the error.
         #
-        #   @param message [String] A human-readable error message.
+        #   @param message [String]
+        #     A human-readable error message.
         #
-        #   @param type [String] The type of error (e.g., "invalid_request_error", "server_error").
+        #   @param type [String]
+        #     The type of error (e.g., "invalid_request_error", "server_error").
         #
-        #   @param code [String, nil] Error code, if any.
+        #   @param code [String, nil]
+        #     Error code, if any.
         #
-        #   @param event_id [String, nil] The event_id of the client event that caused the error, if applicable.
+        #   @param event_id [String, nil]
+        #     The event_id of the client event that caused the error, if applicable.
         #
-        #   @param param [String, nil] Parameter related to the error, if any.
+        #   @param param [String, nil]
+        #     Parameter related to the error, if any.
       end
     end
   end

data/lib/openai/models/realtime/realtime_error_event.rb

@@ -27,11 +27,14 @@ module OpenAI
         #   problem. Most errors are recoverable and the session will stay open, we
         #   recommend to implementors to monitor and log error messages by default.
         #
-        #   @param error [OpenAI::Models::Realtime::RealtimeError] Details of the error.
+        #   @param error [OpenAI::Models::Realtime::RealtimeError]
+        #     Details of the error.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param type [Symbol, :error] The event type, must be `error`.
+        #   @param type [Symbol, :error]
+        #     The event type, must be `error`.
       end
     end
   end

data/lib/openai/models/realtime/realtime_function_tool.rb

@@ -30,16 +30,18 @@ module OpenAI
         optional :type, enum: -> { OpenAI::Realtime::RealtimeFunctionTool::Type }
 
         # @!method initialize(description: nil, name: nil, parameters: nil, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeFunctionTool} for more details.
+        #   @param description [String]
+        #     The description of the function, including guidance on when and how to call it,
+        #     and guidance about what to tell the user when calling (if anything).
         #
-        #   @param description [String] The description of the function, including guidance on when and how
+        #   @param name [String]
+        #     The name of the function.
         #
-        #   @param name [String] The name of the function.
+        #   @param parameters [Object]
+        #     Parameters of the function in JSON Schema.
         #
-        #   @param parameters [Object] Parameters of the function in JSON Schema.
-        #
-        #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeFunctionTool::Type] The type of the tool, i.e. `function`.
+        #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeFunctionTool::Type]
+        #     The type of the tool, i.e. `function`.
 
         # The type of the tool, i.e. `function`.
         #

data/lib/openai/models/realtime/realtime_mcp_approval_request.rb

@@ -37,15 +37,20 @@ module OpenAI
         # @!method initialize(id:, arguments:, name:, server_label:, type: :mcp_approval_request)
         #   A Realtime item requesting human approval of a tool invocation.
         #
-        #   @param id [String] The unique ID of the approval request.
+        #   @param id [String]
+        #     The unique ID of the approval request.
         #
-        #   @param arguments [String] A JSON string of arguments for the tool.
+        #   @param arguments [String]
+        #     A JSON string of arguments for the tool.
         #
-        #   @param name [String] The name of the tool to run.
+        #   @param name [String]
+        #     The name of the tool to run.
         #
-        #   @param server_label [String] The label of the MCP server making the request.
+        #   @param server_label [String]
+        #     The label of the MCP server making the request.
         #
-        #   @param type [Symbol, :mcp_approval_request] The type of the item. Always `mcp_approval_request`.
+        #   @param type [Symbol, :mcp_approval_request]
+        #     The type of the item. Always `mcp_approval_request`.
       end
     end
   end

data/lib/openai/models/realtime/realtime_mcp_approval_response.rb

@@ -37,15 +37,20 @@ module OpenAI
         # @!method initialize(id:, approval_request_id:, approve:, reason: nil, type: :mcp_approval_response)
         #   A Realtime item responding to an MCP approval request.
         #
-        #   @param id [String] The unique ID of the approval response.
+        #   @param id [String]
+        #     The unique ID of the approval response.
         #
-        #   @param approval_request_id [String] The ID of the approval request being answered.
+        #   @param approval_request_id [String]
+        #     The ID of the approval request being answered.
         #
-        #   @param approve [Boolean] Whether the request was approved.
+        #   @param approve [Boolean]
+        #     Whether the request was approved.
         #
-        #   @param reason [String, nil] Optional reason for the decision.
+        #   @param reason [String, nil]
+        #     Optional reason for the decision.
         #
-        #   @param type [Symbol, :mcp_approval_response] The type of the item. Always `mcp_approval_response`.
+        #   @param type [Symbol, :mcp_approval_response]
+        #     The type of the item. Always `mcp_approval_response`.
       end
     end
   end

data/lib/openai/models/realtime/realtime_mcp_list_tools.rb

@@ -31,14 +31,17 @@ module OpenAI
         # @!method initialize(server_label:, tools:, id: nil, type: :mcp_list_tools)
         #   A Realtime item listing tools available on an MCP server.
         #
-        #   @param server_label [String] The label of the MCP server.
+        #   @param server_label [String]
+        #     The label of the MCP server.
         #
-        #   @param tools [Array<OpenAI::Models::Realtime::RealtimeMcpListTools::Tool>] The tools available on the server.
+        #   @param tools [Array<OpenAI::Models::Realtime::RealtimeMcpListTools::Tool>]
+        #     The tools available on the server.
         #
-        #   @param id [String] The unique ID of the list.
+        #   @param id [String]
+        #     The unique ID of the list.
         #
-        #   @param type [Symbol, :mcp_list_tools] The type of the item. Always `mcp_list_tools`.
-
+        #   @param type [Symbol, :mcp_list_tools]
+        #     The type of the item. Always `mcp_list_tools`.
         class Tool < OpenAI::Internal::Type::BaseModel
           # @!attribute input_schema
           #   The JSON schema describing the tool's input.
@@ -65,18 +68,19 @@ module OpenAI
           optional :description, String, nil?: true
 
           # @!method initialize(input_schema:, name:, annotations: nil, description: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeMcpListTools::Tool} for more details.
-          #
           #   A tool available on an MCP server.
           #
-          #   @param input_schema [Object] The JSON schema describing the tool's input.
+          #   @param input_schema [Object]
+          #     The JSON schema describing the tool's input.
           #
-          #   @param name [String] The name of the tool.
+          #   @param name [String]
+          #     The name of the tool.
           #
-          #   @param annotations [Object, nil] Additional annotations about the tool.
+          #   @param annotations [Object, nil]
+          #     Additional annotations about the tool.
           #
-          #   @param description [String, nil] The description of the tool.
+          #   @param description [String, nil]
+          #     The description of the tool.
         end
       end
     end