openai 0.87.0 → 0.88.0

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

@@ -27,9 +27,6 @@ module OpenAI
         optional :event_id, String
 
         # @!method initialize(session:, event_id: nil, type: :"session.update")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::SessionUpdateEvent} for more details.
-        #
         #   Send this event to update the session’s configuration. The client may send this
         #   event at any time to update any field except for `voice` and `model`. `voice`
         #   can be updated only if there have been no other audio outputs yet.
@@ -40,11 +37,18 @@ module OpenAI
         #   like `instructions`, pass an empty string. To clear a field like `tools`, pass
         #   an empty array. To clear a field like `turn_detection`, pass `null`.
         #
-        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest] Update the Realtime session. Choose either a realtime
+        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest]
+        #     Update the Realtime session. Choose either a realtime session or a transcription
+        #     session.
         #
-        #   @param event_id [String] Optional client-generated ID used to identify this event. This is an arbitrary s
+        #   @param event_id [String]
+        #     Optional client-generated ID used to identify this event. This is an arbitrary
+        #     string that a client may assign. It will be passed back if there is an error
+        #     with the event, but the corresponding `session.updated` event will not include
+        #     it.
         #
-        #   @param type [Symbol, :"session.update"] The event type, must be `session.update`.
+        #   @param type [Symbol, :"session.update"]
+        #     The event type, must be `session.update`.
 
         # Update the Realtime session. Choose either a realtime session or a transcription
         # session.

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

@@ -26,11 +26,14 @@ module OpenAI
         #   Returned when a session is updated with a `session.update` event, unless there
         #   is an error.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
         #
-        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest] The session configuration.
+        #   @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest]
+        #     The session configuration.
         #
-        #   @param type [Symbol, :"session.updated"] The event type, must be `session.updated`.
+        #   @param type [Symbol, :"session.updated"]
+        #     The event type, must be `session.updated`.
 
         # The session configuration.
         #

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

@@ -25,11 +25,14 @@ module OpenAI
         # @!method initialize(session:, event_id: nil, type: :"transcription_session.update")
         #   Send this event to update a transcription session.
         #
-        #   @param session [OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session] Realtime transcription session object configuration.
+        #   @param session [OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session]
+        #     Realtime transcription session object 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, :"transcription_session.update"] The event type, must be `transcription_session.update`.
+        #   @param type [Symbol, :"transcription_session.update"]
+        #     The event type, must be `transcription_session.update`.
 
         # @see OpenAI::Models::Realtime::TranscriptionSessionUpdate#session
         class Session < OpenAI::Internal::Type::BaseModel
@@ -86,22 +89,33 @@ module OpenAI
           optional :turn_detection, -> { OpenAI::Realtime::TranscriptionSessionUpdate::Session::TurnDetection }
 
           # @!method initialize(include: nil, input_audio_format: nil, input_audio_noise_reduction: nil, input_audio_transcription: nil, turn_detection: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session} for more
-          #   details.
-          #
           #   Realtime transcription session object configuration.
           #
-          #   @param include [Array<Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::Include>] The set of items to include in the transcription. Current available items are:
+          #   @param include [Array<Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::Include>]
+          #     The set of items to include in the transcription. Current available items are:
+          #     `item.input_audio_transcription.logprobs`
           #
-          #   @param input_audio_format [Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::InputAudioFormat] The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
+          #   @param input_audio_format [Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::InputAudioFormat]
+          #     The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`. For
+          #     `pcm16`, input audio must be 16-bit PCM at a 24kHz sample rate, single channel
+          #     (mono), and little-endian byte order.
           #
-          #   @param input_audio_noise_reduction [OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::InputAudioNoiseReduction] Configuration for input audio noise reduction. This can be set to `null` to turn
+          #   @param input_audio_noise_reduction [OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::InputAudioNoiseReduction]
+          #     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 input_audio_transcription [OpenAI::Models::Realtime::AudioTranscription] Configuration for input audio transcription. The client can optionally set the l
+          #   @param input_audio_transcription [OpenAI::Models::Realtime::AudioTranscription]
+          #     Configuration for input audio transcription. The client can optionally set the
+          #     language and prompt for transcription, these offer additional guidance to the
+          #     transcription service.
           #
