openai 0.86.0 → 0.88.0

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

@@ -83,32 +83,52 @@ module OpenAI
         optional :type, enum: -> { OpenAI::Realtime::ConversationItemWithReference::Type }
 
         # @!method initialize(id: nil, arguments: nil, call_id: nil, content: nil, name: nil, object: nil, output: nil, role: nil, status: nil, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemWithReference} for more details.
-        #
         #   The item to add to the conversation.
         #
-        #   @param id [String] For an item of type (`message` | `function_call` | `function_call_output`)
+        #   @param id [String]
+        #     For an item of type (`message` | `function_call` | `function_call_output`) this
+        #     field allows the client to assign the unique ID of the item. It is not required
+        #     because the server will generate one if not provided.
         #
-        #   @param arguments [String] The arguments of the function call (for `function_call` items).
+        #     For an item of type `item_reference`, this field is required and is a reference
+        #     to any item that has previously existed in the conversation.
         #
-        #   @param call_id [String] The ID of the function call (for `function_call` and
+        #   @param arguments [String]
+        #     The arguments of the function call (for `function_call` items).
         #
-        #   @param content [Array<OpenAI::Models::Realtime::ConversationItemWithReference::Content>] The content of the message, applicable for `message` items.
+        #   @param call_id [String]
+        #     The ID of the function call (for `function_call` and `function_call_output`
+        #     items). If passed on a `function_call_output` item, the server will check that a
+        #     `function_call` item with the same ID exists in the conversation history.
         #
-        #   @param name [String] The name of the function being called (for `function_call` items).
+        #   @param content [Array<OpenAI::Models::Realtime::ConversationItemWithReference::Content>]
+        #     The content of the message, applicable for `message` items.
         #
-        #   @param object [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Object] Identifier for the API object being returned - always `realtime.item`.
+        #     - Message items of role `system` support only `input_text` content
+        #     - Message items of role `user` support `input_text` and `input_audio` content
+        #     - Message items of role `assistant` support `text` content.
         #
-        #   @param output [String] The output of the function call (for `function_call_output` items).
+        #   @param name [String]
+        #     The name of the function being called (for `function_call` items).
         #
-        #   @param role [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Role] The role of the message sender (`user`, `assistant`, `system`), only
+        #   @param object [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Object]
+        #     Identifier for the API object being returned - always `realtime.item`.
         #
-        #   @param status [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Status] The status of the item (`completed`, `incomplete`, `in_progress`). These have no
+        #   @param output [String]
+        #     The output of the function call (for `function_call_output` items).
         #
-        #   @param type [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Type] The type of the item (`message`, `function_call`, `function_call_output`,
-        #   `item\_
-
+        #   @param role [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Role]
+        #     The role of the message sender (`user`, `assistant`, `system`), only applicable
+        #     for `message` items.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Status]
+        #     The status of the item (`completed`, `incomplete`, `in_progress`). These have no
+        #     effect on the conversation, but are accepted for consistency with the
+        #     `conversation.item.created` event.
+        #
+        #   @param type [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Type]
+        #     The type of the item (`message`, `function_call`, `function_call_output`,
+        #     `item_reference`).
         class Content < OpenAI::Internal::Type::BaseModel
           # @!attribute id
           #   ID of a previous conversation item to reference (for `item_reference` content
@@ -143,19 +163,22 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Realtime::ConversationItemWithReference::Content::Type }
 
           # @!method initialize(id: nil, audio: nil, text: nil, transcript: nil, type: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::ConversationItemWithReference::Content} for more
-          #   details.
-          #
-          #   @param id [String] ID of a previous conversation item to reference (for `item_reference`
+          #   @param id [String]
+          #     ID of a previous conversation item to reference (for `item_reference` content
+          #     types in `response.create` events). These can reference both client and server
+          #     created items.
           #
-          #   @param audio [String] Base64-encoded audio bytes, used for `input_audio` content type.
+          #   @param audio [String]
+          #     Base64-encoded audio bytes, used for `input_audio` content type.
           #
-          #   @param text [String] The text content, used for `input_text` and `text` content types.
+          #   @param text [String]
+          #     The text content, used for `input_text` and `text` content types.
           #
