openai 0.87.0 → 0.88.0

data/lib/openai/models/moderation_create_params.rb

@@ -16,20 +16,23 @@ module OpenAI
 
       # @!attribute model
       #   The content moderation model you would like to use. Learn more in
-      #   [the moderation guide](https://platform.openai.com/docs/guides/moderation), and
-      #   learn about available models
-      #   [here](https://platform.openai.com/docs/models#moderation).
+      #   [the moderation guide](https://developers.openai.com/api/docs/guides/moderation),
+      #   and learn about available models
+      #   [here](https://developers.openai.com/api/docs/guides/moderation).
       #
       #   @return [String, Symbol, OpenAI::Models::ModerationModel, nil]
       optional :model, union: -> { OpenAI::ModerationCreateParams::Model }
 
       # @!method initialize(input:, model: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ModerationCreateParams} for more details.
+      #   @param input [String, Array<String>, Array<OpenAI::Models::ModerationImageURLInput, OpenAI::Models::ModerationTextInput>]
+      #     Input (or inputs) to classify. Can be a single string, an array of strings, or
+      #     an array of multi-modal input objects similar to other models.
       #
-      #   @param input [String, Array<String>, Array<OpenAI::Models::ModerationImageURLInput, OpenAI::Models::ModerationTextInput>] Input (or inputs) to classify. Can be a single string, an array of strings, or
-      #
-      #   @param model [String, Symbol, OpenAI::Models::ModerationModel] The content moderation model you would like to use. Learn more in
+      #   @param model [String, Symbol, OpenAI::Models::ModerationModel]
+      #     The content moderation model you would like to use. Learn more in
+      #     [the moderation guide](https://developers.openai.com/api/docs/guides/moderation),
+      #     and learn about available models
+      #     [here](https://developers.openai.com/api/docs/guides/moderation).
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
@@ -60,17 +63,17 @@ module OpenAI
       end
 
       # The content moderation model you would like to use. Learn more in
-      # [the moderation guide](https://platform.openai.com/docs/guides/moderation), and
-      # learn about available models
-      # [here](https://platform.openai.com/docs/models#moderation).
+      # [the moderation guide](https://developers.openai.com/api/docs/guides/moderation),
+      # and learn about available models
+      # [here](https://developers.openai.com/api/docs/guides/moderation).
       module Model
         extend OpenAI::Internal::Type::Union
 
         variant String
 
         # The content moderation model you would like to use. Learn more in
-        # [the moderation guide](https://platform.openai.com/docs/guides/moderation), and learn about
-        # available models [here](https://platform.openai.com/docs/models#moderation).
+        # [the moderation guide](https://developers.openai.com/api/docs/guides/moderation), and learn about
+        # available models [here](https://developers.openai.com/api/docs/guides/moderation).
         variant enum: -> { OpenAI::ModerationModel }
 
         # @!method self.variants

data/lib/openai/models/moderation_create_response.rb

@@ -25,11 +25,14 @@ module OpenAI
       # @!method initialize(id:, model:, results:)
       #   Represents if a given text input is potentially harmful.
       #
-      #   @param id [String] The unique identifier for the moderation request.
+      #   @param id [String]
+      #     The unique identifier for the moderation request.
       #
-      #   @param model [String] The model used to generate the moderation results.
+      #   @param model [String]
+      #     The model used to generate the moderation results.
       #
-      #   @param results [Array<OpenAI::Models::Moderation>] A list of moderation objects.
+      #   @param results [Array<OpenAI::Models::Moderation>]
+      #     A list of moderation objects.
     end
   end
 end

data/lib/openai/models/moderation_image_url_input.rb

@@ -18,9 +18,11 @@ module OpenAI
       # @!method initialize(image_url:, type: :image_url)
       #   An object describing an image to classify.
       #
-      #   @param image_url [OpenAI::Models::ModerationImageURLInput::ImageURL] Contains either an image URL or a data URL for a base64 encoded image.
+      #   @param image_url [OpenAI::Models::ModerationImageURLInput::ImageURL]
+      #     Contains either an image URL or a data URL for a base64 encoded image.
       #
