openai 0.91.0 → 0.93.0

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

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

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

@@ -12,14 +12,21 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
+        # WebRTC Session Description Protocol (SDP) offer generated by the caller.
         attr_accessor sdp: String
 
+        # Realtime session object configuration.
         attr_reader session: OpenAI::Realtime::RealtimeSessionCreateRequest?
 
+        # Realtime session object configuration.
         def session=: (
           OpenAI::Realtime::RealtimeSessionCreateRequest
         ) -> OpenAI::Realtime::RealtimeSessionCreateRequest
 
+        # @param sdp
+        #   WebRTC Session Description Protocol (SDP) offer generated by the caller.
+        # @param session
+        #   Realtime session object configuration.
         def initialize: (
           sdp: String,
           ?session: OpenAI::Realtime::RealtimeSessionCreateRequest,

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

@@ -14,8 +14,13 @@ module OpenAI
 
         attr_accessor call_id: String
 
+        # URI that should appear in the SIP Refer-To header. Supports values like
+        # `tel:+14155550123` or `sip:agent@example.com`.
         attr_accessor target_uri: String
 
+        # @param target_uri
+        #   URI that should appear in the SIP Refer-To header. Supports values like
+        #   `tel:+14155550123` or `sip:agent@example.com`.
         def initialize: (
           call_id: String,
           target_uri: String,

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

@@ -14,10 +14,17 @@ module OpenAI
 
         attr_accessor call_id: String
 
+        # SIP response code to send back to the caller. Defaults to `603` (Decline) when
+        # omitted.
         attr_reader status_code: Integer?
 
+        # SIP response code to send back to the caller. Defaults to `603` (Decline) when
+        # omitted.
         def status_code=: (Integer) -> Integer
 
+        # @param status_code
+        #   SIP response code to send back to the caller. Defaults to `603` (Decline) when
+        #   omitted.
         def initialize: (
           call_id: String,
           ?status_code: Integer,

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

@@ -12,18 +12,38 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
+        # 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::ClientSecretCreateParams::ExpiresAfter?
 
+        # Configuration for the client secret expiration. Expiration refers to the time
+        # after which a client secret will no longer be valid for creating sessions. The
+        # session itself may continue after that time once started. A secret can be used
+        # to create multiple sessions until it expires.
         def expires_after=: (
           OpenAI::Realtime::ClientSecretCreateParams::ExpiresAfter
         ) -> OpenAI::Realtime::ClientSecretCreateParams::ExpiresAfter
 
+        # Session configuration to use for the client secret. Choose either a realtime
+        # session or a transcription session.
         attr_reader session: OpenAI::Models::Realtime::ClientSecretCreateParams::session?
 
+        # Session configuration to use for the client secret. Choose either a realtime
+        # session or a transcription session.
         def session=: (
           OpenAI::Models::Realtime::ClientSecretCreateParams::session
         ) -> OpenAI::Models::Realtime::ClientSecretCreateParams::session
 
+        # @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.
+        # @param session
+        #   Session configuration to use for the client secret. Choose either a realtime
+        #   session or a transcription session.
         def initialize: (
           ?expires_after: OpenAI::Realtime::ClientSecretCreateParams::ExpiresAfter,
           ?session: OpenAI::Models::Realtime::ClientSecretCreateParams::session,
@@ -43,16 +63,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::ClientSecretCreateParams::ExpiresAfter::anchor?
 
+          # The anchor point for the client secret expiration, meaning that `seconds` will
+          # be added to the `created_at` time of the client secret to produce an expiration
+          # timestamp. Only `created_at` is currently supported.
           def anchor=: (
             OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter::anchor
           ) -> OpenAI::Models::Realtime::ClientSecretCreateParams::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::ClientSecretCreateParams::ExpiresAfter::anchor,
             ?seconds: Integer

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

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ClientSecretCreateResponse < OpenAI::Internal::Type::BaseModel
+        # Expiration timestamp for the client secret, in seconds since epoch.
         attr_accessor expires_at: Integer
 
+        # The session configuration for either a realtime or transcription session.
         attr_accessor session: OpenAI::Models::Realtime::ClientSecretCreateResponse::session
 
+        # The generated client secret value.
         attr_accessor value: String
 
+        # @param expires_at
+        #   Expiration timestamp for the client secret, in seconds since epoch.
+        # @param session
+        #   The session configuration for either a realtime or transcription session.
+        # @param value
+        #   The generated client secret value.
         def initialize: (
           expires_at: Integer,
           session: OpenAI::Models::Realtime::ClientSecretCreateResponse::session,

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

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ConversationCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # The conversation resource.
         attr_accessor conversation: OpenAI::Realtime::ConversationCreatedEvent::Conversation
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The event type, must be `conversation.created`.
         attr_accessor type: :"conversation.created"
 
+        # @param conversation
+        #   The conversation resource.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param type
+        #   The event type, must be `conversation.created`.
         def initialize: (
           conversation: OpenAI::Realtime::ConversationCreatedEvent::Conversation,
           event_id: String,
@@ -34,16 +43,24 @@ module OpenAI
           }
 
         class Conversation < OpenAI::Internal::Type::BaseModel
+          # The unique ID of the conversation.
           attr_reader id: String?
 
+          # The unique ID of the conversation.
           def id=: (String) -> String
 
+          # The object type, must be `realtime.conversation`.
           attr_reader object: OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation::object?
 
+          # The object type, must be `realtime.conversation`.
           def object=: (
             OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation::object
           ) -> OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation::object
 
+          # @param id
+          #   The unique ID of the conversation.
+          # @param object
+          #   The object type, must be `realtime.conversation`.
           def initialize: (
             ?id: String,
             ?object: OpenAI::Models::Realtime::ConversationCreatedEvent::Conversation::object

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

@@ -10,14 +10,28 @@ module OpenAI
         }
 
       class ConversationItemAdded < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # A single item within a Realtime conversation.
         attr_accessor item: OpenAI::Models::Realtime::conversation_item
 
+        # The event type, must be `conversation.item.added`.
         attr_accessor type: :"conversation.item.added"
 
+        # The ID of the item that precedes this one, if any. This is used to maintain
+        # ordering when items are inserted.
         attr_accessor previous_item_id: String?
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item
+        #   A single item within a Realtime conversation.
+        # @param previous_item_id
+        #   The ID of the item that precedes this one, if any. This is used to maintain
+        #   ordering when items are inserted.
+        # @param type
+        #   The event type, must be `conversation.item.added`.
         def initialize: (
           event_id: String,
           item: OpenAI::Models::Realtime::conversation_item,

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

@@ -10,18 +10,56 @@ module OpenAI
         }
 
       class ConversationItemCreateEvent < OpenAI::Internal::Type::BaseModel
+        # A single item within a Realtime conversation.
         attr_accessor item: OpenAI::Models::Realtime::conversation_item
 
+        # The event type, must be `conversation.item.create`.
         attr_accessor type: :"conversation.item.create"
 
+        # 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
 
+        # The ID of the preceding item after which the new item will be inserted. If not
+        # set, the new item will be appended to the end of the conversation.
+        #
+        # If set to `root`, the new item will be added to the beginning of the
+        # conversation.
+        #
+        # If set to an existing ID, it allows an item to be inserted mid-conversation. If
+        # the ID cannot be found, an error will be returned and the item will not be
+        # added.
         attr_reader previous_item_id: String?
 
+        # The ID of the preceding item after which the new item will be inserted. If not
+        # set, the new item will be appended to the end of the conversation.
+        #
+        # If set to `root`, the new item will be added to the beginning of the
+        # conversation.
+        #
+        # If set to an existing ID, it allows an item to be inserted mid-conversation. If
+        # the ID cannot be found, an error will be returned and the item will not be
+        # added.
         def previous_item_id=: (String) -> String
 
+        # @param item
+        #   A single item within a Realtime conversation.
+        # @param event_id
+        #   Optional client-generated ID used to identify this event.
+        # @param previous_item_id
+        #   The ID of the preceding item after which the new item will be inserted. If not
+        #   set, the new item will be appended to the end of the conversation.
+        #
+        #   If set to `root`, the new item will be added to the beginning of the
+        #   conversation.
+        #
+        #   If set to an existing ID, it allows an item to be inserted mid-conversation. If
+        #   the ID cannot be found, an error will be returned and the item will not be
+        #   added.
+        # @param type
+        #   The event type, must be `conversation.item.create`.
         def initialize: (
           item: OpenAI::Models::Realtime::conversation_item,
           ?event_id: String,

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

@@ -10,14 +10,30 @@ module OpenAI
         }
 
       class ConversationItemCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # A single item within a Realtime conversation.
         attr_accessor item: OpenAI::Models::Realtime::conversation_item
 
+        # The event type, must be `conversation.item.created`.
         attr_accessor type: :"conversation.item.created"
 
+        # The ID of the preceding item in the Conversation context, allows the client to
+        # understand the order of the conversation. Can be `null` if the item has no
+        # predecessor.
         attr_accessor previous_item_id: String?
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item
+        #   A single item within a Realtime conversation.
+        # @param previous_item_id
+        #   The ID of the preceding item in the Conversation context, allows the client to
+        #   understand the order of the conversation. Can be `null` if the item has no
+        #   predecessor.
+        # @param type
+        #   The event type, must be `conversation.item.created`.
         def initialize: (
           event_id: String,
           item: OpenAI::Models::Realtime::conversation_item,

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

@@ -9,14 +9,24 @@ module OpenAI
         }
 
       class ConversationItemDeleteEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the item to delete.
         attr_accessor item_id: String
 
+        # The event type, must be `conversation.item.delete`.
         attr_accessor type: :"conversation.item.delete"
 
+        # 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 item_id
+        #   The ID of the item to delete.
+        # @param event_id
+        #   Optional client-generated ID used to identify this event.
+        # @param type
+        #   The event type, must be `conversation.item.delete`.
         def initialize: (
           item_id: String,
           ?event_id: String,

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

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ConversationItemDeletedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item that was deleted.
         attr_accessor item_id: String
 
+        # The event type, must be `conversation.item.deleted`.
         attr_accessor type: :"conversation.item.deleted"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item that was deleted.
+        # @param type
+        #   The event type, must be `conversation.item.deleted`.
         def initialize: (
           event_id: String,
           item_id: String,

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

@@ -10,14 +10,28 @@ module OpenAI
         }
 
       class ConversationItemDone < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # A single item within a Realtime conversation.
         attr_accessor item: OpenAI::Models::Realtime::conversation_item
 
+        # The event type, must be `conversation.item.done`.
         attr_accessor type: :"conversation.item.done"
 
+        # The ID of the item that precedes this one, if any. This is used to maintain
+        # ordering when items are inserted.
         attr_accessor previous_item_id: String?
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item
+        #   A single item within a Realtime conversation.
+        # @param previous_item_id
+        #   The ID of the item that precedes this one, if any. This is used to maintain
+        #   ordering when items are inserted.
+        # @param type
+        #   The event type, must be `conversation.item.done`.
         def initialize: (
           event_id: String,
           item: OpenAI::Models::Realtime::conversation_item,

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

@@ -14,26 +14,56 @@ module OpenAI
         }
 
       class ConversationItemInputAudioTranscriptionCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part containing the audio.
         attr_accessor content_index: Integer
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item containing the audio that is being transcribed.
         attr_accessor item_id: String
 
+        # The transcribed text.
         attr_accessor transcript: String
 
+        # The event type, must be `conversation.item.input_audio_transcription.completed`.
         attr_accessor type: :"conversation.item.input_audio_transcription.completed"
 
+        # Usage statistics for the transcription, this is billed according to the ASR
+        # model's pricing rather than the realtime model's pricing.
         attr_accessor usage: OpenAI::Models::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::usage
 
+        # The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        # array indicates that no language could be reliably detected.
         attr_reader languages: ::Array[OpenAI::Audio::TranscriptionLanguage]?
 
+        # The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        # array indicates that no language could be reliably detected.
         def languages=: (
           ::Array[OpenAI::Audio::TranscriptionLanguage]
         ) -> ::Array[OpenAI::Audio::TranscriptionLanguage]
 
+        # The log probabilities of the transcription.
         attr_accessor logprobs: ::Array[OpenAI::Realtime::LogProbProperties]?
 
+        # @param content_index
+        #   The index of the content part containing the audio.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item containing the audio that is being transcribed.
+        # @param transcript
+        #   The transcribed text.
+        # @param usage
+        #   Usage statistics for the transcription, this is billed according to the ASR
+        #   model's pricing rather than the realtime model's pricing.
+        # @param languages
+        #   The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        #   array indicates that no language could be reliably detected.
+        # @param logprobs
+        #   The log probabilities of the transcription.
+        # @param type
+        #   The event type, must be `conversation.item.input_audio_transcription.completed`.
         def initialize: (
           content_index: Integer,
           event_id: String,
@@ -73,20 +103,36 @@ module OpenAI
             }
 
           class TranscriptTextUsageTokens < OpenAI::Internal::Type::BaseModel
+            # Number of input tokens billed for this request.
             attr_accessor input_tokens: Integer
 
+            # Number of output tokens generated.
             attr_accessor output_tokens: Integer
 
+            # Total number of tokens used (input + output).
             attr_accessor total_tokens: Integer
 
+            # The type of the usage object. Always `tokens` for this variant.
             attr_accessor type: :tokens
 
+            # Details about the input tokens billed for this request.
             attr_reader input_token_details: OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails?
 
+            # Details about the input tokens billed for this request.
             def input_token_details=: (
               OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails
             ) -> OpenAI::Realtime::ConversationItemInputAudioTranscriptionCompletedEvent::Usage::TranscriptTextUsageTokens::InputTokenDetails
 
+            # @param input_tokens
+            #   Number of input tokens billed for this request.
+            # @param output_tokens
+            #   Number of output tokens generated.
+            # @param total_tokens
+            #   Total number of tokens used (input + output).
+            # @param input_token_details
+            #   Details about the input tokens billed for this request.
+            # @param type
+            #   The type of the usage object. Always `tokens` for this variant.
             def initialize: (
               input_tokens: Integer,
               output_tokens: Integer,
@@ -107,14 +153,22 @@ module OpenAI
               { ?audio_tokens: Integer, ?text_tokens: Integer }
 
             class InputTokenDetails < OpenAI::Internal::Type::BaseModel
+              # Number of audio tokens billed for this request.
               attr_reader audio_tokens: Integer?
 
+              # Number of audio tokens billed for this request.
               def audio_tokens=: (Integer) -> Integer
 
+              # Number of text tokens billed for this request.
               attr_reader text_tokens: Integer?
 
+              # Number of text tokens billed for this request.
               def text_tokens=: (Integer) -> Integer
 
+              # @param audio_tokens
+              #   Number of audio tokens billed for this request.
+              # @param text_tokens
+              #   Number of text tokens billed for this request.
               def initialize: (
                 ?audio_tokens: Integer,
                 ?text_tokens: Integer
@@ -128,10 +182,16 @@ module OpenAI
             { seconds: Float, ?type: :duration }
 
           class TranscriptTextUsageDuration < OpenAI::Internal::Type::BaseModel
+            # Duration of the input audio in seconds.
             attr_accessor seconds: Float
 
+            # The type of the usage object. Always `duration` for this variant.
             attr_accessor type: :duration
 
+            # @param seconds
+            #   Duration of the input audio in seconds.
+            # @param type
+            #   The type of the usage object. Always `duration` for this variant.
             def initialize: (seconds: Float, ?type: :duration) -> void
 
             def to_hash: -> { seconds: Float, ?type: :duration }

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

@@ -12,22 +12,52 @@ module OpenAI
         }
 
       class ConversationItemInputAudioTranscriptionDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item containing the audio that is being transcribed.
         attr_accessor item_id: String
 
+        # The event type, must be `conversation.item.input_audio_transcription.delta`.
         attr_accessor type: :"conversation.item.input_audio_transcription.delta"
 
+        # The index of the content part in the item's content array.
         attr_reader content_index: Integer?
 
+        # The index of the content part in the item's content array.
         def content_index=: (Integer) -> Integer
 
+        # The text delta.
         attr_reader delta: String?
 
+        # The text delta.
         def delta=: (String) -> String
 
+        # The log probabilities of the transcription. These can be enabled by
+        # configurating the session with
+        # `"include": ["item.input_audio_transcription.logprobs"]`. Each entry in the
+        # array corresponds a log probability of which token would be selected for this
+        # chunk of transcription. This can help to identify if it was possible there were
+        # multiple valid options for a given chunk of transcription.
         attr_accessor logprobs: ::Array[OpenAI::Realtime::LogProbProperties]?
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item containing the audio that is being transcribed.
+        # @param content_index
+        #   The index of the content part in the item's content array.
+        # @param delta
+        #   The text delta.
+        # @param logprobs
+        #   The log probabilities of the transcription. These can be enabled by
+        #   configurating the session with
+        #   `"include": ["item.input_audio_transcription.logprobs"]`. Each entry in the
+        #   array corresponds a log probability of which token would be selected for this
+        #   chunk of transcription. This can help to identify if it was possible there were
+        #   multiple valid options for a given chunk of transcription.
+        # @param type
+        #   The event type, must be `conversation.item.input_audio_transcription.delta`.
         def initialize: (
           event_id: String,
           item_id: String,