-          #   @param transcript [String] The transcript of the audio, used for `input_audio` content type.
+          #   @param transcript [String]
+          #     The transcript of the audio, used for `input_audio` content type.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Content::Type] The content type (`input_text`, `input_audio`, `item_reference`, `text`).
+          #   @param type [Symbol, OpenAI::Models::Realtime::ConversationItemWithReference::Content::Type]
+          #     The content type (`input_text`, `input_audio`, `item_reference`, `text`).
 
           # The content type (`input_text`, `input_audio`, `item_reference`, `text`).
           #

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

@@ -24,9 +24,6 @@ module OpenAI
         optional :event_id, String
 
         # @!method initialize(audio:, event_id: nil, type: :"input_audio_buffer.append")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferAppendEvent} for more details.
-        #
         #   Send this event to append audio bytes to the input audio buffer. The audio
         #   buffer is temporary storage you can write to and later commit. A "commit" will
         #   create a new user message item in the conversation history from the buffer
@@ -43,11 +40,15 @@ module OpenAI
         #   to be more responsive. Unlike most other client events, the server will not send
         #   a confirmation response to this event.
         #
-        #   @param audio [String] Base64-encoded audio bytes. This must be in the format specified by the
+        #   @param audio [String]
+        #     Base64-encoded audio bytes. This must be in the format specified by the
+        #     `input_audio_format` field in the session configuration.
         #
-        #   @param event_id [String] Optional client-generated ID used to identify this event.
+        #   @param event_id [String]
+        #     Optional client-generated ID used to identify this event.
         #
-        #   @param type [Symbol, :"input_audio_buffer.append"] The event type, must be `input_audio_buffer.append`.
+        #   @param type [Symbol, :"input_audio_buffer.append"]
+        #     The event type, must be `input_audio_buffer.append`.
       end
     end
   end

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

@@ -20,9 +20,11 @@ module OpenAI
         #   Send this event to clear the audio bytes in the buffer. The server will respond
         #   with an `input_audio_buffer.cleared` event.
         #
-        #   @param event_id [String] Optional client-generated ID used to identify this event.
+        #   @param event_id [String]
+        #     Optional client-generated ID used to identify this event.
         #
-        #   @param type [Symbol, :"input_audio_buffer.clear"] The event type, must be `input_audio_buffer.clear`.
+        #   @param type [Symbol, :"input_audio_buffer.clear"]
+        #     The event type, must be `input_audio_buffer.clear`.
       end
     end
   end

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

@@ -20,9 +20,11 @@ module OpenAI
         #   Returned when the input audio buffer is cleared by the client with a
         #   `input_audio_buffer.clear` event.
         #
-        #   @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, :"input_audio_buffer.cleared"] The event type, must be `input_audio_buffer.cleared`.
+        #   @param type [Symbol, :"input_audio_buffer.cleared"]
+        #     The event type, must be `input_audio_buffer.cleared`.
       end
     end
   end

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

@@ -26,9 +26,11 @@ module OpenAI
         #   enabled in session configuration), but it will not create a response from the
         #   model. The server will respond with an `input_audio_buffer.committed` event.
         #
-        #   @param event_id [String] Optional client-generated ID used to identify this event.
+        #   @param event_id [String]
+        #     Optional client-generated ID used to identify this event.
         #
-        #   @param type [Symbol, :"input_audio_buffer.commit"] The event type, must be `input_audio_buffer.commit`.
+        #   @param type [Symbol, :"input_audio_buffer.commit"]
+        #     The event type, must be `input_audio_buffer.commit`.
       end
     end
   end

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

@@ -30,21 +30,23 @@ module OpenAI
         optional :previous_item_id, String, nil?: true
 
         # @!method initialize(event_id:, item_id:, previous_item_id: nil, type: :"input_audio_buffer.committed")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferCommittedEvent} for more details.
-        #
         #   Returned when an input audio buffer is committed, either by the client or
         #   automatically in server VAD mode. The `item_id` property is the ID of the user
         #   message item that will be created, thus a `conversation.item.created` event will
         #   also be sent to the client.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the user message item that will be created.
+        #   @param item_id [String]
+        #     The ID of the user message item that will be created.
         #