-          #   @param turn_detection [OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::TurnDetection] Configuration for turn detection. Can be set to `null` to turn off. Server VAD m
-
+          #   @param turn_detection [OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::TurnDetection]
+          #     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.
           module Include
             extend OpenAI::Internal::Type::Enum
 
@@ -138,17 +152,16 @@ module OpenAI
             optional :type, enum: -> { OpenAI::Realtime::NoiseReductionType }
 
             # @!method initialize(type: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::InputAudioNoiseReduction}
-            #   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
 
           # @see OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session#turn_detection
@@ -184,21 +197,27 @@ module OpenAI
             optional :type, enum: -> { OpenAI::Realtime::TranscriptionSessionUpdate::Session::TurnDetection::Type }
 
             # @!method initialize(prefix_padding_ms: nil, silence_duration_ms: nil, threshold: nil, type: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::TurnDetection}
-            #   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.
             #
-            #   @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 [Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::TurnDetection::Type] Type of turn detection. Only `server_vad` is currently supported for transcripti
+            #   @param type [Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::TurnDetection::Type]
+            #     Type of turn detection. Only `server_vad` is currently supported for
+            #     transcription sessions.
 
             # Type of turn detection. Only `server_vad` is currently supported for
             # transcription sessions.

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

@@ -27,17 +27,21 @@ module OpenAI
         required :type, const: :"transcription_session.updated"
 
         # @!method initialize(event_id:, session:, type: :"transcription_session.updated")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent} for more details.
-        #
         #   Returned when a transcription session is updated with a
         #   `transcription_session.update` event, unless there is an error.
         #
-        #   @param event_id [String] The unique ID of the server event.
+        #   @param event_id [String]
+        #     The unique ID of the server event.
+        #
+        #   @param session [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session]
+        #     A new Realtime transcription session configuration.
         #
-        #   @param session [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session] A new Realtime transcription session configuration.
+        #     When a session is created on the server via REST API, the session object also
+        #     contains an ephemeral key. Default TTL for keys is 10 minutes. This property is
+        #     not present when a session is updated via the WebSocket API.
         #
-        #   @param type [Symbol, :"transcription_session.updated"] The event type, must be `transcription_session.updated`.
+        #   @param type [Symbol, :"transcription_session.updated"]
+        #     The event type, must be `transcription_session.updated`.
 
         # @see OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent#session
         class Session < OpenAI::Internal::Type::BaseModel
@@ -85,25 +89,29 @@ module OpenAI
           )
 
           # @!method initialize(client_secret:, input_audio_format: nil, input_audio_transcription: nil, modalities: nil, turn_detection: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session} for more
-          #   details.
-          #
           #   A new Realtime transcription session configuration.
           #
           #   When a session is created on the server via REST API, the session object also
           #   contains an ephemeral key. Default TTL for keys is 10 minutes. This property is
           #   not present when a session is updated via the WebSocket API.
           #
-          #   @param client_secret [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::ClientSecret] Ephemeral key returned by the API. Only present when the session is
+          #   @param client_secret [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::ClientSecret]
+          #     Ephemeral key returned by the API. Only present when the session is created on
+          #     the server via REST API.
           #
-          #   @param input_audio_format [String] The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
+          #   @param input_audio_format [String]
+          #     The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
           #
           #   @param input_audio_transcription [OpenAI::Models::Realtime::AudioTranscription]
           #
-          #   @param modalities [Array<Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Modality>] The set of modalities the model can respond with. To disable audio,
+          #   @param modalities [Array<Symbol, OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::Modality>]
+          #     The set of modalities the model can respond with. To disable audio, set this to
+          #     ["text"].
           #
-          #   @param turn_detection [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::TurnDetection] Configuration for turn detection. Can be set to `null` to turn off. Server
+          #   @param turn_detection [OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::TurnDetection]
+          #     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.
 
           # @see OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session#client_secret
           class ClientSecret < OpenAI::Internal::Type::BaseModel
