openai 0.92.0 → 0.93.0

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

@@ -8,14 +8,21 @@ module OpenAI
         }
 
       class RealtimeTranslationSessionCreateRequest < OpenAI::Internal::Type::BaseModel
+        # The Realtime translation model used for this session.
         attr_accessor model: String
 
+        # Configuration for translation input and output audio.
         attr_reader audio: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest::Audio?
 
+        # Configuration for translation input and output audio.
         def audio=: (
           OpenAI::Realtime::RealtimeTranslationSessionCreateRequest::Audio
         ) -> OpenAI::Realtime::RealtimeTranslationSessionCreateRequest::Audio
 
+        # @param model
+        #   The Realtime translation model used for this session.
+        # @param audio
+        #   Configuration for translation input and output audio.
         def initialize: (
           model: String,
           ?audio: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest::Audio
@@ -62,10 +69,20 @@ module OpenAI
             }
 
           class Input < OpenAI::Internal::Type::BaseModel
+            # Optional input noise reduction. Set to `null` to disable it.
             attr_accessor noise_reduction: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest::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::RealtimeTranslationSessionCreateRequest::Audio::Input::Transcription?
 
+            # @param noise_reduction
+            #   Optional input noise reduction. Set to `null` to disable it.
+            # @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::RealtimeTranslationSessionCreateRequest::Audio::Input::NoiseReduction?,
               ?transcription: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest::Audio::Input::Transcription?
@@ -80,8 +97,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
@@ -94,8 +118,11 @@ module OpenAI
             type transcription = { model: String }
 
             class Transcription < OpenAI::Internal::Type::BaseModel
+              # The transcription model to use for source transcript deltas.
               attr_accessor model: String
 
+              # @param model
+              #   The transcription model to use for source transcript deltas.
               def initialize: (model: String) -> void
 
               def to_hash: -> { model: String }
@@ -105,10 +132,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_created_event.rbs

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class RealtimeTranslationSessionCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The translation session configuration.
         attr_accessor session: OpenAI::Realtime::RealtimeTranslationSession
 
+        # The event type, must be `session.created`.
         attr_accessor type: :"session.created"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param session
+        #   The translation session configuration.
+        # @param type
+        #   The event type, must be `session.created`.
         def initialize: (
           event_id: String,
           session: OpenAI::Realtime::RealtimeTranslationSession,

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

@@ -9,14 +9,26 @@ module OpenAI
         }
 
       class RealtimeTranslationSessionUpdateEvent < OpenAI::Internal::Type::BaseModel
+        # Translation session fields to update. The session `type` and `model` are set at
+        # creation and cannot be changed with `session.update`.
         attr_accessor session: OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest
 
+        # The event type, must be `session.update`.
         attr_accessor type: :"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
+        #   Translation session fields to update. The session `type` and `model` are set at
+        #   creation and cannot be changed with `session.update`.
+        # @param event_id
+        #   Optional client-generated ID used to identify this event.
+        # @param type
+        #   The event type, must be `session.update`.
         def initialize: (
           session: OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest,
           ?event_id: String,

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

@@ -7,12 +7,16 @@ module OpenAI
         }
 
       class RealtimeTranslationSessionUpdateRequest < OpenAI::Internal::Type::BaseModel
+        # Configuration for translation input and output audio.
         attr_reader audio: OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio?
 
+        # Configuration for translation input and output audio.
         def audio=: (
           OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio
         ) -> OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio
 
+        # @param audio
+        #   Configuration for translation input and output audio.
         def initialize: (
           ?audio: OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio
         ) -> void
@@ -57,10 +61,20 @@ module OpenAI
             }
 
           class Input < OpenAI::Internal::Type::BaseModel
+            # Optional input noise reduction. Set to `null` to disable it.
             attr_accessor noise_reduction: OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::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::RealtimeTranslationSessionUpdateRequest::Audio::Input::Transcription?
 
+            # @param noise_reduction
+            #   Optional input noise reduction. Set to `null` to disable it.
+            # @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::RealtimeTranslationSessionUpdateRequest::Audio::Input::NoiseReduction?,
               ?transcription: OpenAI::Realtime::RealtimeTranslationSessionUpdateRequest::Audio::Input::Transcription?
