openai 0.92.0 → 0.93.0

data/sig/openai/models/realtime/transcription_session_update.rbs

@@ -9,14 +9,24 @@ module OpenAI
         }
 
       class TranscriptionSessionUpdate < OpenAI::Internal::Type::BaseModel
+        # Realtime transcription session object configuration.
         attr_accessor session: OpenAI::Realtime::TranscriptionSessionUpdate::Session
 
+        # The event type, must be `transcription_session.update`.
         attr_accessor type: :"transcription_session.update"
 
+        # Optional client-generated ID used to identify this event.
         attr_reader event_id: String?
 
+        # Optional client-generated ID used to identify this event.
         def event_id=: (String) -> String
 
+        # @param session
+        #   Realtime transcription session object configuration.
+        # @param event_id
+        #   Optional client-generated ID used to identify this event.
+        # @param type
+        #   The event type, must be `transcription_session.update`.
         def initialize: (
           session: OpenAI::Realtime::TranscriptionSessionUpdate::Session,
           ?event_id: String,
@@ -39,36 +49,89 @@ module OpenAI
           }
 
         class Session < OpenAI::Internal::Type::BaseModel
+          # The set of items to include in the transcription. Current available items are:
+          # `item.input_audio_transcription.logprobs`
           attr_reader include: ::Array[OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::include_]?
 
+          # The set of items to include in the transcription. Current available items are:
+          # `item.input_audio_transcription.logprobs`
           def include=: (
             ::Array[OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::include_]
           ) -> ::Array[OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::include_]
 
+          # 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.
           attr_reader input_audio_format: OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::input_audio_format?
 
+          # 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.
           def input_audio_format=: (
             OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::input_audio_format
           ) -> OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::input_audio_format
 
+          # 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.
           attr_reader input_audio_noise_reduction: OpenAI::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.
           def input_audio_noise_reduction=: (
             OpenAI::Realtime::TranscriptionSessionUpdate::Session::InputAudioNoiseReduction
           ) -> OpenAI::Realtime::TranscriptionSessionUpdate::Session::InputAudioNoiseReduction
 
+          # Configuration for input audio transcription. The client can optionally set the
+          # language and prompt for transcription, these offer additional guidance to the
+          # transcription service.
           attr_reader input_audio_transcription: OpenAI::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.
           def input_audio_transcription=: (
             OpenAI::Realtime::AudioTranscription
           ) -> OpenAI::Realtime::AudioTranscription
 
+          # 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.
           attr_reader turn_detection: OpenAI::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.
           def turn_detection=: (
             OpenAI::Realtime::TranscriptionSessionUpdate::Session::TurnDetection
           ) -> OpenAI::Realtime::TranscriptionSessionUpdate::Session::TurnDetection
 
+          # @param include
+          #   The set of items to include in the transcription. Current available items are:
+          #   `item.input_audio_transcription.logprobs`
+          # @param input_audio_format
+          #   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
+          #   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
+          #   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
+          #   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.
           def initialize: (
             ?include: ::Array[OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::include_],
             ?input_audio_format: OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::input_audio_format,
@@ -111,12 +174,22 @@ module OpenAI
             { ?type: OpenAI::Models::Realtime::noise_reduction_type }
 
           class InputAudioNoiseReduction < OpenAI::Internal::Type::BaseModel
+            # 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.
             attr_reader type: OpenAI::Models::Realtime::noise_reduction_type?
 
+            # 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.
             def type=: (
               OpenAI::Models::Realtime::noise_reduction_type
             ) -> OpenAI::Models::Realtime::noise_reduction_type
 
+            # @param type
+            #   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.
             def initialize: (
               ?type: OpenAI::Models::Realtime::noise_reduction_type
             ) -> void
@@ -135,24 +208,58 @@ module OpenAI
             }
 
           class TurnDetection < OpenAI::Internal::Type::BaseModel
+            # Amount of audio to include before the VAD detected speech (in milliseconds).
+            # Defaults to 300ms.
             attr_reader prefix_padding_ms: Integer?
 
+            # Amount of audio to include before the VAD detected speech (in milliseconds).
+            # Defaults to 300ms.
             def prefix_padding_ms=: (Integer) -> 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.
             attr_reader 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.
             def silence_duration_ms=: (Integer) -> Integer
 
