openai 0.91.0 → 0.93.0

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

@@ -9,20 +9,42 @@ module OpenAI
         }
 
       class RealtimeTranscriptionSessionCreateRequest < OpenAI::Internal::Type::BaseModel
+        # The type of session to create. Always `transcription` for transcription
+        # sessions.
         attr_accessor type: :transcription
 
+        # Configuration for input and output audio.
         attr_reader audio: OpenAI::Realtime::RealtimeTranscriptionSessionAudio?
 
+        # Configuration for input and output audio.
         def audio=: (
           OpenAI::Realtime::RealtimeTranscriptionSessionAudio
         ) -> OpenAI::Realtime::RealtimeTranscriptionSessionAudio
 
+        # Additional fields to include in server outputs.
+        #
+        # `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+        # transcription.
         attr_reader include: ::Array[OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest::include_]?
 
+        # Additional fields to include in server outputs.
+        #
+        # `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+        # transcription.
         def include=: (
           ::Array[OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest::include_]
         ) -> ::Array[OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest::include_]
 
+        # @param audio
+        #   Configuration for input and output audio.
+        # @param include
+        #   Additional fields to include in server outputs.
+        #
+        #   `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+        #   transcription.
+        # @param type
+        #   The type of session to create. Always `transcription` for transcription
+        #   sessions.
         def initialize: (
           ?audio: OpenAI::Realtime::RealtimeTranscriptionSessionAudio,
           ?include: ::Array[OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest::include_],

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

@@ -14,28 +14,58 @@ module OpenAI
         }
 
       class RealtimeTranscriptionSessionCreateResponse < OpenAI::Internal::Type::BaseModel
+        # Unique identifier for the session that looks like `sess_1234567890abcdef`.
         attr_accessor id: String
 
+        # The object type. Always `realtime.transcription_session`.
         attr_accessor object: String
 
+        # The type of session. Always `transcription` for transcription sessions.
         attr_accessor type: :transcription
 
+        # Configuration for input audio for the session.
         attr_reader audio: OpenAI::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio?
 
+        # Configuration for input audio for the session.
         def audio=: (
           OpenAI::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio
         ) -> OpenAI::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio
 
+        # Expiration timestamp for the session, in seconds since epoch.
         attr_reader expires_at: Integer?
 
+        # Expiration timestamp for the session, in seconds since epoch.
         def expires_at=: (Integer) -> Integer
 
+        # Additional fields to include in server outputs.
+        #
+        # - `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+        #   transcription.
         attr_reader include: ::Array[OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::include_]?
 
+        # Additional fields to include in server outputs.
+        #
+        # - `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+        #   transcription.
         def include=: (
           ::Array[OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::include_]
         ) -> ::Array[OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse::include_]
 
+        # @param id
+        #   Unique identifier for the session that looks like `sess_1234567890abcdef`.
+        # @param object
+        #   The object type. Always `realtime.transcription_session`.
+        # @param audio
+        #   Configuration for input audio for the session.
+        # @param expires_at
+        #   Expiration timestamp for the session, in seconds since epoch.
+        # @param include
+        #   Additional fields to include in server outputs.
+        #
+        #   - `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+        #     transcription.
+        # @param type
+        #   The type of session. Always `transcription` for transcription sessions.
         def initialize: (
           id: String,
           object: String,
@@ -83,14 +113,18 @@ module OpenAI
             }
 
           class Input < OpenAI::Internal::Type::BaseModel
+            # The PCM audio format. Only a 24kHz sample rate is supported.
             attr_reader format_: OpenAI::Models::Realtime::realtime_audio_formats?
 
+            # The PCM audio format. Only a 24kHz sample rate is supported.
             def format_=: (
               OpenAI::Models::Realtime::realtime_audio_formats
             ) -> OpenAI::Models::Realtime::realtime_audio_formats
 
+            # Configuration for input audio noise reduction.
             attr_reader noise_reduction: OpenAI::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction?
 
+            # Configuration for input audio noise reduction.
             def noise_reduction=: (
               OpenAI::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction
             ) -> OpenAI::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction
@@ -101,8 +135,21 @@ module OpenAI
               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. For `gpt-realtime-whisper`, this
+            # must be `null`; VAD is not supported.
             attr_accessor turn_detection: OpenAI::Realtime::RealtimeTranscriptionSessionTurnDetection?
 
