openai 0.87.0 → 0.89.0

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

@@ -5,7 +5,7 @@ module OpenAI
     module Realtime
       # Give the model access to additional tools via remote Model Context Protocol
       # (MCP) servers.
-      # [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+      # [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
       module RealtimeToolsConfigUnion
         extend OpenAI::Internal::Type::Union
 
@@ -14,7 +14,7 @@ module OpenAI
         variant :function, -> { OpenAI::Realtime::RealtimeFunctionTool }
 
         # Give the model access to additional tools via remote Model Context Protocol
-        # (MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+        # (MCP) servers. [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
         variant :mcp, -> { OpenAI::Realtime::RealtimeToolsConfigUnion::Mcp }
 
         class Mcp < OpenAI::Internal::Type::BaseModel
@@ -64,7 +64,7 @@ module OpenAI
           #   Identifier for service connectors, like those available in ChatGPT. One of
           #   `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
           #   service connectors
-          #   [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+          #   [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
           #   Currently supported `connector_id` values are:
           #
@@ -124,37 +124,64 @@ module OpenAI
           optional :tunnel_id, String
 
           # @!method initialize(server_label:, allowed_callers: nil, allowed_tools: nil, authorization: nil, connector_id: nil, defer_loading: nil, headers: nil, require_approval: nil, server_description: nil, server_url: nil, tunnel_id: nil, type: :mcp)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp} for more details.
-          #
           #   Give the model access to additional tools via remote Model Context Protocol
           #   (MCP) servers.
-          #   [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+          #   [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
           #
-          #   @param server_label [String] A label for this MCP server, used to identify it in tool calls.
+          #   @param server_label [String]
+          #     A label for this MCP server, used to identify it in tool calls.
           #
-          #   @param allowed_callers [Array<Symbol, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::AllowedCaller>, nil] The tool invocation context(s).
+          #   @param allowed_callers [Array<Symbol, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::AllowedCaller>, nil]
+          #     The tool invocation context(s).
           #
-          #   @param allowed_tools [Array<String>, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::AllowedTools::McpToolFilter, nil] List of allowed tool names or a filter object.
+          #   @param allowed_tools [Array<String>, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::AllowedTools::McpToolFilter, nil]
+          #     List of allowed tool names or a filter object.
           #
-          #   @param authorization [String] An OAuth access token that can be used with a remote MCP server, either
+          #   @param authorization [String]
+          #     An OAuth access token that can be used with a remote MCP server, either with a
+          #     custom MCP server URL or a service connector. Your application must handle the
+          #     OAuth authorization flow and provide the token here.
           #
-          #   @param connector_id [Symbol, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::ConnectorID] Identifier for service connectors, like those available in ChatGPT. One of
+          #   @param connector_id [Symbol, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::ConnectorID]
+          #     Identifier for service connectors, like those available in ChatGPT. One of
+          #     `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
+          #     service connectors
+          #     [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
-          #   @param defer_loading [Boolean] Whether this MCP tool is deferred and discovered via tool search.
+          #     Currently supported `connector_id` values are:
           #
-          #   @param headers [Hash{Symbol=>String}, nil] Optional HTTP headers to send to the MCP server. Use for authentication
+          #     - Dropbox: `connector_dropbox`
+          #     - Gmail: `connector_gmail`
+          #     - Google Calendar: `connector_googlecalendar`
+          #     - Google Drive: `connector_googledrive`
+          #     - Microsoft Teams: `connector_microsoftteams`
+          #     - Outlook Calendar: `connector_outlookcalendar`
+          #     - Outlook Email: `connector_outlookemail`
+          #     - SharePoint: `connector_sharepoint`
           #
-          #   @param require_approval [OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter, Symbol, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalSetting, nil] Specify which of the MCP server's tools require approval.
+          #   @param defer_loading [Boolean]
+          #     Whether this MCP tool is deferred and discovered via tool search.
           #
-          #   @param server_description [String] Optional description of the MCP server, used to provide more context.
+          #   @param headers [Hash{Symbol=>String}, nil]
+          #     Optional HTTP headers to send to the MCP server. Use for authentication or other
+          #     purposes.
           #
-          #   @param server_url [String] The URL for the MCP server. One of `server_url`, `connector_id`, or
+          #   @param require_approval [OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter, Symbol, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalSetting, nil]
+          #     Specify which of the MCP server's tools require approval.
           #
-          #   @param tunnel_id [String] The Secure MCP Tunnel ID to use instead of a direct server URL. One of
+          #   @param server_description [String]
+          #     Optional description of the MCP server, used to provide more context.
           #