-      #   @param type [Symbol, :image_url] Always `image_url`.
+      #   @param type [Symbol, :image_url]
+      #     Always `image_url`.
 
       # @see OpenAI::Models::ModerationImageURLInput#image_url
       class ImageURL < OpenAI::Internal::Type::BaseModel
@@ -33,7 +35,8 @@ module OpenAI
         # @!method initialize(url:)
         #   Contains either an image URL or a data URL for a base64 encoded image.
         #
-        #   @param url [String] Either a URL of the image or the base64 encoded image data.
+        #   @param url [String]
+        #     Either a URL of the image or the base64 encoded image data.
       end
     end
   end

data/lib/openai/models/moderation_text_input.rb

@@ -18,9 +18,11 @@ module OpenAI
       # @!method initialize(text:, type: :text)
       #   An object describing text to classify.
       #
-      #   @param text [String] A string of text to classify.
+      #   @param text [String]
+      #     A string of text to classify.
       #
-      #   @param type [Symbol, :text] Always `text`.
+      #   @param type [Symbol, :text]
+      #     Always `text`.
     end
   end
 end

data/lib/openai/models/other_file_chunking_strategy_object.rb

@@ -14,7 +14,8 @@ module OpenAI
       #   because the file was indexed before the `chunking_strategy` concept was
       #   introduced in the API.
       #
-      #   @param type [Symbol, :other] Always `other`.
+      #   @param type [Symbol, :other]
+      #     Always `other`.
     end
   end
 end

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

@@ -48,7 +48,7 @@ module OpenAI
         # @!attribute prompt
         #   An optional text to guide the model's style or continue a previous audio
         #   segment. For `whisper-1`, the
-        #   [prompt is a list of keywords](https://platform.openai.com/docs/guides/speech-to-text#prompting).
+        #   [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting).
         #   For `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the
         #   prompt is a free text string, for example "expect words related to technology".
         #   Prompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.
@@ -57,20 +57,39 @@ module OpenAI
         optional :prompt, String
 
         # @!method initialize(delay: nil, keywords: nil, language: nil, languages: nil, model: nil, prompt: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::AudioTranscription} for more details.
+        #   @param delay [Symbol, OpenAI::Models::Realtime::AudioTranscription::Delay]
+        #     Controls how long the model waits before emitting transcription text. Higher
+        #     values can improve transcription accuracy at the cost of latency. Only supported
+        #     with `gpt-realtime-whisper` in GA Realtime sessions.
         #
-        #   @param delay [Symbol, OpenAI::Models::Realtime::AudioTranscription::Delay] Controls how long the model waits before emitting transcription text.
+        #   @param keywords [Array<String>]
+        #     Words or phrases to guide transcription of the input audio. Supported by
+        #     `gpt-transcribe` and `gpt-live-transcribe`.
         #
-        #   @param keywords [Array<String>] Words or phrases to guide transcription of the input audio. Supported by `gpt-tr
+        #   @param language [String]
+        #     The language of the input audio. Supplying the input language in
+        #     [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`)
+        #     format will improve accuracy and latency.
         #
-        #   @param language [String] The language of the input audio. Supplying the input language in
+        #   @param languages [Array<String>]
+        #     Possible languages of the input audio, in
+        #     [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+        #     Supported by `gpt-transcribe` and `gpt-live-transcribe`.
         #
-        #   @param languages [Array<String>] Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/w
+        #   @param model [String, Symbol, OpenAI::Models::Realtime::AudioTranscription::Model]
+        #     The model to use for transcription. Current options are `whisper-1`,
+        #     `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`,
+        #     `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`,
+        #     `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use
+        #     `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.
         #