+            # @param format_
+            #   The PCM audio format. Only a 24kHz sample rate is supported.
+            # @param noise_reduction
+            #   Configuration for input audio noise reduction.
+            # @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. For `gpt-realtime-whisper`, this
+            #   must be `null`; VAD is not supported.
             def initialize: (
               ?format_: OpenAI::Models::Realtime::realtime_audio_formats,
               ?noise_reduction: OpenAI::Realtime::RealtimeTranscriptionSessionCreateResponse::Audio::Input::NoiseReduction,
@@ -121,12 +168,22 @@ module OpenAI
               { ?type: OpenAI::Models::Realtime::noise_reduction_type }
 
             class NoiseReduction < 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

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

@@ -12,22 +12,53 @@ module OpenAI
         }
 
       class RealtimeTranscriptionSessionTurnDetection < 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/realtime/realtime_translation_client_secret_create_request.rbs

@@ -8,14 +8,32 @@ module OpenAI
         }
 
       class RealtimeTranslationClientSecretCreateRequest < OpenAI::Internal::Type::BaseModel
+        # Realtime translation session configuration. Translation sessions stream source
+        # audio in and translated audio plus transcript deltas out continuously.
         attr_accessor session: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest
 
+        # 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.
         attr_reader expires_after: OpenAI::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter?
 
+        # Configuration for the client secret expiration. Expiration refers to the time
+        # after which a client secret will no longer be valid for creating sessions. The
+        # session itself may continue after that time once started. A secret can be used
+        # to create multiple sessions until it expires.
         def expires_after=: (
           OpenAI::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter
         ) -> OpenAI::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter
 
+        # @param session
+        #   Realtime translation session configuration. Translation sessions stream source
+        #   audio in and translated audio plus transcript deltas out continuously.
+        # @param expires_after
+        #   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.
         def initialize: (
           session: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest,
           ?expires_after: OpenAI::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter
@@ -33,16 +51,36 @@ module OpenAI
           }
 
         class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+          # 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.
           attr_reader anchor: OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter::anchor?
 
+          # The anchor point for the client secret expiration, meaning that `seconds` will
+          # be added to the `created_at` time of the client secret to produce an expiration
+          # timestamp. Only `created_at` is currently supported.
           def anchor=: (
             OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter::anchor
           ) -> OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter::anchor
 
+          # 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.
           attr_reader 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.
           def seconds=: (Integer) -> Integer
 
+          # @param 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
+          #   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.
           def initialize: (
             ?anchor: OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter::anchor,
             ?seconds: Integer

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

@@ -9,12 +9,23 @@ module OpenAI
         }
 
       class RealtimeTranslationClientSecretCreateResponse < OpenAI::Internal::Type::BaseModel
+        # Expiration timestamp for the client secret, in seconds since epoch.
         attr_accessor expires_at: Integer
 
+        # A Realtime translation session. Translation sessions continuously translate
+        # input audio into the configured output language.
         attr_accessor session: OpenAI::Realtime::RealtimeTranslationSession
 
+        # The generated client secret value.
         attr_accessor value: String
 
+        # @param expires_at
+        #   Expiration timestamp for the client secret, in seconds since epoch.
+        # @param session
+        #   A Realtime translation session. Translation sessions continuously translate
+        #   input audio into the configured output language.
+        # @param value
+        #   The generated client secret value.
         def initialize: (
           expires_at: Integer,
           session: OpenAI::Realtime::RealtimeTranslationSession,

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

@@ -9,14 +9,24 @@ module OpenAI
         }
 
       class RealtimeTranslationInputAudioBufferAppendEvent < OpenAI::Internal::Type::BaseModel
+        # Base64-encoded 24 kHz PCM16 mono audio bytes.
         attr_accessor audio: String
 
+        # The event type, must be `session.input_audio_buffer.append`.
         attr_accessor type: :"session.input_audio_buffer.append"
 
+        # 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 audio
+        #   Base64-encoded 24 kHz PCM16 mono audio bytes.
+        # @param event_id
+        #   Optional client-generated ID used to identify this event.
+        # @param type
+        #   The event type, must be `session.input_audio_buffer.append`.
         def initialize: (
           audio: String,
           ?event_id: String,

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

@@ -10,14 +10,32 @@ module OpenAI
         }
 
       class RealtimeTranslationInputTranscriptDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # Append-only source-language transcript text.
         attr_accessor delta: String
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The event type, must be `session.input_transcript.delta`.
         attr_accessor type: :"session.input_transcript.delta"
 