-          #   @param type [Symbol, :mcp] The type of the MCP tool. Always `mcp`.
-
+          #   @param server_url [String]
+          #     The URL for the MCP server. One of `server_url`, `connector_id`, or `tunnel_id`
+          #     must be provided.
+          #
+          #   @param tunnel_id [String]
+          #     The Secure MCP Tunnel ID to use instead of a direct server URL. One of
+          #     `server_url`, `connector_id`, or `tunnel_id` must be provided.
+          #
+          #   @param type [Symbol, :mcp]
+          #     The type of the MCP tool. Always `mcp`.
           module AllowedCaller
             extend OpenAI::Internal::Type::Enum
 
@@ -194,15 +221,16 @@ module OpenAI
               optional :tool_names, OpenAI::Internal::Type::ArrayOf[String]
 
               # @!method initialize(read_only: nil, tool_names: nil)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::AllowedTools::McpToolFilter}
-              #   for more details.
-              #
               #   A filter object to specify which tools are allowed.
               #
-              #   @param read_only [Boolean] Indicates whether or not a tool modifies data or is read-only. If an
+              #   @param read_only [Boolean]
+              #     Indicates whether or not a tool modifies data or is read-only. If an MCP server
+              #     is
+              #     [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+              #     it will match this filter.
               #
-              #   @param tool_names [Array<String>] List of allowed tool names.
+              #   @param tool_names [Array<String>]
+              #     List of allowed tool names.
             end
 
             # @!method self.variants
@@ -215,7 +243,7 @@ module OpenAI
           # Identifier for service connectors, like those available in ChatGPT. One of
           # `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
           # service connectors
-          # [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+          # [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
           #
           # Currently supported `connector_id` values are:
           #
@@ -283,16 +311,14 @@ module OpenAI
               )
 
               # @!method initialize(always: nil, never: nil)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter}
-              #   for more details.
-              #
               #   Specify which of the MCP server's tools require approval. Can be `always`,
               #   `never`, or a filter object associated with tools that require approval.
               #
-              #   @param always [OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter::Always] A filter object to specify which tools are allowed.
+              #   @param always [OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter::Always]
+              #     A filter object to specify which tools are allowed.
               #
-              #   @param never [OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter::Never] A filter object to specify which tools are allowed.
+              #   @param never [OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter::Never]
+              #     A filter object to specify which tools are allowed.
 
               # @see OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter#always
               class Always < OpenAI::Internal::Type::BaseModel
@@ -312,15 +338,16 @@ module OpenAI
                 optional :tool_names, OpenAI::Internal::Type::ArrayOf[String]
 
                 # @!method initialize(read_only: nil, tool_names: nil)
-                #   Some parameter documentations has been truncated, see
-                #   {OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter::Always}
-                #   for more details.
-                #
                 #   A filter object to specify which tools are allowed.
                 #
-                #   @param read_only [Boolean] Indicates whether or not a tool modifies data or is read-only. If an
+                #   @param read_only [Boolean]
+                #     Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                #     is
+                #     [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                #     it will match this filter.
                 #
-                #   @param tool_names [Array<String>] List of allowed tool names.
+                #   @param tool_names [Array<String>]
+                #     List of allowed tool names.
               end
 
               # @see OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter#never
@@ -341,15 +368,16 @@ module OpenAI
                 optional :tool_names, OpenAI::Internal::Type::ArrayOf[String]
 
                 # @!method initialize(read_only: nil, tool_names: nil)
-                #   Some parameter documentations has been truncated, see
-                #   {OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp::RequireApproval::McpToolApprovalFilter::Never}
-                #   for more details.
-                #
                 #   A filter object to specify which tools are allowed.
                 #
-                #   @param read_only [Boolean] Indicates whether or not a tool modifies data or is read-only. If an
+                #   @param read_only [Boolean]
+                #     Indicates whether or not a tool modifies data or is read-only. If an MCP server
+                #     is
+                #     [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
+                #     it will match this filter.
                 #
-                #   @param tool_names [Array<String>] List of allowed tool names.
+                #   @param tool_names [Array<String>]
+                #     List of allowed tool names.
               end
             end
 

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

@@ -42,17 +42,19 @@ module OpenAI
           optional :workflow_name, String
 
           # @!method initialize(group_id: nil, metadata: nil, workflow_name: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeTracingConfig::TracingConfiguration} for more
-          #   details.
-          #
           #   Granular configuration for tracing.
           #
-          #   @param group_id [String] The group id to attach to this trace to enable filtering and
+          #   @param group_id [String]
+          #     The group id to attach to this trace to enable filtering and grouping in the
+          #     Traces Dashboard.
           #
-          #   @param metadata [Object] The arbitrary metadata to attach to this trace to enable
+          #   @param metadata [Object]
+          #     The arbitrary metadata to attach to this trace to enable filtering in the Traces
+          #     Dashboard.
           #
-          #   @param workflow_name [String] The name of the workflow to attach to this trace. This is used to
+          #   @param workflow_name [String]
+          #     The name of the workflow to attach to this trace. This is used to name the trace
+          #     in the Traces Dashboard.
         end
 
         # @!method self.variants