-        #   @param model [String, Symbol, OpenAI::Models::Realtime::AudioTranscription::Model] The model to use for transcription. Current options are `whisper-1`, `gpt-transc
-        #
-        #   @param prompt [String] An optional text to guide the model's style or continue a previous audio
+        #   @param prompt [String]
+        #     An optional text to guide the model's style or continue a previous audio
+        #     segment. For `whisper-1`, the
+        #     [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting).
+        #     For `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the
+        #     prompt is a free text string, for example "expect words related to technology".
+        #     Prompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.
 
         # Controls how long the model waits before emitting transcription text. Higher
         # values can improve transcription accuracy at the cost of latency. Only supported

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

@@ -14,38 +14,93 @@ module OpenAI
         required :call_id, String
 
         # @!method initialize(call_id:, audio: nil, include: nil, instructions: nil, max_output_tokens: nil, model: nil, output_modalities: nil, parallel_tool_calls: nil, prompt: nil, reasoning: nil, tool_choice: nil, tools: nil, tracing: nil, truncation: nil, type: :realtime, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::CallAcceptParams} for more details.
-        #
         #   @param call_id [String]
         #
-        #   @param audio [OpenAI::Models::Realtime::RealtimeAudioConfig] Configuration for input and output audio.
-        #
-        #   @param include [Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Include>] Additional fields to include in server outputs.
-        #
-        #   @param instructions [String] The default system instructions (i.e. system message) prepended to model calls.
-        #
-        #   @param max_output_tokens [Integer, Symbol, :inf] Maximum number of output tokens for a single assistant response,
-        #
-        #   @param model [String, Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Model] The Realtime model used for this session.
-        #
-        #   @param output_modalities [Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::OutputModality>] The set of modalities the model can respond with. It defaults to `["audio"]`, in
-        #
-        #   @param parallel_tool_calls [Boolean] Whether the model may call multiple tools in parallel. Only supported by
-        #
-        #   @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
-        #
-        #   @param reasoning [OpenAI::Models::Realtime::RealtimeReasoning] Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.
-        #
-        #   @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp] How the model chooses tools. Provide one of the string modes or force a specific
-        #
-        #   @param tools [Array<OpenAI::Models::Realtime::RealtimeFunctionTool, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp>] Tools available to the model.
-        #
-        #   @param tracing [Symbol, :auto, OpenAI::Models::Realtime::RealtimeTracingConfig::TracingConfiguration, nil] Realtime API can write session traces to the [Traces Dashboard](https://platform
-        #
-        #   @param truncation [Symbol, OpenAI::Models::Realtime::RealtimeTruncation::RealtimeTruncationStrategy, OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio] When the number of tokens in a conversation exceeds the model's input token limi
-        #
-        #   @param type [Symbol, :realtime] The type of session to create. Always `realtime` for the Realtime API.
+        #   @param audio [OpenAI::Models::Realtime::RealtimeAudioConfig]
+        #     Configuration for input and output audio.
+        #
+        #   @param include [Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Include>]
+        #     Additional fields to include in server outputs.
+        #
+        #     `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+        #     transcription.
+        #
+        #   @param instructions [String]
+        #     The default system instructions (i.e. system message) prepended to model calls.
+        #     This field allows the client to guide the model on desired responses. The model
+        #     can be instructed on response content and format, (e.g. "be extremely succinct",
+        #     "act friendly", "here are examples of good responses") and on audio behavior
+        #     (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The
+        #     instructions are not guaranteed to be followed by the model, but they provide
+        #     guidance to the model on the desired behavior.
+        #
+        #     Note that the server sets default instructions which will be used if this field
+        #     is not set and are visible in the `session.created` event at the start of the
+        #     session.
+        #
+        #   @param max_output_tokens [Integer, Symbol, :inf]
+        #     Maximum number of output tokens for a single assistant response, inclusive of
+        #     tool calls. Provide an integer between 1 and 4096 to limit output tokens, or
+        #     `inf` for the maximum available tokens for a given model. Defaults to `inf`.
+        #
+        #   @param model [String, Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Model]
+        #     The Realtime model used for this session.
+        #
+        #   @param output_modalities [Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::OutputModality>]
+        #     The set of modalities the model can respond with. It defaults to `["audio"]`,
+        #     indicating that the model will respond with audio plus a transcript. `["text"]`
+        #     can be used to make the model respond with text only. It is not possible to
+        #     request both `text` and `audio` at the same time.
+        #
+        #   @param parallel_tool_calls [Boolean]
+        #     Whether the model may call multiple tools in parallel. Only supported by
+        #     reasoning Realtime models such as `gpt-realtime-2`.
+        #
+        #   @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil]
+        #     Reference to a prompt template and its variables.
+        #     [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
+        #
+        #   @param reasoning [OpenAI::Models::Realtime::RealtimeReasoning]
+        #     Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.
+        #
+        #   @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp]
+        #     How the model chooses tools. Provide one of the string modes or force a specific
+        #     function/MCP tool.
+        #
+        #   @param tools [Array<OpenAI::Models::Realtime::RealtimeFunctionTool, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp>]
+        #     Tools available to the model.
+        #
+        #   @param tracing [Symbol, :auto, OpenAI::Models::Realtime::RealtimeTracingConfig::TracingConfiguration, nil]
+        #     Realtime API can write session traces to the
+        #     [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to
+        #     disable tracing. Once tracing is enabled for a session, the configuration cannot
+        #     be modified.
+        #
+        #     `auto` will create a trace for the session with default values for the workflow
+        #     name, group id, and metadata.
+        #
+        #   @param truncation [Symbol, OpenAI::Models::Realtime::RealtimeTruncation::RealtimeTruncationStrategy, OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio]
+        #     When the number of tokens in a conversation exceeds the model's input token
+        #     limit, the conversation be truncated, meaning messages (starting from the
+        #     oldest) will not be included in the model's context. A 32k context model with
+        #     4,096 max output tokens can only include 28,224 tokens in the context before
+        #     truncation occurs.
+        #
+        #     Clients can configure truncation behavior to truncate with a lower max token
+        #     limit, which is an effective way to control token usage and cost.
+        #
+        #     Truncation will reduce the number of cached tokens on the next turn (busting the
+        #     cache), since messages are dropped from the beginning of the context. However,
+        #     clients can also configure truncation to retain messages up to a fraction of the
+        #     maximum context size, which will reduce the need for future truncations and thus
+        #     improve the cache rate.
+        #
+        #     Truncation can be disabled entirely, which means the server will never truncate
+        #     but would instead return an error if the conversation exceeds the model's input
+        #     token limit.
+        #
+        #   @param type [Symbol, :realtime]
+        #     The type of session to create. Always `realtime` for the Realtime API.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -21,9 +21,11 @@ module OpenAI
         optional :session, -> { OpenAI::Realtime::RealtimeSessionCreateRequest }
 
         # @!method initialize(sdp:, session: nil, request_options: {})