@@ -75,8 +89,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
@@ -89,8 +110,11 @@ module OpenAI
             type transcription = { model: String }
 
             class Transcription < OpenAI::Internal::Type::BaseModel
+              # The transcription model to use for source transcript deltas.
               attr_accessor model: String
 
+              # @param model
+              #   The transcription model to use for source transcript deltas.
               def initialize: (model: String) -> void
 
               def to_hash: -> { model: String }
@@ -100,10 +124,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_updated_event.rbs

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class RealtimeTranslationSessionUpdatedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The translation session configuration.
         attr_accessor session: OpenAI::Realtime::RealtimeTranslationSession
 
+        # The event type, must be `session.updated`.
         attr_accessor type: :"session.updated"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param session
+        #   The translation session configuration.
+        # @param type
+        #   The event type, must be `session.updated`.
         def initialize: (
           event_id: String,
           session: OpenAI::Realtime::RealtimeTranslationSession,

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

@@ -9,16 +9,35 @@ module OpenAI
         }
 
       class RealtimeTruncationRetentionRatio < OpenAI::Internal::Type::BaseModel
+        # Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when
+        # the conversation exceeds the input token limit. Setting this to `0.8` means that
+        # messages will be dropped until 80% of the maximum allowed tokens are used. This
+        # helps reduce the frequency of truncations and improve cache rates.
         attr_accessor retention_ratio: Float
 
+        # Use retention ratio truncation.
         attr_accessor type: :retention_ratio
 
+        # Optional custom token limits for this truncation strategy. If not provided, the
+        # model's default token limits will be used.
         attr_reader token_limits: OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits?
 
+        # Optional custom token limits for this truncation strategy. If not provided, the
+        # model's default token limits will be used.
         def token_limits=: (
           OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits
         ) -> OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits
 