+            # 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.
             attr_reader 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.
             def threshold=: (Float) -> Float
 
+            # Type of turn detection. Only `server_vad` is currently supported for
+            # transcription sessions.
             attr_reader type: OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::TurnDetection::type_?
 
+            # Type of turn detection. Only `server_vad` is currently supported for
+            # transcription sessions.
             def type=: (
               OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::TurnDetection::type_
             ) -> OpenAI::Models::Realtime::TranscriptionSessionUpdate::Session::TurnDetection::type_
 
+            # @param prefix_padding_ms
+            #   Amount of audio to include before the VAD detected speech (in milliseconds).
+            #   Defaults to 300ms.
+            # @param silence_duration_ms
+            #   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
+            #   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
+            #   Type of turn detection. Only `server_vad` is currently supported for
+            #   transcription sessions.
             def initialize: (
               ?prefix_padding_ms: Integer,
               ?silence_duration_ms: Integer,

data/sig/openai/models/realtime/transcription_session_updated_event.rbs

@@ -9,12 +9,29 @@ module OpenAI
         }
 
       class TranscriptionSessionUpdatedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # 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.
         attr_accessor session: OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session
 
+        # The event type, must be `transcription_session.updated`.
         attr_accessor type: :"transcription_session.updated"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param 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
+        #   The event type, must be `transcription_session.updated`.
         def initialize: (
           event_id: String,
           session: OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session,
@@ -37,10 +54,14 @@ module OpenAI
           }
 
         class Session < OpenAI::Internal::Type::BaseModel
+          # Ephemeral key returned by the API. Only present when the session is created on
+          # the server via REST API.
           attr_accessor client_secret: OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::ClientSecret
 
+          # The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
           attr_reader input_audio_format: String?
 
+          # The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
           def input_audio_format=: (String) -> String
 
           attr_reader input_audio_transcription: OpenAI::Realtime::AudioTranscription?
@@ -49,18 +70,40 @@ module OpenAI
             OpenAI::Realtime::AudioTranscription
           ) -> OpenAI::Realtime::AudioTranscription
 
+          # The set of modalities the model can respond with. To disable audio, set this to
+          # ["text"].
           attr_reader modalities: ::Array[OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::modality]?
 
+          # The set of modalities the model can respond with. To disable audio, set this to
+          # ["text"].
           def modalities=: (
             ::Array[OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::modality]
           ) -> ::Array[OpenAI::Models::Realtime::TranscriptionSessionUpdatedEvent::Session::modality]
 
+          # 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.
           attr_reader turn_detection: OpenAI::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.
           def turn_detection=: (
             OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::TurnDetection
           ) -> OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::TurnDetection
 
+          # @param client_secret
+          #   Ephemeral key returned by the API. Only present when the session is created on
+          #   the server via REST API.
+          # @param input_audio_format
+          #   The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.
+          # @param modalities
+          #   The set of modalities the model can respond with. To disable audio, set this to
+          #   ["text"].
+          # @param turn_detection
+          #   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.
           def initialize: (
             client_secret: OpenAI::Realtime::TranscriptionSessionUpdatedEvent::Session::ClientSecret,
             ?input_audio_format: String,
@@ -80,10 +123,22 @@ module OpenAI
           type client_secret = { expires_at: Integer, value: String }
 
           class ClientSecret < OpenAI::Internal::Type::BaseModel
+            # Timestamp for when the token expires. Currently, all tokens expire after one
+            # minute.
             attr_accessor expires_at: Integer
 
+            # 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.
             attr_accessor value: String
 
+            # @param expires_at
+            #   Timestamp for when the token expires. Currently, all tokens expire after one
+            #   minute.
+            # @param value
+            #   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.
             def initialize: (expires_at: Integer, value: String) -> void
 
             def to_hash: -> { expires_at: Integer, value: String }
@@ -109,22 +164,53 @@ module OpenAI
             }
 
           class TurnDetection < OpenAI::Internal::Type::BaseModel
+            # Amount of audio to include before the VAD detected speech (in milliseconds).
+            # Defaults to 300ms.
             attr_reader prefix_padding_ms: Integer?
 
+            # Amount of audio to include before the VAD detected speech (in milliseconds).
+            # Defaults to 300ms.
             def prefix_padding_ms=: (Integer) -> 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.
             attr_reader 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.
             def silence_duration_ms=: (Integer) -> Integer
 