-        #   @param previous_item_id [String, nil] The ID of the preceding item after which the new item will be inserted.
+        #   @param previous_item_id [String, nil]
+        #     The ID of the preceding item after which the new item will be inserted. Can be
+        #     `null` if the item has no predecessor.
         #
-        #   @param type [Symbol, :"input_audio_buffer.committed"] The event type, must be `input_audio_buffer.committed`.
+        #   @param type [Symbol, :"input_audio_buffer.committed"]
+        #     The event type, must be `input_audio_buffer.committed`.
       end
     end
   end

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

@@ -23,20 +23,19 @@ module OpenAI
         required :type, const: :"input_audio_buffer.dtmf_event_received"
 
         # @!method initialize(event:, received_at:, type: :"input_audio_buffer.dtmf_event_received")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferDtmfEventReceivedEvent} for more
-        #   details.
-        #
         #   **SIP Only:** Returned when an DTMF event is received. A DTMF event is a message
         #   that represents a telephone keypad press (0–9, \*, #, A–D). The `event` property
         #   is the keypad that the user press. The `received_at` is the UTC Unix Timestamp
         #   that the server received the event.
         #
-        #   @param event [String] The telephone keypad that was pressed by the user.
+        #   @param event [String]
+        #     The telephone keypad that was pressed by the user.
         #
-        #   @param received_at [Integer] UTC Unix Timestamp when DTMF Event was received by server.
+        #   @param received_at [Integer]
+        #     UTC Unix Timestamp when DTMF Event was received by server.
         #
-        #   @param type [Symbol, :"input_audio_buffer.dtmf_event_received"] The event type, must be `input_audio_buffer.dtmf_event_received`.
+        #   @param type [Symbol, :"input_audio_buffer.dtmf_event_received"]
+        #     The event type, must be `input_audio_buffer.dtmf_event_received`.
       end
     end
   end

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

@@ -32,9 +32,6 @@ module OpenAI
         required :type, const: :"input_audio_buffer.speech_started"
 
         # @!method initialize(audio_start_ms:, event_id:, item_id:, type: :"input_audio_buffer.speech_started")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferSpeechStartedEvent} for more details.
-        #
         #   Sent by the server when in `server_vad` mode to indicate that speech has been
         #   detected in the audio buffer. This can happen any time audio is added to the
         #   buffer (unless speech is already detected). The client may want to use this
@@ -46,13 +43,20 @@ module OpenAI
         #   `input_audio_buffer.speech_stopped` event (unless the client manually commits
         #   the audio buffer during VAD activation).
         #
-        #   @param audio_start_ms [Integer] Milliseconds from the start of all audio written to the buffer during the
+        #   @param audio_start_ms [Integer]
+        #     Milliseconds from the start of all audio written to the buffer during the
+        #     session when speech was first detected. This will correspond to the beginning of
+        #     audio sent to the model, and thus includes the `prefix_padding_ms` configured in
+        #     the Session.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the user message item that will be created when speech stops.
+        #   @param item_id [String]
+        #     The ID of the user message item that will be created when speech stops.
         #
-        #   @param type [Symbol, :"input_audio_buffer.speech_started"] The event type, must be `input_audio_buffer.speech_started`.
+        #   @param type [Symbol, :"input_audio_buffer.speech_started"]
+        #     The event type, must be `input_audio_buffer.speech_started`.
       end
     end
   end

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

@@ -31,20 +31,23 @@ module OpenAI
         required :type, const: :"input_audio_buffer.speech_stopped"
 
         # @!method initialize(audio_end_ms:, event_id:, item_id:, type: :"input_audio_buffer.speech_stopped")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferSpeechStoppedEvent} for more details.
-        #
         #   Returned in `server_vad` mode when the server detects the end of speech in the
         #   audio buffer. The server will also send an `conversation.item.created` event
         #   with the user message item that is created from the audio buffer.
         #
-        #   @param audio_end_ms [Integer] Milliseconds since the session started when speech stopped. This will
+        #   @param audio_end_ms [Integer]
+        #     Milliseconds since the session started when speech stopped. This will correspond
+        #     to the end of audio sent to the model, and thus includes the
+        #     `min_silence_duration_ms` configured in the Session.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the user message item that will be created.
+        #   @param item_id [String]
+        #     The ID of the user message item that will be created.
         #