-        #   @param sdp [String] WebRTC Session Description Protocol (SDP) offer generated by the caller.
+        #   @param sdp [String]
+        #     WebRTC Session Description Protocol (SDP) offer generated by the caller.
         #
-        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest] Realtime session object configuration.
+        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest]
+        #     Realtime session object configuration.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -21,12 +21,11 @@ module OpenAI
         required :target_uri, String
 
         # @!method initialize(call_id:, target_uri:, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::CallReferParams} for more details.
-        #
         #   @param call_id [String]
         #
-        #   @param target_uri [String] URI that should appear in the SIP Refer-To header. Supports values like
+        #   @param target_uri [String]
+        #     URI that should appear in the SIP Refer-To header. Supports values like
+        #     `tel:+14155550123` or `sip:agent@example.com`.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -21,12 +21,11 @@ module OpenAI
         optional :status_code, Integer
 
         # @!method initialize(call_id:, status_code: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::CallRejectParams} for more details.
-        #
         #   @param call_id [String]
         #
-        #   @param status_code [Integer] SIP response code to send back to the caller. Defaults to `603` (Decline)
+        #   @param status_code [Integer]
+        #     SIP response code to send back to the caller. Defaults to `603` (Decline) when
+        #     omitted.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -25,12 +25,15 @@ module OpenAI
         optional :session, union: -> { OpenAI::Realtime::ClientSecretCreateParams::Session }
 
         # @!method initialize(expires_after: nil, session: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ClientSecretCreateParams} for more details.