@@ -123,16 +131,17 @@ module OpenAI
             required :value, String
 
             # @!method initialize(expires_at:, value:)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::ClientSecret}
-            #   for more details.
-            #
             #   Ephemeral key returned by the API. Only present when the session is created on
             #   the server via REST API.
             #
-            #   @param expires_at [Integer] Timestamp for when the token expires. Currently, all tokens expire
+            #   @param expires_at [Integer]
+            #     Timestamp for when the token expires. Currently, all tokens expire after one
+            #     minute.
             #
-            #   @param value [String] Ephemeral key usable in client environments to authenticate connections
+            #   @param value [String]
+            #     Ephemeral key usable in client environments to authenticate connections to the
+            #     Realtime API. Use this in client-side environments rather than a standard API
+            #     token, which should only be used server-side.
           end
 
           module Modality
@@ -177,21 +186,26 @@ 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::TranscriptionSessionUpdatedEvent::Session::TurnDetection}
-            #   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.
             #
-            #   @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
       end

data/lib/openai/models/reasoning.rb

@@ -19,7 +19,7 @@ module OpenAI
       #   are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
       #   reasoning effort can result in faster responses and fewer tokens used on
       #   reasoning in a response. Not all reasoning models support every value. See the
-      #   [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+      #   [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
       #   model-specific support.
       #
       #   @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
@@ -57,21 +57,44 @@ module OpenAI
       optional :summary, enum: -> { OpenAI::Reasoning::Summary }, nil?: true
 
       # @!method initialize(context: nil, effort: nil, generate_summary: nil, mode: nil, summary: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::Reasoning} for more details.
-      #
       #   Configuration options for
-      #   [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+      #   [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
+      #
+      #   @param context [Symbol, OpenAI::Models::Reasoning::Context, nil]
+      #     Controls which reasoning items are rendered back to the model on later turns. If
+      #     omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`
+      #     model family defaults to `all_turns`; earlier models default to `current_turn`.
+      #
+      #     When returned on a response, this is the effective reasoning context mode used
+      #     for the response.
+      #
+      #   @param effort [Symbol, OpenAI::Models::ReasoningEffort, nil]
+      #     Constrains effort on reasoning for reasoning models. Currently supported values
+      #     are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
+      #     reasoning effort can result in faster responses and fewer tokens used on
+      #     reasoning in a response. Not all reasoning models support every value. See the
+      #     [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
+      #     model-specific support.
+      #
+      #   @param generate_summary [Symbol, OpenAI::Models::Reasoning::GenerateSummary, nil]
+      #     **Deprecated:** use `summary` instead.
       #
-      #   @param context [Symbol, OpenAI::Models::Reasoning::Context, nil] Controls which reasoning items are rendered back to the model on later turns.
+      #     A summary of the reasoning performed by the model. This can be useful for
+      #     debugging and understanding the model's reasoning process. One of `auto`,
+      #     `concise`, or `detailed`.
       #
-      #   @param effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for reasoning models. Currently supported
+      #   @param mode [String, Symbol, OpenAI::Models::Reasoning::Mode]
+      #     Controls the reasoning execution mode for the request.
       #
-      #   @param generate_summary [Symbol, OpenAI::Models::Reasoning::GenerateSummary, nil] **Deprecated:** use `summary` instead.
+      #     When returned on a response, this is the effective execution mode.
       #
-      #   @param mode [String, Symbol, OpenAI::Models::Reasoning::Mode] Controls the reasoning execution mode for the request.
+      #   @param summary [Symbol, OpenAI::Models::Reasoning::Summary, nil]
+      #     A summary of the reasoning performed by the model. This can be useful for
+      #     debugging and understanding the model's reasoning process. One of `auto`,
+      #     `concise`, or `detailed`.
       #
-      #   @param summary [Symbol, OpenAI::Models::Reasoning::Summary, nil] A summary of the reasoning performed by the model. This can be
+      #     `concise` is supported for `computer-use-preview` models and all reasoning
+      #     models after `gpt-5`.
 
       # Controls which reasoning items are rendered back to the model on later turns. If
       # omitted or set to `auto`, the model determines the context mode. The `gpt-5.6`