-        #   @param type [Symbol, :"input_audio_buffer.speech_stopped"] The event type, must be `input_audio_buffer.speech_stopped`.
+        #   @param type [Symbol, :"input_audio_buffer.speech_stopped"]
+        #     The event type, must be `input_audio_buffer.speech_stopped`.
       end
     end
   end

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

@@ -37,9 +37,6 @@ module OpenAI
         required :type, const: :"input_audio_buffer.timeout_triggered"
 
         # @!method initialize(audio_end_ms:, audio_start_ms:, event_id:, item_id:, type: :"input_audio_buffer.timeout_triggered")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::InputAudioBufferTimeoutTriggered} for more details.
-        #
         #   Returned when the Server VAD timeout is triggered for the input audio buffer.
         #   This is configured with `idle_timeout_ms` in the `turn_detection` settings of
         #   the session, and it indicates that there hasn't been any speech detected for the
@@ -57,15 +54,22 @@ module OpenAI
         #   by the model, so the model may respond with something relevant to the
         #   conversation or a prompt to continue speaking.
         #
-        #   @param audio_end_ms [Integer] Millisecond offset of audio written to the input audio buffer at the time the ti
+        #   @param audio_end_ms [Integer]
+        #     Millisecond offset of audio written to the input audio buffer at the time the
+        #     timeout was triggered.
         #
-        #   @param audio_start_ms [Integer] Millisecond offset of audio written to the input audio buffer that was after the
+        #   @param audio_start_ms [Integer]
+        #     Millisecond offset of audio written to the input audio buffer that was after the
+        #     playback time of the last model response.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the item associated with this segment.
+        #   @param item_id [String]
+        #     The ID of the item associated with this segment.
         #
-        #   @param type [Symbol, :"input_audio_buffer.timeout_triggered"] The event type, must be `input_audio_buffer.timeout_triggered`.
+        #   @param type [Symbol, :"input_audio_buffer.timeout_triggered"]
+        #     The event type, must be `input_audio_buffer.timeout_triggered`.
       end
     end
   end

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

@@ -23,16 +23,16 @@ module OpenAI
         required :logprob, Float
 
         # @!method initialize(token:, bytes:, logprob:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::LogProbProperties} for more details.
-        #
         #   A log probability object.
         #
-        #   @param token [String] The token that was used to generate the log probability.
+        #   @param token [String]
+        #     The token that was used to generate the log probability.
         #
-        #   @param bytes [Array<Integer>] The bytes that were used to generate the log probability.
+        #   @param bytes [Array<Integer>]
+        #     The bytes that were used to generate the log probability.
         #
-        #   @param logprob [Float] The log probability of the token.
+        #   @param logprob [Float]
+        #     The log probability of the token.
       end
     end
   end

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

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(event_id:, item_id:, type: :"mcp_list_tools.completed")
         #   Returned when listing MCP tools has completed for an item.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the MCP list tools item.
+        #   @param item_id [String]
+        #     The ID of the MCP list tools item.
         #
-        #   @param type [Symbol, :"mcp_list_tools.completed"] The event type, must be `mcp_list_tools.completed`.
+        #   @param type [Symbol, :"mcp_list_tools.completed"]
+        #     The event type, must be `mcp_list_tools.completed`.
       end
     end
   end

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

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(event_id:, item_id:, type: :"mcp_list_tools.failed")
         #   Returned when listing MCP tools has failed for an item.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the MCP list tools item.
+        #   @param item_id [String]
+        #     The ID of the MCP list tools item.
         #
-        #   @param type [Symbol, :"mcp_list_tools.failed"] The event type, must be `mcp_list_tools.failed`.
+        #   @param type [Symbol, :"mcp_list_tools.failed"]
+        #     The event type, must be `mcp_list_tools.failed`.
       end
     end
   end

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

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(event_id:, item_id:, type: :"mcp_list_tools.in_progress")
         #   Returned when listing MCP tools is in progress for an item.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item_id [String] The ID of the MCP list tools item.
+        #   @param item_id [String]
+        #     The ID of the MCP list tools item.
         #