+        # Timing metadata for stream alignment, derived from the translation frame when
+        # available. It advances in 200 ms increments, but multiple transcript deltas may
+        # share the same `elapsed_ms`. Treat it as alignment metadata, not a unique
+        # transcript-delta identifier.
         attr_accessor elapsed_ms: Integer?
 
+        # @param delta
+        #   Append-only source-language transcript text.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param elapsed_ms
+        #   Timing metadata for stream alignment, derived from the translation frame when
+        #   available. It advances in 200 ms increments, but multiple transcript deltas may
+        #   share the same `elapsed_ms`. Treat it as alignment metadata, not a unique
+        #   transcript-delta identifier.
+        # @param type
+        #   The event type, must be `session.input_transcript.delta`.
         def initialize: (
           delta: String,
           event_id: String,

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

@@ -13,28 +13,56 @@ module OpenAI
         }
 
       class RealtimeTranslationOutputAudioDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # Base64-encoded translated audio data.
         attr_accessor delta: String
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The event type, must be `session.output_audio.delta`.
         attr_accessor type: :"session.output_audio.delta"
 
+        # Number of audio channels.
         attr_reader channels: Integer?
 
+        # Number of audio channels.
         def channels=: (Integer) -> Integer
 
+        # Timing metadata for stream alignment, derived from the translation frame when
+        # available. Treat `elapsed_ms` as alignment metadata, not a unique event
+        # identifier.
         attr_accessor elapsed_ms: Integer?
 
+        # Audio encoding for `delta`.
         attr_reader format_: OpenAI::Models::Realtime::RealtimeTranslationOutputAudioDeltaEvent::format_?
 
+        # Audio encoding for `delta`.
         def format_=: (
           OpenAI::Models::Realtime::RealtimeTranslationOutputAudioDeltaEvent::format_
         ) -> OpenAI::Models::Realtime::RealtimeTranslationOutputAudioDeltaEvent::format_
 
+        # Sample rate of the audio delta.
         attr_reader sample_rate: Integer?
 
+        # Sample rate of the audio delta.
         def sample_rate=: (Integer) -> Integer
 
+        # @param delta
+        #   Base64-encoded translated audio data.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param channels
+        #   Number of audio channels.
+        # @param elapsed_ms
+        #   Timing metadata for stream alignment, derived from the translation frame when
+        #   available. Treat `elapsed_ms` as alignment metadata, not a unique event
+        #   identifier.
+        # @param format_
+        #   Audio encoding for `delta`.
+        # @param sample_rate
+        #   Sample rate of the audio delta.
+        # @param type
+        #   The event type, must be `session.output_audio.delta`.
         def initialize: (
           delta: String,
           event_id: String,

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

@@ -10,14 +10,32 @@ module OpenAI
         }
 
       class RealtimeTranslationOutputTranscriptDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # Append-only transcript text for the translated output audio.
         attr_accessor delta: String
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The event type, must be `session.output_transcript.delta`.
         attr_accessor type: :"session.output_transcript.delta"
 
+        # Timing metadata for stream alignment, derived from the translation frame when
+        # available. It advances in 200 ms increments, but multiple transcript deltas may
+        # share the same `elapsed_ms`. Treat it as alignment metadata, not a unique
+        # transcript-delta identifier.
         attr_accessor elapsed_ms: Integer?
 
+        # @param delta
+        #   Append-only transcript text for the translated output audio.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param elapsed_ms
+        #   Timing metadata for stream alignment, derived from the translation frame when
+        #   available. It advances in 200 ms increments, but multiple transcript deltas may
+        #   share the same `elapsed_ms`. Treat it as alignment metadata, not a unique
+        #   transcript-delta identifier.
+        # @param type
+        #   The event type, must be `session.output_transcript.delta`.
         def initialize: (
           delta: String,
           event_id: String,

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

@@ -11,16 +11,33 @@ module OpenAI
         }
 
       class RealtimeTranslationSession < OpenAI::Internal::Type::BaseModel
+        # Unique identifier for the session that looks like `sess_1234567890abcdef`.
         attr_accessor id: String
 