+        #   @param expires_after [OpenAI::Models::Realtime::ClientSecretCreateParams::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.
         #
-        #   @param expires_after [OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter] Configuration for the client secret expiration. Expiration refers to the time af
-        #
-        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest] Session configuration to use for the client secret. Choose either a realtime
+        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest]
+        #     Session configuration to use for the client secret. Choose either a realtime
+        #     session or a transcription session.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
@@ -52,18 +55,20 @@ module OpenAI
           optional :seconds, Integer
 
           # @!method initialize(anchor: nil, seconds: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::ClientSecretCreateParams::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::ClientSecretCreateParams::ExpiresAfter::Anchor] The anchor point for the client secret expiration, meaning that `seconds` will b
+          #   @param anchor [Symbol, OpenAI::Models::Realtime::ClientSecretCreateParams::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

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

@@ -24,16 +24,16 @@ module OpenAI
         required :value, String
 
         # @!method initialize(expires_at:, session:, value:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ClientSecretCreateResponse} for more details.
-        #
         #   Response from creating a session and client secret for the Realtime API.
         #
-        #   @param expires_at [Integer] Expiration timestamp for the client secret, in seconds since epoch.
+        #   @param expires_at [Integer]
+        #     Expiration timestamp for the client secret, in seconds since epoch.
         #
-        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateResponse, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse] The session configuration for either a realtime or transcription session.
+        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateResponse, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse]
+        #     The session configuration for either a realtime or transcription session.
         #
-        #   @param value [String] The generated client secret value.
+        #   @param value [String]
+        #     The generated client secret value.
 
         # The session configuration for either a realtime or transcription session.
         #

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

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(conversation:, event_id:, type: :"conversation.created")
         #   Returned when a conversation is created. Emitted right after session creation.
         #
-        #   @param conversation [OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation] The conversation resource.
+        #   @param conversation [OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation]
+        #     The conversation resource.
         #
-        #   @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, :"conversation.created"] The event type, must be `conversation.created`.
+        #   @param type [Symbol, :"conversation.created"]
+        #     The event type, must be `conversation.created`.
 
         # @see OpenAI::Models::Realtime::ConversationCreatedEvent#conversation
         class Conversation < OpenAI::Internal::Type::BaseModel
@@ -48,9 +51,11 @@ module OpenAI
           # @!method initialize(id: nil, object: nil)
           #   The conversation resource.
           #
-          #   @param id [String] The unique ID of the conversation.
+          #   @param id [String]
+          #     The unique ID of the conversation.
           #
-          #   @param object [Symbol, OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation::Object] The object type, must be `realtime.conversation`.
+          #   @param object [Symbol, OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation::Object]
+          #     The object type, must be `realtime.conversation`.
 
           # The object type, must be `realtime.conversation`.
           #

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

@@ -30,9 +30,6 @@ module OpenAI
         optional :previous_item_id, String, nil?: true
 
         # @!method initialize(event_id:, item:, previous_item_id: nil, type: :"conversation.item.added")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemAdded} for more details.
-        #
         #   Sent by the server when an Item is added to the default Conversation. This can
         #   happen in several cases:
         #
@@ -48,13 +45,18 @@ module OpenAI
         #   generating a Response) except for audio data, which can be retrieved separately
         #   with a `conversation.item.retrieve` event if necessary.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest] A single item within a Realtime conversation.
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #     A single item within a Realtime conversation.
         #
-        #   @param previous_item_id [String, nil] The ID of the item that precedes this one, if any. This is used to
+        #   @param previous_item_id [String, nil]
+        #     The ID of the item that precedes this one, if any. This is used to maintain
+        #     ordering when items are inserted.
         #
-        #   @param type [Symbol, :"conversation.item.added"] The event type, must be `conversation.item.added`.
+        #   @param type [Symbol, :"conversation.item.added"]
+        #     The event type, must be `conversation.item.added`.
       end
     end
   end

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