data/lib/openai/models/realtime/realtime_transcription_session_audio_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.
@@ -59,17 +59,43 @@ module OpenAI
         )
 
         # @!method initialize(format_: nil, noise_reduction: nil, transcription: nil, turn_detection: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranscriptionSessionAudioInput} for more
-        #   details.
+        #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA]
+        #     The PCM audio format. Only a 24kHz sample rate is supported.
         #
-        #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA] The PCM audio format. Only a 24kHz sample rate is supported.
+        #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeTranscriptionSessionAudioInput::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::RealtimeTranscriptionSessionAudioInput::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::RealtimeTranscriptionSessionAudioInputTurnDetection::ServerVad, OpenAI::Models::Realtime::RealtimeTranscriptionSessionAudioInputTurnDetection::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::RealtimeTranscriptionSessionAudioInputTurnDetection::ServerVad, OpenAI::Models::Realtime::RealtimeTranscriptionSessionAudioInputTurnDetection::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::RealtimeTranscriptionSessionAudioInput#noise_reduction
         class NoiseReduction < OpenAI::Internal::Type::BaseModel
@@ -82,17 +108,16 @@ module OpenAI
           optional :type, enum: -> { OpenAI::Realtime::NoiseReductionType }
 
           # @!method initialize(type: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeTranscriptionSessionAudioInput::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_transcription_session_audio_input_turn_detection.rb

@@ -107,26 +107,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::RealtimeTranscriptionSessionAudioInputTurnDetection::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
@@ -164,20 +194,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::RealtimeTranscriptionSessionAudioInputTurnDetection::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::RealtimeTranscriptionSessionAudioInputTurnDetection::SemanticVad::Eagerness] Used only for `semantic_vad` mode. The eagerness of the model to respond. `low`
+          #   @param eagerness [Symbol, OpenAI::Models::Realtime::RealtimeTranscriptionSessionAudioInputTurnDetection::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_transcription_session_create_request.rb

@@ -32,18 +32,20 @@ module OpenAI
         )
 
         # @!method initialize(audio: nil, include: nil, type: :transcription)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest} for more
-        #   details.
-        #
         #   Realtime transcription session object configuration.
         #
-        #   @param audio [OpenAI::Models::Realtime::RealtimeTranscriptionSessionAudio] Configuration for input and output audio.
+        #   @param audio [OpenAI::Models::Realtime::RealtimeTranscriptionSessionAudio]
+        #     Configuration for input and output audio.
         #
-        #   @param include [Array<Symbol, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest::Include>] Additional fields to include in server outputs.
+        #   @param include [Array<Symbol, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest::Include>]
+        #     Additional fields to include in server outputs.
         #
-        #   @param type [Symbol, :transcription] The type of session to create. Always `transcription` for transcription sessions
-
+        #     `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+        #     transcription.
+        #
+        #   @param type [Symbol, :transcription]
+        #     The type of session to create. Always `transcription` for transcription
+        #     sessions.
         module Include
           extend OpenAI::Internal::Type::Enum
 

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

@@ -49,23 +49,28 @@ module OpenAI
         )
 
         # @!method initialize(id:, object:, audio: nil, expires_at: nil, include: nil, type: :transcription)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse} for more
-        #   details.
-        #
         #   A Realtime transcription session configuration object.
         #
-        #   @param id [String] Unique identifier for the session that looks like `sess_1234567890abcdef`.
+        #   @param id [String]
+        #     Unique identifier for the session that looks like `sess_1234567890abcdef`.
+        #
+        #   @param object [String]
+        #     The object type. Always `realtime.transcription_session`.
         #
-        #   @param object [String] The object type. Always `realtime.transcription_session`.
+        #   @param audio [OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio]
+        #     Configuration for input audio for the session.
         #
-        #   @param audio [OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio] Configuration for input audio for the session.
+        #   @param expires_at [Integer]
+        #     Expiration timestamp for the session, in seconds since epoch.
         #
-        #   @param expires_at [Integer] Expiration timestamp for the session, in seconds since epoch.
+        #   @param include [Array<Symbol, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::Include>]
+        #     Additional fields to include in server outputs.
         #
-        #   @param include [Array<Symbol, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::Include>] Additional fields to include in server outputs.
+        #     - `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+        #       transcription.
         #
-        #   @param type [Symbol, :transcription] The type of session. Always `transcription` for transcription sessions.
+        #   @param type [Symbol, :transcription]
+        #     The type of session. Always `transcription` for transcription sessions.
 
         # @see OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse#audio
         class Audio < OpenAI::Internal::Type::BaseModel
@@ -117,17 +122,19 @@ module OpenAI
             )
 
             # @!method initialize(format_: nil, noise_reduction: nil, transcription: nil, turn_detection: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio::Input}