data/lib/openai/models/reasoning_effort.rb

@@ -6,7 +6,7 @@ module OpenAI
     # are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
     # reasoning effort can result in faster responses and fewer tokens used on
     # reasoning in a response. Not all reasoning models support every value. See the
-    # [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+    # [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
     # model-specific support.
     module ReasoningEffort
       extend OpenAI::Internal::Type::Enum

data/lib/openai/models/response_format_json_object.rb

@@ -14,7 +14,8 @@ module OpenAI
       #   `json_schema` is recommended for models that support it. Note that the model
       #   will not generate JSON without a system or user message instructing it to do so.
       #
-      #   @param type [Symbol, :json_object] The type of response format being defined. Always `json_object`.
+      #   @param type [Symbol, :json_object]
+      #     The type of response format being defined. Always `json_object`.
     end
   end
 end

data/lib/openai/models/response_format_json_schema.rb

@@ -16,16 +16,15 @@ module OpenAI
       required :type, const: :json_schema
 
       # @!method initialize(json_schema:, type: :json_schema)
-      #   Some parameter documentations has been truncated, see
-      #   {OpenAI::Models::ResponseFormatJSONSchema} for more details.
-      #
       #   JSON Schema response format. Used to generate structured JSON responses. Learn
       #   more about
-      #   [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+      #   [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
       #
-      #   @param json_schema [OpenAI::Models::ResponseFormatJSONSchema::JSONSchema] Structured Outputs configuration options, including a JSON Schema.
+      #   @param json_schema [OpenAI::Models::ResponseFormatJSONSchema::JSONSchema]
+      #     Structured Outputs configuration options, including a JSON Schema.
       #
-      #   @param type [Symbol, :json_schema] The type of response format being defined. Always `json_schema`.
+      #   @param type [Symbol, :json_schema]
+      #     The type of response format being defined. Always `json_schema`.
 
       # @see OpenAI::Models::ResponseFormatJSONSchema#json_schema
       class JSONSchema < OpenAI::Internal::Type::BaseModel
@@ -63,24 +62,32 @@ module OpenAI
         #   true, the model will always follow the exact schema defined in the `schema`
         #   field. Only a subset of JSON Schema is supported when `strict` is `true`. To
         #   learn more, read the
-        #   [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+        #   [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
         #
         #   @return [Boolean, nil]
         optional :strict, OpenAI::Internal::Type::Boolean, nil?: true
 
         # @!method initialize(name:, description: nil, schema: nil, strict: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::ResponseFormatJSONSchema::JSONSchema} for more details.
-        #
         #   Structured Outputs configuration options, including a JSON Schema.
         #
-        #   @param name [String] The name of the response format. Must be a-z, A-Z, 0-9, or contain
+        #   @param name [String]
+        #     The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores
+        #     and dashes, with a maximum length of 64.
         #
-        #   @param description [String] A description of what the response format is for, used by the model to
+        #   @param description [String]
+        #     A description of what the response format is for, used by the model to determine
+        #     how to respond in the format.
         #
-        #   @param schema [Hash{Symbol=>Object}, OpenAI::StructuredOutput::JsonSchemaConverter] The schema for the response format, described as a JSON Schema object.
+        #   @param schema [Hash{Symbol=>Object}, OpenAI::StructuredOutput::JsonSchemaConverter]
+        #     The schema for the response format, described as a JSON Schema object. Learn how
+        #     to build JSON schemas [here](https://json-schema.org/).
         #
-        #   @param strict [Boolean, nil] Whether to enable strict schema adherence when generating the output.
+        #   @param strict [Boolean, nil]
+        #     Whether to enable strict schema adherence when generating the output. If set to
+        #     true, the model will always follow the exact schema defined in the `schema`
+        #     field. Only a subset of JSON Schema is supported when `strict` is `true`. To
+        #     learn more, read the
+        #     [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
       end
     end
   end

data/lib/openai/models/response_format_text.rb

@@ -12,7 +12,8 @@ module OpenAI
       # @!method initialize(type: :text)
       #   Default response format. Used to generate text responses.
       #