-        #   @param type [Symbol, :"mcp_list_tools.in_progress"] The event type, must be `mcp_list_tools.in_progress`.
+        #   @param type [Symbol, :"mcp_list_tools.in_progress"]
+        #     The event type, must be `mcp_list_tools.in_progress`.
       end
     end
   end

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

@@ -21,11 +21,13 @@ module OpenAI
         #   trigger the server to 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).
         #
-        #   @param event_id [String] The unique ID of the client event used for error handling.
+        #   @param event_id [String]
+        #     The unique ID of the client event used for error handling.
         #
-        #   @param type [Symbol, :"output_audio_buffer.clear"] The event type, must be `output_audio_buffer.clear`.
+        #   @param type [Symbol, :"output_audio_buffer.clear"]
+        #     The event type, must be `output_audio_buffer.clear`.
       end
     end
   end

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

@@ -31,12 +31,14 @@ module OpenAI
         #   rate limits shown here reflect that reservation, which is then adjusted
         #   accordingly once the Response is completed.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param rate_limits [Array<OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit>] List of rate limit information.
+        #   @param rate_limits [Array<OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit>]
+        #     List of rate limit information.
         #
-        #   @param type [Symbol, :"rate_limits.updated"] The event type, must be `rate_limits.updated`.
-
+        #   @param type [Symbol, :"rate_limits.updated"]
+        #     The event type, must be `rate_limits.updated`.
         class RateLimit < OpenAI::Internal::Type::BaseModel
           # @!attribute limit
           #   The maximum allowed value for the rate limit.
@@ -63,16 +65,17 @@ module OpenAI
           optional :reset_seconds, Float
 
           # @!method initialize(limit: nil, name: nil, remaining: nil, reset_seconds: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit} for more details.
-          #
-          #   @param limit [Integer] The maximum allowed value for the rate limit.
+          #   @param limit [Integer]
+          #     The maximum allowed value for the rate limit.
           #
-          #   @param name [Symbol, OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit::Name] The name of the rate limit (`requests`, `tokens`).
+          #   @param name [Symbol, OpenAI::Models::Realtime::RateLimitsUpdatedEvent::RateLimit::Name]
+          #     The name of the rate limit (`requests`, `tokens`).
           #
-          #   @param remaining [Integer] The remaining value before the limit is reached.
+          #   @param remaining [Integer]
+          #     The remaining value before the limit is reached.
           #
-          #   @param reset_seconds [Float] Seconds until the rate limit resets.
+          #   @param reset_seconds [Float]
+          #     Seconds until the rate limit resets.
 
           # The name of the rate limit (`requests`, `tokens`).
           #

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

@@ -25,7 +25,7 @@ module OpenAI
         #   `null` to turn off once on. Input audio transcription is not native to the
         #   model, since the model consumes audio directly. Transcription runs
         #   asynchronously through
-        #   [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription)
+        #   [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         #   and should be treated as guidance of input audio content rather than precisely
         #   what the model heard. The client can optionally set the language and prompt for
         #   transcription, these offer additional guidance to the transcription service.
@@ -55,16 +55,43 @@ module OpenAI
         optional :turn_detection, union: -> { OpenAI::Realtime::RealtimeAudioInputTurnDetection }, nil?: true
 
         # @!method initialize(format_: nil, noise_reduction: nil, transcription: nil, turn_detection: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeAudioConfigInput} for more details.
+        #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA]
+        #     The format of the input audio.
         #
-        #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA] The format of the input audio.
+        #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeAudioConfigInput::NoiseReduction]
+        #     Configuration for input audio noise reduction. This can be set to `null` to turn
+        #     off. Noise reduction filters audio added to the input audio buffer before it is
+        #     sent to VAD and the model. Filtering the audio can improve VAD and turn
+        #     detection accuracy (reducing false positives) and model performance by improving
+        #     perception of the input audio.
         #
-        #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeAudioConfigInput::NoiseReduction] Configuration for input audio noise reduction. This can be set to `null` to turn
+        #   @param transcription [OpenAI::Models::Realtime::AudioTranscription]
+        #     Configuration for input audio transcription, defaults to off and can be set to
+        #     `null` to turn off once on. Input audio transcription is not native to the
+        #     model, since the model consumes audio directly. Transcription runs
+        #     asynchronously through
+        #     [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
+        #     and should be treated as guidance of input audio content rather than precisely
+        #     what the model heard. The client can optionally set the language and prompt for
+        #     transcription, these offer additional guidance to the transcription service.
         #