-            #   for more details.
+            #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA]
+            #     The PCM audio format. Only a 24kHz sample rate is supported.
             #
-            #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA] The PCM audio format. Only a 24kHz sample rate is supported.
-            #
-            #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction] Configuration for input audio noise reduction.
+            #   @param noise_reduction [OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction]
+            #     Configuration for input audio noise reduction.
             #
             #   @param transcription [OpenAI::Models::Realtime::AudioTranscription]
             #
-            #   @param turn_detection [OpenAI::Models::Realtime::RealtimeTranscriptionSessionTurnDetection, nil] Configuration for turn detection. Can be set to `null` to turn off. Server
+            #   @param turn_detection [OpenAI::Models::Realtime::RealtimeTranscriptionSessionTurnDetection, nil]
+            #     Configuration for turn detection. Can be set to `null` to turn off. 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. For `gpt-realtime-whisper`, this
+            #     must be `null`; VAD is not supported.
 
             # @see OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio::Input#noise_reduction
             class NoiseReduction < OpenAI::Internal::Type::BaseModel
@@ -140,13 +147,12 @@ module OpenAI
               optional :type, enum: -> { OpenAI::Realtime::NoiseReductionType }
 
               # @!method initialize(type: nil)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction}
-              #   for more details.
-              #
               #   Configuration for input audio noise reduction.
               #
-              #   @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_transcription_session_turn_detection.rb

@@ -34,22 +34,27 @@ module OpenAI
         optional :type, String
 
         # @!method initialize(prefix_padding_ms: nil, silence_duration_ms: nil, threshold: nil, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranscriptionSessionTurnDetection} for more
-        #   details.
-        #
         #   Configuration for turn detection. Can be set to `null` to turn off. 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. For `gpt-realtime-whisper`, this
         #   must be `null`; VAD is not supported.
         #
-        #   @param prefix_padding_ms [Integer] Amount of audio to include before the VAD detected speech (in
+        #   @param prefix_padding_ms [Integer]
+        #     Amount of audio to include before the VAD detected speech (in milliseconds).
+        #     Defaults to 300ms.
         #
-        #   @param silence_duration_ms [Integer] Duration of silence to detect speech stop (in milliseconds). Defaults
+        #   @param silence_duration_ms [Integer]
+        #     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] Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A
+        #   @param threshold [Float]
+        #     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 [String] Type of turn detection, only `server_vad` is currently supported.
+        #   @param type [String]
+        #     Type of turn detection, only `server_vad` is currently supported.
       end
     end
 

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

@@ -24,15 +24,17 @@ module OpenAI
         )
 
         # @!method initialize(session:, expires_after: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest} for
-        #   more details.
-        #
         #   Create a translation session and client secret for the Realtime API.
         #
-        #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest] Realtime translation session configuration. Translation sessions stream source
+        #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest]
+        #     Realtime translation session configuration. Translation sessions stream source
+        #     audio in and translated audio plus transcript deltas out continuously.
         #
-        #   @param expires_after [OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter] Configuration for the client secret expiration. Expiration refers to the time af
+        #   @param expires_after [OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter]
+        #     Configuration for the client secret expiration. Expiration refers to the time
+        #     after which a client secret will no longer be valid for creating sessions. The
+        #     session itself may continue after that time once started. A secret can be used
+        #     to create multiple sessions until it expires.
 
         # @see OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest#expires_after
         class ExpiresAfter < OpenAI::Internal::Type::BaseModel
@@ -56,18 +58,20 @@ module OpenAI
           optional :seconds, Integer
 
           # @!method initialize(anchor: nil, seconds: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter}
-          #   for more details.
-          #
           #   Configuration for the client secret expiration. Expiration refers to the time
           #   after which a client secret will no longer be valid for creating sessions. The
           #   session itself may continue after that time once started. A secret can be used
           #   to create multiple sessions until it expires.
           #
-          #   @param anchor [Symbol, OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter::Anchor] The anchor point for the client secret expiration, meaning that `seconds` will b
+          #   @param anchor [Symbol, OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter::Anchor]
+          #     The anchor point for the client secret expiration, meaning that `seconds` will
+          #     be added to the `created_at` time of the client secret to produce an expiration
+          #     timestamp. Only `created_at` is currently supported.
           #
-          #   @param seconds [Integer] The number of seconds from the anchor point to the expiration. Select a value be
+          #   @param seconds [Integer]
+          #     The number of seconds from the anchor point to the expiration. Select a value
+          #     between `10` and `7200` (2 hours). This default to 600 seconds (10 minutes) if
+          #     not specified.
 
           # The anchor point for the client secret expiration, meaning that `seconds` will
           # be added to the `created_at` time of the client secret to produce an expiration