-      #   @param type [Symbol, :text] The type of response format being defined. Always `text`.
+      #   @param type [Symbol, :text]
+      #     The type of response format being defined. Always `text`.
     end
   end
 end

data/lib/openai/models/response_format_text_grammar.rb

@@ -17,11 +17,13 @@ module OpenAI
 
       # @!method initialize(grammar:, type: :grammar)
       #   A custom grammar for the model to follow when generating text. Learn more in the
-      #   [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars).
+      #   [custom grammars guide](https://developers.openai.com/api/docs/guides/function-calling#context-free-grammars).
       #
-      #   @param grammar [String] The custom grammar for the model to follow.
+      #   @param grammar [String]
+      #     The custom grammar for the model to follow.
       #
-      #   @param type [Symbol, :grammar] The type of response format being defined. Always `grammar`.
+      #   @param type [Symbol, :grammar]
+      #     The type of response format being defined. Always `grammar`.
     end
   end
 end

data/lib/openai/models/response_format_text_python.rb

@@ -11,10 +11,11 @@ module OpenAI
 
       # @!method initialize(type: :python)
       #   Configure the model to generate valid Python code. See the
-      #   [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars)
+      #   [custom grammars guide](https://developers.openai.com/api/docs/guides/function-calling#context-free-grammars)
       #   for more details.
       #
-      #   @param type [Symbol, :python] The type of response format being defined. Always `python`.
+      #   @param type [Symbol, :python]
+      #     The type of response format being defined. Always `python`.
     end
   end
 end

data/lib/openai/models/responses/apply_patch_tool.rb

@@ -25,10 +25,11 @@ module OpenAI
         # @!method initialize(allowed_callers: nil, type: :apply_patch)
         #   Allows the assistant to create, delete, or update files using unified diffs.
         #
-        #   @param allowed_callers [Array<Symbol, OpenAI::Models::Responses::ApplyPatchTool::AllowedCaller>, nil] The tool invocation context(s).
+        #   @param allowed_callers [Array<Symbol, OpenAI::Models::Responses::ApplyPatchTool::AllowedCaller>, nil]
+        #     The tool invocation context(s).
         #
-        #   @param type [Symbol, :apply_patch] The type of the tool. Always `apply_patch`.
-
+        #   @param type [Symbol, :apply_patch]
+        #     The type of the tool. Always `apply_patch`.
         module AllowedCaller
           extend OpenAI::Internal::Type::Enum
 

data/lib/openai/models/responses/compacted_response.rb

@@ -38,18 +38,22 @@ module OpenAI
         required :usage, -> { OpenAI::Responses::ResponseUsage }
 
         # @!method initialize(id:, created_at:, output:, usage:, object: :"response.compaction")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::CompactedResponse} for more details.
+        #   @param id [String]
+        #     The unique identifier for the compacted response.
         #
-        #   @param id [String] The unique identifier for the compacted response.
+        #   @param created_at [Integer]
+        #     Unix timestamp (in seconds) when the compacted conversation was created.
         #
-        #   @param created_at [Integer] Unix timestamp (in seconds) when the compacted conversation was created.
+        #   @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>]
+        #     The compacted list of output items. This is a list of all user messages,
+        #     followed by a single compaction item.
         #
-        #   @param output [Array<OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::Program, OpenAI::Models::Responses::ResponseOutputItem::ProgramOutput, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseOutputItem::AdditionalTools, OpenAI::Models::Responses::ResponseCompactionItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem>] The compacted list of output items. This is a list of all user messages, followe
+        #   @param usage [OpenAI::Models::Responses::ResponseUsage]
+        #     Token accounting for the compaction pass, including cached, reasoning, and total
+        #     tokens.
         #
-        #   @param usage [OpenAI::Models::Responses::ResponseUsage] Token accounting for the compaction pass, including cached, reasoning, and total
-        #
-        #   @param object [Symbol, :"response.compaction"] The object type. Always `response.compaction`.
+        #   @param object [Symbol, :"response.compaction"]
+        #     The object type. Always `response.compaction`.
       end
     end
   end