+            # 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.
             attr_reader 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.
             def threshold=: (Float) -> Float
 
+            # Type of turn detection, only `server_vad` is currently supported.
             attr_reader type: String?
 
+            # Type of turn detection, only `server_vad` is currently supported.
             def type=: (String) -> String
 
+            # @param prefix_padding_ms
+            #   Amount of audio to include before the VAD detected speech (in milliseconds).
+            #   Defaults to 300ms.
+            # @param silence_duration_ms
+            #   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
+            #   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
+            #   Type of turn detection, only `server_vad` is currently supported.
             def initialize: (
               ?prefix_padding_ms: Integer,
               ?silence_duration_ms: Integer,

data/sig/openai/models/reasoning.rbs

@@ -10,20 +10,80 @@ module OpenAI
       }
 
     class Reasoning < OpenAI::Internal::Type::BaseModel
+      # 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.
       attr_accessor context: OpenAI::Models::Reasoning::context?
 
+      # 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.
       attr_accessor effort: OpenAI::Models::reasoning_effort?
 
+      # **Deprecated:** use `summary` instead.
+      #
+      # 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`.
       attr_accessor generate_summary: OpenAI::Models::Reasoning::generate_summary?
 
+      # Controls the reasoning execution mode for the request.
+      #
+      # When returned on a response, this is the effective execution mode.
       attr_reader mode: OpenAI::Models::Reasoning::mode?
 
+      # Controls the reasoning execution mode for the request.
+      #
+      # When returned on a response, this is the effective execution mode.
       def mode=: (
         OpenAI::Models::Reasoning::mode
       ) -> OpenAI::Models::Reasoning::mode
 
+      # 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`.
+      #
+      # `concise` is supported for `computer-use-preview` models and all reasoning
+      # models after `gpt-5`.
       attr_accessor summary: OpenAI::Models::Reasoning::summary?
 
+      # @param context
+      #   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
+      #   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
+      #   **Deprecated:** use `summary` instead.
+      #
+      #   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 mode
+      #   Controls the reasoning execution mode for the request.
+      #
+      #   When returned on a response, this is the effective execution mode.
+      # @param summary
+      #   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`.
+      #
+      #   `concise` is supported for `computer-use-preview` models and all reasoning
+      #   models after `gpt-5`.
       def initialize: (
         ?context: OpenAI::Models::Reasoning::context?,
         ?effort: OpenAI::Models::reasoning_effort?,

data/sig/openai/models/response_format_json_object.rbs

@@ -3,8 +3,11 @@ module OpenAI
     type response_format_json_object = { ?type: :json_object }
 
     class ResponseFormatJSONObject < OpenAI::Internal::Type::BaseModel
+      # The type of response format being defined. Always `json_object`.
       attr_accessor type: :json_object
 
+      # @param type
+      #   The type of response format being defined. Always `json_object`.
       def initialize: (?type: :json_object) -> void
 
       def to_hash: -> { ?type: :json_object }

data/sig/openai/models/response_format_json_schema.rbs

@@ -7,10 +7,16 @@ module OpenAI
       }
 
     class ResponseFormatJSONSchema < OpenAI::Internal::Type::BaseModel
+      # Structured Outputs configuration options, including a JSON Schema.
       attr_accessor json_schema: OpenAI::ResponseFormatJSONSchema::JSONSchema
 
+      # The type of response format being defined. Always `json_schema`.
       attr_accessor type: :json_schema
 
+      # @param json_schema
+      #   Structured Outputs configuration options, including a JSON Schema.
+      # @param type
+      #   The type of response format being defined. Always `json_schema`.
       def initialize: (
         json_schema: OpenAI::ResponseFormatJSONSchema::JSONSchema,
         ?type: :json_schema
@@ -30,18 +36,48 @@ module OpenAI
         }
 
       class JSONSchema < OpenAI::Internal::Type::BaseModel
+        # 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.
         attr_accessor name: String
 
+        # A description of what the response format is for, used by the model to determine
+        # how to respond in the format.
         attr_reader description: String?
 
+        # A description of what the response format is for, used by the model to determine
+        # how to respond in the format.
         def description=: (String) -> String
 
+        # The schema for the response format, described as a JSON Schema object. Learn how
+        # to build JSON schemas [here](https://json-schema.org/).
         attr_reader schema: ::Hash[Symbol, top]?
 