@@ -37,9 +37,6 @@ module OpenAI
         optional :previous_item_id, String
 
         # @!method initialize(item:, event_id: nil, previous_item_id: nil, type: :"conversation.item.create")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemCreateEvent} for more details.
-        #
         #   Add a new Item to the Conversation's context, including messages, function
         #   calls, and function call responses. This event can be used both to populate a
         #   "history" of the conversation and to add new items mid-stream, but has the
@@ -48,13 +45,25 @@ module OpenAI
         #   If successful, the server will respond with a `conversation.item.created` event,
         #   otherwise an `error` event will be sent.
         #
-        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest] A single item within a Realtime conversation.
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #     A single item within a Realtime conversation.
+        #
+        #   @param event_id [String]
+        #     Optional client-generated ID used to identify this event.
+        #
+        #   @param previous_item_id [String]
+        #     The ID of the preceding item after which the new item will be inserted. If not
+        #     set, the new item will be appended to the end of the conversation.
         #
-        #   @param event_id [String] Optional client-generated ID used to identify this event.
+        #     If set to `root`, the new item will be added to the beginning of the
+        #     conversation.
         #
-        #   @param previous_item_id [String] The ID of the preceding item after which the new item will be inserted. If not s
+        #     If set to an existing ID, it allows an item to be inserted mid-conversation. If
+        #     the ID cannot be found, an error will be returned and the item will not be
+        #     added.
         #
-        #   @param type [Symbol, :"conversation.item.create"] The event type, must be `conversation.item.create`.
+        #   @param type [Symbol, :"conversation.item.create"]
+        #     The event type, must be `conversation.item.create`.
       end
     end
   end

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

@@ -31,9 +31,6 @@ module OpenAI
         optional :previous_item_id, String, nil?: true
 
         # @!method initialize(event_id:, item:, previous_item_id: nil, type: :"conversation.item.created")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::ConversationItemCreatedEvent} for more details.
-        #
         #   Returned when a conversation item is created. There are several scenarios that
         #   produce this event:
         #
@@ -46,13 +43,19 @@ module OpenAI
         #   - The client has sent a `conversation.item.create` event to add a new Item to
         #     the Conversation.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest] A single item within a Realtime conversation.
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #     A single item within a Realtime conversation.
         #
-        #   @param previous_item_id [String, nil] The ID of the preceding item in the Conversation context, allows the
+        #   @param previous_item_id [String, nil]
+        #     The ID of the preceding item in the Conversation context, allows the client to
+        #     understand the order of the conversation. Can be `null` if the item has no
+        #     predecessor.
         #
-        #   @param type [Symbol, :"conversation.item.created"] The event type, must be `conversation.item.created`.
+        #   @param type [Symbol, :"conversation.item.created"]
+        #     The event type, must be `conversation.item.created`.
       end
     end
   end

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

@@ -28,11 +28,14 @@ module OpenAI
         #   item does not exist in the conversation history, in which case the server will
         #   respond with an error.
         #
-        #   @param item_id [String] The ID of the item to delete.
+        #   @param item_id [String]
+        #     The ID of the item to delete.
         #
-        #   @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, :"conversation.item.delete"] The event type, must be `conversation.item.delete`.
+        #   @param type [Symbol, :"conversation.item.delete"]
+        #     The event type, must be `conversation.item.delete`.
       end
     end
   end

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

@@ -27,11 +27,14 @@ module OpenAI
         #   `conversation.item.delete` event. This event is used to synchronize the server's
         #   understanding of the conversation history with the client's view.
         #
-        #   @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 that was deleted.
+        #   @param item_id [String]
+        #     The ID of the item that was deleted.
         #
-        #   @param type [Symbol, :"conversation.item.deleted"] The event type, must be `conversation.item.deleted`.
+        #   @param type [Symbol, :"conversation.item.deleted"]
+        #     The event type, must be `conversation.item.deleted`.
       end
     end
   end