+        # Configuration for translation input and output audio.
         attr_accessor audio: OpenAI::Realtime::RealtimeTranslationSession::Audio
 
+        # Expiration timestamp for the session, in seconds since epoch.
         attr_accessor expires_at: Integer
 
+        # The Realtime translation model used for this session. This field is set at
+        # session creation and cannot be changed with `session.update`.
         attr_accessor model: String
 
+        # The session type. Always `translation` for Realtime translation sessions.
         attr_accessor type: :translation
 
+        # @param id
+        #   Unique identifier for the session that looks like `sess_1234567890abcdef`.
+        # @param audio
+        #   Configuration for translation input and output audio.
+        # @param expires_at
+        #   Expiration timestamp for the session, in seconds since epoch.
+        # @param model
+        #   The Realtime translation model used for this session. This field is set at
+        #   session creation and cannot be changed with `session.update`.
+        # @param type
+        #   The session type. Always `translation` for Realtime translation sessions.
         def initialize: (
           id: String,
           audio: OpenAI::Realtime::RealtimeTranslationSession::Audio,
@@ -73,10 +90,20 @@ module OpenAI
             }
 
           class Input < OpenAI::Internal::Type::BaseModel
+            # Optional input noise reduction.
             attr_accessor noise_reduction: OpenAI::Realtime::RealtimeTranslationSession::Audio::Input::NoiseReduction?
 
+            # Optional source-language transcription. When configured, the server emits
+            # `session.input_transcript.delta` events. Translation itself still runs from the
+            # input audio stream.
             attr_accessor transcription: OpenAI::Realtime::RealtimeTranslationSession::Audio::Input::Transcription?
 
+            # @param noise_reduction
+            #   Optional input noise reduction.
+            # @param transcription
+            #   Optional source-language transcription. When configured, the server emits
+            #   `session.input_transcript.delta` events. Translation itself still runs from the
+            #   input audio stream.
             def initialize: (
               ?noise_reduction: OpenAI::Realtime::RealtimeTranslationSession::Audio::Input::NoiseReduction?,
               ?transcription: OpenAI::Realtime::RealtimeTranslationSession::Audio::Input::Transcription?
@@ -91,8 +118,15 @@ module OpenAI
               { type: OpenAI::Models::Realtime::noise_reduction_type }
 
             class NoiseReduction < 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_accessor 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
@@ -105,8 +139,11 @@ module OpenAI
             type transcription = { model: String }
 
             class Transcription < OpenAI::Internal::Type::BaseModel
+              # The transcription model used for source transcript deltas.
               attr_accessor model: String
 
+              # @param model
+              #   The transcription model used for source transcript deltas.
               def initialize: (model: String) -> void
 
               def to_hash: -> { model: String }
@@ -116,10 +153,14 @@ module OpenAI
           type output = { ?language: String }
 
           class Output < OpenAI::Internal::Type::BaseModel
+            # Target language for translated output audio and transcript deltas.
             attr_reader language: String?
 
+            # Target language for translated output audio and transcript deltas.
             def language=: (String) -> String
 
+            # @param language
+            #   Target language for translated output audio and transcript deltas.
             def initialize: (?language: String) -> void
 
             def to_hash: -> { ?language: String }

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

@@ -5,12 +5,19 @@ module OpenAI
         { ?type: :"session.close", ?event_id: String }
 
       class RealtimeTranslationSessionCloseEvent < OpenAI::Internal::Type::BaseModel
+        # The event type, must be `session.close`.
         attr_accessor type: :"session.close"
 
+        # 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 event_id
+        #   Optional client-generated ID used to identify this event.
+        # @param type
+        #   The event type, must be `session.close`.
         def initialize: (?event_id: String, ?type: :"session.close") -> void
 
         def to_hash: -> { ?type: :"session.close", ?event_id: String }

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

@@ -5,10 +5,16 @@ module OpenAI
         { event_id: String, ?type: :"session.closed" }
 
       class RealtimeTranslationSessionClosedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The event type, must be `session.closed`.
         attr_accessor type: :"session.closed"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param type
+        #   The event type, must be `session.closed`.
         def initialize: (event_id: String, ?type: :"session.closed") -> void
 
         def to_hash: -> { event_id: String, ?type: :"session.closed" }