+        # The schema for the response format, described as a JSON Schema object. Learn how
+        # to build JSON schemas [here](https://json-schema.org/).
         def schema=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
 
+        # 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).
         attr_accessor strict: bool?
 
+        # @param name
+        #   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
+        #   A description of what the response format is for, used by the model to determine
+        #   how to respond in the format.
+        # @param schema
+        #   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
+        #   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).
         def initialize: (
           name: String,
           ?description: String,

data/sig/openai/models/response_format_text.rbs

@@ -3,8 +3,11 @@ module OpenAI
     type response_format_text = { ?type: :text }
 
     class ResponseFormatText < OpenAI::Internal::Type::BaseModel
+      # The type of response format being defined. Always `text`.
       attr_accessor type: :text
 
+      # @param type
+      #   The type of response format being defined. Always `text`.
       def initialize: (?type: :text) -> void
 
       def to_hash: -> { ?type: :text }

data/sig/openai/models/response_format_text_grammar.rbs

@@ -3,10 +3,16 @@ module OpenAI
     type response_format_text_grammar = { grammar: String, ?type: :grammar }
 
     class ResponseFormatTextGrammar < OpenAI::Internal::Type::BaseModel
+      # The custom grammar for the model to follow.
       attr_accessor grammar: String
 
+      # The type of response format being defined. Always `grammar`.
       attr_accessor type: :grammar
 
+      # @param grammar
+      #   The custom grammar for the model to follow.
+      # @param type
+      #   The type of response format being defined. Always `grammar`.
       def initialize: (grammar: String, ?type: :grammar) -> void
 
       def to_hash: -> { grammar: String, ?type: :grammar }

data/sig/openai/models/response_format_text_python.rbs

@@ -3,8 +3,11 @@ module OpenAI
     type response_format_text_python = { ?type: :python }
 
     class ResponseFormatTextPython < OpenAI::Internal::Type::BaseModel
+      # The type of response format being defined. Always `python`.
       attr_accessor type: :python
 
+      # @param type
+      #   The type of response format being defined. Always `python`.
       def initialize: (?type: :python) -> void
 
       def to_hash: -> { ?type: :python }

data/sig/openai/models/responses/apply_patch_tool.rbs

@@ -8,10 +8,16 @@ module OpenAI
         }
 
       class ApplyPatchTool < OpenAI::Internal::Type::BaseModel
+        # The type of the tool. Always `apply_patch`.
         attr_accessor type: :apply_patch
 
+        # The tool invocation context(s).
         attr_accessor allowed_callers: ::Array[OpenAI::Models::Responses::ApplyPatchTool::allowed_caller]?
 
+        # @param allowed_callers
+        #   The tool invocation context(s).
+        # @param type
+        #   The type of the tool. Always `apply_patch`.
         def initialize: (
           ?allowed_callers: ::Array[OpenAI::Models::Responses::ApplyPatchTool::allowed_caller]?,
           ?type: :apply_patch

data/sig/openai/models/responses/compacted_response.rbs

@@ -11,16 +11,35 @@ module OpenAI
         }
 
       class CompactedResponse < OpenAI::Internal::Type::BaseModel
+        # The unique identifier for the compacted response.
         attr_accessor id: String
 
+        # Unix timestamp (in seconds) when the compacted conversation was created.
         attr_accessor created_at: Integer
 
+        # The object type. Always `response.compaction`.
         attr_accessor object: :"response.compaction"
 
+        # The compacted list of output items. This is a list of all user messages,
+        # followed by a single compaction item.
         attr_accessor output: ::Array[OpenAI::Models::Responses::response_output_item]
 
+        # Token accounting for the compaction pass, including cached, reasoning, and total
+        # tokens.
         attr_accessor usage: OpenAI::Responses::ResponseUsage
 
+        # @param id
+        #   The unique identifier for the compacted response.
+        # @param created_at
+        #   Unix timestamp (in seconds) when the compacted conversation was created.
+        # @param output
+        #   The compacted list of output items. This is a list of all user messages,
+        #   followed by a single compaction item.
+        # @param usage
+        #   Token accounting for the compaction pass, including cached, reasoning, and total
+        #   tokens.
+        # @param object
+        #   The object type. Always `response.compaction`.
         def initialize: (
           id: String,
           created_at: Integer,