+        # @param retention_ratio
+        #   Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when
+        #   the conversation exceeds the input token limit. Setting this to `0.8` means that
+        #   messages will be dropped until 80% of the maximum allowed tokens are used. This
+        #   helps reduce the frequency of truncations and improve cache rates.
+        # @param token_limits
+        #   Optional custom token limits for this truncation strategy. If not provided, the
+        #   model's default token limits will be used.
+        # @param type
+        #   Use retention ratio truncation.
         def initialize: (
           retention_ratio: Float,
           ?token_limits: OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits,
@@ -34,10 +53,26 @@ module OpenAI
         type token_limits = { ?post_instructions: Integer }
 
         class TokenLimits < OpenAI::Internal::Type::BaseModel
+          # Maximum tokens allowed in the conversation after instructions (which including
+          # tool definitions). For example, setting this to 5,000 would mean that truncation
+          # would occur when the conversation exceeds 5,000 tokens after instructions. This
+          # cannot be higher than the model's context window size minus the maximum output
+          # tokens.
           attr_reader post_instructions: Integer?
 
+          # Maximum tokens allowed in the conversation after instructions (which including
+          # tool definitions). For example, setting this to 5,000 would mean that truncation
+          # would occur when the conversation exceeds 5,000 tokens after instructions. This
+          # cannot be higher than the model's context window size minus the maximum output
+          # tokens.
           def post_instructions=: (Integer) -> Integer
 
+          # @param post_instructions
+          #   Maximum tokens allowed in the conversation after instructions (which including
+          #   tool definitions). For example, setting this to 5,000 would mean that truncation
+          #   would occur when the conversation exceeds 5,000 tokens after instructions. This
+          #   cannot be higher than the model's context window size minus the maximum output
+          #   tokens.
           def initialize: (?post_instructions: Integer) -> void
 
           def to_hash: -> { ?post_instructions: Integer }

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseAudioDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the item's content array.
         attr_accessor content_index: Integer
 
+        # Base64-encoded audio data delta.
         attr_accessor delta: String
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response.
         attr_accessor output_index: Integer
 
+        # The ID of the response.
         attr_accessor response_id: String
 
+        # The event type, must be `response.output_audio.delta`.
         attr_accessor type: :"response.output_audio.delta"
 
+        # @param content_index
+        #   The index of the content part in the item's content array.
+        # @param delta
+        #   Base64-encoded audio data delta.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item.
+        # @param output_index
+        #   The index of the output item in the response.
+        # @param response_id
+        #   The ID of the response.
+        # @param type
+        #   The event type, must be `response.output_audio.delta`.
         def initialize: (
           content_index: Integer,
           delta: String,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseAudioDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the item's content array.
         attr_accessor content_index: Integer
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response.
         attr_accessor output_index: Integer
 
+        # The ID of the response.
         attr_accessor response_id: String
 
+        # The event type, must be `response.output_audio.done`.
         attr_accessor type: :"response.output_audio.done"
 
+        # @param content_index
+        #   The index of the content part in the item's content array.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item.
+        # @param output_index
+        #   The index of the output item in the response.
+        # @param response_id
+        #   The ID of the response.
+        # @param type
+        #   The event type, must be `response.output_audio.done`.
         def initialize: (
           content_index: Integer,
           event_id: String,

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseAudioTranscriptDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the item's content array.
         attr_accessor content_index: Integer
 
+        # The transcript delta.
         attr_accessor delta: String
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response.
         attr_accessor output_index: Integer
 
+        # The ID of the response.
         attr_accessor response_id: String
 
+        # The event type, must be `response.output_audio_transcript.delta`.
         attr_accessor type: :"response.output_audio_transcript.delta"
 
+        # @param content_index
+        #   The index of the content part in the item's content array.
+        # @param delta
+        #   The transcript delta.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item.
+        # @param output_index
+        #   The index of the output item in the response.
+        # @param response_id
+        #   The ID of the response.
+        # @param type
+        #   The event type, must be `response.output_audio_transcript.delta`.
         def initialize: (
           content_index: Integer,
           delta: String,

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseAudioTranscriptDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the item's content array.
         attr_accessor content_index: Integer
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response.
         attr_accessor output_index: Integer
 
+        # The ID of the response.
         attr_accessor response_id: String
 
+        # The final transcript of the audio.
         attr_accessor transcript: String
 
+        # The event type, must be `response.output_audio_transcript.done`.
         attr_accessor type: :"response.output_audio_transcript.done"
 
+        # @param content_index
+        #   The index of the content part in the item's content array.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item.
+        # @param output_index
+        #   The index of the output item in the response.
+        # @param response_id
+        #   The ID of the response.
+        # @param transcript
+        #   The final transcript of the audio.
+        # @param type
+        #   The event type, must be `response.output_audio_transcript.done`.
         def initialize: (
           content_index: Integer,
           event_id: String,

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

@@ -5,16 +5,30 @@ module OpenAI
         { ?type: :"response.cancel", ?event_id: String, ?response_id: String }
 
       class ResponseCancelEvent < OpenAI::Internal::Type::BaseModel
+        # The event type, must be `response.cancel`.
         attr_accessor type: :"response.cancel"
 
+        # 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
 
+        # A specific response ID to cancel - if not provided, will cancel an in-progress
+        # response in the default conversation.
         attr_reader response_id: String?
 
+        # A specific response ID to cancel - if not provided, will cancel an in-progress
+        # response in the default conversation.
         def response_id=: (String) -> String
 
+        # @param event_id
+        #   Optional client-generated ID used to identify this event.
+        # @param response_id
+        #   A specific response ID to cancel - if not provided, will cancel an in-progress
+        #   response in the default conversation.
+        # @param type
+        #   The event type, must be `response.cancel`.
         def initialize: (
           ?event_id: String,
           ?response_id: String,

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseContentPartAddedEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the item's content array.
         attr_accessor content_index: Integer
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item to which the content part was added.
         attr_accessor item_id: String
 
+        # The index of the output item in the response.
         attr_accessor output_index: Integer
 
+        # The content part that was added.
         attr_accessor part: OpenAI::Realtime::ResponseContentPartAddedEvent::Part
 
+        # The ID of the response.
         attr_accessor response_id: String
 
+        # The event type, must be `response.content_part.added`.
         attr_accessor type: :"response.content_part.added"
 
+        # @param content_index
+        #   The index of the content part in the item's content array.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item to which the content part was added.
+        # @param output_index
+        #   The index of the output item in the response.
+        # @param part
+        #   The content part that was added.
+        # @param response_id
+        #   The ID of the response.
+        # @param type
+        #   The event type, must be `response.content_part.added`.
         def initialize: (
           content_index: Integer,
           event_id: String,
@@ -56,24 +77,40 @@ module OpenAI
           }
 
         class Part < OpenAI::Internal::Type::BaseModel
+          # Base64-encoded audio data (if type is "audio").
           attr_reader audio: String?
 
+          # Base64-encoded audio data (if type is "audio").
           def audio=: (String) -> String
 
+          # The text content (if type is "text").
           attr_reader text: String?
 
+          # The text content (if type is "text").
           def text=: (String) -> String
 
+          # The transcript of the audio (if type is "audio").
           attr_reader transcript: String?
 
+          # The transcript of the audio (if type is "audio").
           def transcript=: (String) -> String
 
+          # The content type ("text", "audio").
           attr_reader type: OpenAI::Models::Realtime::ResponseContentPartAddedEvent::Part::type_?
 
+          # The content type ("text", "audio").
           def type=: (
             OpenAI::Models::Realtime::ResponseContentPartAddedEvent::Part::type_
           ) -> OpenAI::Models::Realtime::ResponseContentPartAddedEvent::Part::type_
 
+          # @param audio
+          #   Base64-encoded audio data (if type is "audio").
+          # @param text
+          #   The text content (if type is "text").
+          # @param transcript
+          #   The transcript of the audio (if type is "audio").
+          # @param type
+          #   The content type ("text", "audio").
           def initialize: (
             ?audio: String,
             ?text: String,

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseContentPartDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the item's content array.
         attr_accessor content_index: Integer
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response.
         attr_accessor output_index: Integer
 
+        # The content part that is done.
         attr_accessor part: OpenAI::Realtime::ResponseContentPartDoneEvent::Part
 
+        # The ID of the response.
         attr_accessor response_id: String
 
+        # The event type, must be `response.content_part.done`.
         attr_accessor type: :"response.content_part.done"
 
+        # @param content_index
+        #   The index of the content part in the item's content array.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item.
+        # @param output_index
+        #   The index of the output item in the response.
+        # @param part
+        #   The content part that is done.
+        # @param response_id
+        #   The ID of the response.
+        # @param type
+        #   The event type, must be `response.content_part.done`.
         def initialize: (
           content_index: Integer,
           event_id: String,
@@ -56,24 +77,40 @@ module OpenAI
           }
 
         class Part < OpenAI::Internal::Type::BaseModel
+          # Base64-encoded audio data (if type is "audio").
           attr_reader audio: String?
 
+          # Base64-encoded audio data (if type is "audio").
           def audio=: (String) -> String
 
+          # The text content (if type is "text").
           attr_reader text: String?
 
+          # The text content (if type is "text").
           def text=: (String) -> String
 
+          # The transcript of the audio (if type is "audio").
           attr_reader transcript: String?
 
+          # The transcript of the audio (if type is "audio").
           def transcript=: (String) -> String
 
+          # The content type ("text", "audio").
           attr_reader type: OpenAI::Models::Realtime::ResponseContentPartDoneEvent::Part::type_?
 
+          # The content type ("text", "audio").
           def type=: (
             OpenAI::Models::Realtime::ResponseContentPartDoneEvent::Part::type_
           ) -> OpenAI::Models::Realtime::ResponseContentPartDoneEvent::Part::type_
 
+          # @param audio
+          #   Base64-encoded audio data (if type is "audio").
+          # @param text
+          #   The text content (if type is "text").
+          # @param transcript
+          #   The transcript of the audio (if type is "audio").
+          # @param type
+          #   The content type ("text", "audio").
           def initialize: (
             ?audio: String,
             ?text: String,