-        #   @param transcription [OpenAI::Models::Realtime::AudioTranscription] Configuration for input audio transcription, defaults to off and can be set to `
+        #   @param turn_detection [OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::ServerVad, OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::SemanticVad, nil]
+        #     Configuration for turn detection, ether Server VAD or Semantic VAD. This can be
+        #     set to `null` to turn off, in which case the client must manually trigger model
+        #     response.
         #
-        #   @param turn_detection [OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::ServerVad, OpenAI::Models::Realtime::RealtimeAudioInputTurnDetection::SemanticVad, nil] Configuration for turn detection, ether Server VAD or Semantic VAD. This can be
+        #     Server VAD means that the model will detect the start and end of speech based on
+        #     audio volume and respond at the end of user speech.
+        #
+        #     Semantic VAD is more advanced and uses a turn detection model (in conjunction
+        #     with VAD) to semantically estimate whether the user has finished speaking, then
+        #     dynamically sets a timeout based on this probability. For example, if user audio
+        #     trails off with "uhhm", the model will score a low probability of turn end and
+        #     wait longer for the user to continue speaking. This can be useful for more
+        #     natural conversations, but may have a higher latency.
+        #
+        #     For `gpt-realtime-whisper` transcription sessions, turn detection must be set to
+        #     `null`; VAD is not supported.
 
         # @see OpenAI::Models::Realtime::RealtimeAudioConfigInput#noise_reduction
         class NoiseReduction < OpenAI::Internal::Type::BaseModel
@@ -77,17 +104,16 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Realtime::NoiseReductionType }
 
           # @!method initialize(type: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeAudioConfigInput::NoiseReduction} for more
-          #   details.
-          #
           #   Configuration for input audio noise reduction. This can be set to `null` to turn
           #   off. Noise reduction filters audio added to the input audio buffer before it is
           #   sent to VAD and the model. Filtering the audio can improve VAD and turn
           #   detection accuracy (reducing false positives) and model performance by improving
           #   perception of the input audio.
           #
-          #   @param type [Symbol, OpenAI::Models::Realtime::NoiseReductionType] Type of noise reduction. `near_field` is for close-talking microphones such as h
+          #   @param type [Symbol, OpenAI::Models::Realtime::NoiseReductionType]
+          #     Type of noise reduction. `near_field` is for close-talking microphones such as
+          #     headphones, `far_field` is for far-field microphones such as laptop or
+          #     conference room microphones.
         end
       end
     end

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

@@ -34,14 +34,25 @@ module OpenAI
         optional :voice, union: -> { OpenAI::Realtime::RealtimeAudioConfigOutput::Voice }
 
         # @!method initialize(format_: nil, speed: nil, voice: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeAudioConfigOutput} for more details.
+        #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA]
+        #     The format of the output audio.
         #
-        #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA] The format of the output audio.
+        #   @param speed [Float]
+        #     The speed of the model's spoken response as a multiple of the original speed.
+        #     1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed.
+        #     This value can only be changed in between model turns, not while a response is
+        #     in progress.
         #
-        #   @param speed [Float] The speed of the model's spoken response as a multiple of the original speed.
+        #     This parameter is a post-processing adjustment to the audio after it is
+        #     generated, it's also possible to prompt the model to speak faster or slower.
         #
-        #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice::ID, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice] The voice the model uses to respond. Supported built-in voices are
+        #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice::ID, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice]
+        #     The voice the model uses to respond. Supported built-in voices are `alloy`,
+        #     `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
+        #     `cedar`. You may also provide a custom voice object with an `id`, for example
+        #     `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
+        #     model has responded with audio at least once. We recommend `marin` and `cedar`
+        #     for best quality.
 
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
@@ -89,7 +100,8 @@ module OpenAI
             # @!method initialize(id:)
             #   Custom voice reference.
             #
-            #   @param id [String] The custom voice ID, e.g. `voice_1234`.
+            #   @param id [String]
+            #     The custom voice ID, e.g. `voice_1234`.
           end
 
           # @!method self.variants