openai 0.91.0 → 0.93.0

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

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ConversationItemInputAudioTranscriptionFailedEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part containing the audio.
         attr_accessor content_index: Integer
 
+        # Details of the transcription error.
         attr_accessor error: OpenAI::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the user message item.
         attr_accessor item_id: String
 
+        # The event type, must be `conversation.item.input_audio_transcription.failed`.
         attr_accessor type: :"conversation.item.input_audio_transcription.failed"
 
+        # @param content_index
+        #   The index of the content part containing the audio.
+        # @param error
+        #   Details of the transcription error.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the user message item.
+        # @param type
+        #   The event type, must be `conversation.item.input_audio_transcription.failed`.
         def initialize: (
           content_index: Integer,
           error: OpenAI::Realtime::ConversationItemInputAudioTranscriptionFailedEvent::Error,
@@ -41,22 +56,38 @@ module OpenAI
           { ?code: String, ?message: String, ?param: String, ?type: String }
 
         class Error < OpenAI::Internal::Type::BaseModel
+          # Error code, if any.
           attr_reader code: String?
 
+          # Error code, if any.
           def code=: (String) -> String
 
+          # A human-readable error message.
           attr_reader message: String?
 
+          # A human-readable error message.
           def message=: (String) -> String
 
+          # Parameter related to the error, if any.
           attr_reader param: String?
 
+          # Parameter related to the error, if any.
           def param=: (String) -> String
 
+          # The type of error.
           attr_reader type: String?
 
+          # The type of error.
           def type=: (String) -> String
 
+          # @param code
+          #   Error code, if any.
+          # @param message
+          #   A human-readable error message.
+          # @param param
+          #   Parameter related to the error, if any.
+          # @param type
+          #   The type of error.
           def initialize: (
             ?code: String,
             ?message: String,

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

@@ -15,24 +15,51 @@ module OpenAI
         }
 
       class ConversationItemInputAudioTranscriptionSegment < OpenAI::Internal::Type::BaseModel
+        # The segment identifier.
         attr_accessor id: String
 
+        # The index of the input audio content part within the item.
         attr_accessor content_index: Integer
 
+        # End time of the segment in seconds.
         attr_accessor end_: Float
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item containing the input audio content.
         attr_accessor item_id: String
 
+        # The detected speaker label for this segment.
         attr_accessor speaker: String
 
+        # Start time of the segment in seconds.
         attr_accessor start: Float
 
+        # The text for this segment.
         attr_accessor text: String
 
+        # The event type, must be `conversation.item.input_audio_transcription.segment`.
         attr_accessor type: :"conversation.item.input_audio_transcription.segment"
 
+        # @param id
+        #   The segment identifier.
+        # @param content_index
+        #   The index of the input audio content part within the item.
+        # @param end_
+        #   End time of the segment in seconds.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item containing the input audio content.
+        # @param speaker
+        #   The detected speaker label for this segment.
+        # @param start
+        #   Start time of the segment in seconds.
+        # @param text
+        #   The text for this segment.
+        # @param type
+        #   The event type, must be `conversation.item.input_audio_transcription.segment`.
         def initialize: (
           id: String,
           content_index: Integer,

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

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

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

@@ -11,18 +11,40 @@ module OpenAI
         }
 
       class ConversationItemTruncateEvent < OpenAI::Internal::Type::BaseModel
+        # Inclusive duration up to which audio is truncated, in milliseconds. If the
+        # audio_end_ms is greater than the actual audio duration, the server will respond
+        # with an error.
         attr_accessor audio_end_ms: Integer
 
+        # The index of the content part to truncate. Set this to `0`.
         attr_accessor content_index: Integer
 
+        # The ID of the assistant message item to truncate. Only assistant message items
+        # can be truncated.
         attr_accessor item_id: String
 
+        # The event type, must be `conversation.item.truncate`.
         attr_accessor type: :"conversation.item.truncate"
 
+        # 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_end_ms
+        #   Inclusive duration up to which audio is truncated, in milliseconds. If the
+        #   audio_end_ms is greater than the actual audio duration, the server will respond
+        #   with an error.
+        # @param content_index
+        #   The index of the content part to truncate. Set this to `0`.
+        # @param item_id
+        #   The ID of the assistant message item to truncate. Only assistant message items
+        #   can be truncated.
+        # @param event_id
+        #   Optional client-generated ID used to identify this event.
+        # @param type
+        #   The event type, must be `conversation.item.truncate`.
         def initialize: (
           audio_end_ms: Integer,
           content_index: Integer,

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

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ConversationItemTruncatedEvent < OpenAI::Internal::Type::BaseModel
+        # The duration up to which the audio was truncated, in milliseconds.
         attr_accessor audio_end_ms: Integer
 
+        # The index of the content part that was truncated.
         attr_accessor content_index: Integer
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the assistant message item that was truncated.
         attr_accessor item_id: String
 
+        # The event type, must be `conversation.item.truncated`.
         attr_accessor type: :"conversation.item.truncated"
 
+        # @param audio_end_ms
+        #   The duration up to which the audio was truncated, in milliseconds.
+        # @param content_index
+        #   The index of the content part that was truncated.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the assistant message item that was truncated.
+        # @param type
+        #   The event type, must be `conversation.item.truncated`.
         def initialize: (
           audio_end_ms: Integer,
           content_index: Integer,

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

@@ -16,56 +16,141 @@ module OpenAI
         }
 
       class ConversationItemWithReference < OpenAI::Internal::Type::BaseModel
+        # For an item of type (`message` | `function_call` | `function_call_output`) this
+        # field allows the client to assign the unique ID of the item. It is not required
+        # because the server will generate one if not provided.
+        #
+        # For an item of type `item_reference`, this field is required and is a reference
+        # to any item that has previously existed in the conversation.
         attr_reader id: String?
 
+        # For an item of type (`message` | `function_call` | `function_call_output`) this
+        # field allows the client to assign the unique ID of the item. It is not required
+        # because the server will generate one if not provided.
+        #
+        # For an item of type `item_reference`, this field is required and is a reference
+        # to any item that has previously existed in the conversation.
         def id=: (String) -> String
 
+        # The arguments of the function call (for `function_call` items).
         attr_reader arguments: String?
 
+        # The arguments of the function call (for `function_call` items).
         def arguments=: (String) -> String
 
+        # The ID of the function call (for `function_call` and `function_call_output`
+        # items). If passed on a `function_call_output` item, the server will check that a
+        # `function_call` item with the same ID exists in the conversation history.
         attr_reader call_id: String?
 
+        # The ID of the function call (for `function_call` and `function_call_output`
+        # items). If passed on a `function_call_output` item, the server will check that a
+        # `function_call` item with the same ID exists in the conversation history.
         def call_id=: (String) -> String
 
+        # The content of the message, applicable for `message` items.
+        #
+        # - Message items of role `system` support only `input_text` content
+        # - Message items of role `user` support `input_text` and `input_audio` content
+        # - Message items of role `assistant` support `text` content.
         attr_reader content: ::Array[OpenAI::Realtime::ConversationItemWithReference::Content]?
 
+        # The content of the message, applicable for `message` items.
+        #
+        # - Message items of role `system` support only `input_text` content
+        # - Message items of role `user` support `input_text` and `input_audio` content
+        # - Message items of role `assistant` support `text` content.
         def content=: (
           ::Array[OpenAI::Realtime::ConversationItemWithReference::Content]
         ) -> ::Array[OpenAI::Realtime::ConversationItemWithReference::Content]
 
+        # The name of the function being called (for `function_call` items).
         attr_reader name: String?
 
+        # The name of the function being called (for `function_call` items).
         def name=: (String) -> String
 
+        # Identifier for the API object being returned - always `realtime.item`.
         attr_reader object: OpenAI::Models::Realtime::ConversationItemWithReference::object?
 
+        # Identifier for the API object being returned - always `realtime.item`.
         def object=: (
           OpenAI::Models::Realtime::ConversationItemWithReference::object
         ) -> OpenAI::Models::Realtime::ConversationItemWithReference::object
 
+        # The output of the function call (for `function_call_output` items).
         attr_reader output: String?
 
+        # The output of the function call (for `function_call_output` items).
         def output=: (String) -> String
 
+        # The role of the message sender (`user`, `assistant`, `system`), only applicable
+        # for `message` items.
         attr_reader role: OpenAI::Models::Realtime::ConversationItemWithReference::role?
 
+        # The role of the message sender (`user`, `assistant`, `system`), only applicable
+        # for `message` items.
         def role=: (
           OpenAI::Models::Realtime::ConversationItemWithReference::role
         ) -> OpenAI::Models::Realtime::ConversationItemWithReference::role
 
+        # The status of the item (`completed`, `incomplete`, `in_progress`). These have no
+        # effect on the conversation, but are accepted for consistency with the
+        # `conversation.item.created` event.
         attr_reader status: OpenAI::Models::Realtime::ConversationItemWithReference::status?
 
+        # The status of the item (`completed`, `incomplete`, `in_progress`). These have no
+        # effect on the conversation, but are accepted for consistency with the
+        # `conversation.item.created` event.
         def status=: (
           OpenAI::Models::Realtime::ConversationItemWithReference::status
         ) -> OpenAI::Models::Realtime::ConversationItemWithReference::status
 
+        # The type of the item (`message`, `function_call`, `function_call_output`,
+        # `item_reference`).
         attr_reader type: OpenAI::Models::Realtime::ConversationItemWithReference::type_?
 
+        # The type of the item (`message`, `function_call`, `function_call_output`,
+        # `item_reference`).
         def type=: (
           OpenAI::Models::Realtime::ConversationItemWithReference::type_
         ) -> OpenAI::Models::Realtime::ConversationItemWithReference::type_
 
+        # @param id
+        #   For an item of type (`message` | `function_call` | `function_call_output`) this
+        #   field allows the client to assign the unique ID of the item. It is not required
+        #   because the server will generate one if not provided.
+        #
+        #   For an item of type `item_reference`, this field is required and is a reference
+        #   to any item that has previously existed in the conversation.
+        # @param arguments
+        #   The arguments of the function call (for `function_call` items).
+        # @param call_id
+        #   The ID of the function call (for `function_call` and `function_call_output`
+        #   items). If passed on a `function_call_output` item, the server will check that a
+        #   `function_call` item with the same ID exists in the conversation history.
+        # @param content
+        #   The content of the message, applicable for `message` items.
+        #
+        #   - Message items of role `system` support only `input_text` content
+        #   - Message items of role `user` support `input_text` and `input_audio` content
+        #   - Message items of role `assistant` support `text` content.
+        # @param name
+        #   The name of the function being called (for `function_call` items).
+        # @param object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        # @param output
+        #   The output of the function call (for `function_call_output` items).
+        # @param role
+        #   The role of the message sender (`user`, `assistant`, `system`), only applicable
+        #   for `message` items.
+        # @param status
+        #   The status of the item (`completed`, `incomplete`, `in_progress`). These have no
+        #   effect on the conversation, but are accepted for consistency with the
+        #   `conversation.item.created` event.
+        # @param type
+        #   The type of the item (`message`, `function_call`, `function_call_output`,
+        #   `item_reference`).
         def initialize: (
           ?id: String,
           ?arguments: String,
@@ -102,28 +187,54 @@ module OpenAI
           }
 
         class Content < OpenAI::Internal::Type::BaseModel
+          # ID of a previous conversation item to reference (for `item_reference` content
+          # types in `response.create` events). These can reference both client and server
+          # created items.
           attr_reader id: String?
 
+          # ID of a previous conversation item to reference (for `item_reference` content
+          # types in `response.create` events). These can reference both client and server
+          # created items.
           def id=: (String) -> String
 
+          # Base64-encoded audio bytes, used for `input_audio` content type.
           attr_reader audio: String?
 
+          # Base64-encoded audio bytes, used for `input_audio` content type.
           def audio=: (String) -> String
 
+          # The text content, used for `input_text` and `text` content types.
           attr_reader text: String?
 
+          # The text content, used for `input_text` and `text` content types.
           def text=: (String) -> String
 
+          # The transcript of the audio, used for `input_audio` content type.
           attr_reader transcript: String?
 
+          # The transcript of the audio, used for `input_audio` content type.
           def transcript=: (String) -> String
 
+          # The content type (`input_text`, `input_audio`, `item_reference`, `text`).
           attr_reader type: OpenAI::Models::Realtime::ConversationItemWithReference::Content::type_?
 
+          # The content type (`input_text`, `input_audio`, `item_reference`, `text`).
           def type=: (
             OpenAI::Models::Realtime::ConversationItemWithReference::Content::type_
           ) -> OpenAI::Models::Realtime::ConversationItemWithReference::Content::type_
 
+          # @param id
+          #   ID of a previous conversation item to reference (for `item_reference` content
+          #   types in `response.create` events). These can reference both client and server
+          #   created items.
+          # @param audio
+          #   Base64-encoded audio bytes, used for `input_audio` content type.
+          # @param text
+          #   The text content, used for `input_text` and `text` content types.
+          # @param transcript
+          #   The transcript of the audio, used for `input_audio` content type.
+          # @param type
+          #   The content type (`input_text`, `input_audio`, `item_reference`, `text`).
           def initialize: (
             ?id: String,
             ?audio: String,

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

@@ -9,14 +9,26 @@ module OpenAI
         }
 
       class InputAudioBufferAppendEvent < OpenAI::Internal::Type::BaseModel
+        # Base64-encoded audio bytes. This must be in the format specified by the
+        # `input_audio_format` field in the session configuration.
         attr_accessor audio: String
 
+        # The event type, must be `input_audio_buffer.append`.
         attr_accessor type: :"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 audio bytes. This must be in the format specified by the
+        #   `input_audio_format` field in the session configuration.
+        # @param event_id
+        #   Optional client-generated ID used to identify this event.
+        # @param type
+        #   The event type, must be `input_audio_buffer.append`.
         def initialize: (
           audio: String,
           ?event_id: String,

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

@@ -5,12 +5,19 @@ module OpenAI
         { ?type: :"input_audio_buffer.clear", ?event_id: String }
 
       class InputAudioBufferClearEvent < OpenAI::Internal::Type::BaseModel
+        # The event type, must be `input_audio_buffer.clear`.
         attr_accessor type: :"input_audio_buffer.clear"
 
+        # 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 `input_audio_buffer.clear`.
         def initialize: (
           ?event_id: String,
           ?type: :"input_audio_buffer.clear"

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

@@ -5,10 +5,16 @@ module OpenAI
         { event_id: String, ?type: :"input_audio_buffer.cleared" }
 
       class InputAudioBufferClearedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The event type, must be `input_audio_buffer.cleared`.
         attr_accessor type: :"input_audio_buffer.cleared"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param type
+        #   The event type, must be `input_audio_buffer.cleared`.
         def initialize: (
           event_id: String,
           ?type: :"input_audio_buffer.cleared"

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

@@ -5,12 +5,19 @@ module OpenAI
         { ?type: :"input_audio_buffer.commit", ?event_id: String }
 
       class InputAudioBufferCommitEvent < OpenAI::Internal::Type::BaseModel
+        # The event type, must be `input_audio_buffer.commit`.
         attr_accessor type: :"input_audio_buffer.commit"
 
+        # 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 `input_audio_buffer.commit`.
         def initialize: (
           ?event_id: String,
           ?type: :"input_audio_buffer.commit"

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

@@ -10,14 +10,28 @@ module OpenAI
         }
 
       class InputAudioBufferCommittedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the user message item that will be created.
         attr_accessor item_id: String
 
+        # The event type, must be `input_audio_buffer.committed`.
         attr_accessor type: :"input_audio_buffer.committed"
 
+        # The ID of the preceding item after which the new item will be inserted. 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_id
+        #   The ID of the user message item that will be created.
+        # @param previous_item_id
+        #   The ID of the preceding item after which the new item will be inserted. Can be
+        #   `null` if the item has no predecessor.
+        # @param type
+        #   The event type, must be `input_audio_buffer.committed`.
         def initialize: (
           event_id: String,
           item_id: String,

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

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class InputAudioBufferDtmfEventReceivedEvent < OpenAI::Internal::Type::BaseModel
+        # The telephone keypad that was pressed by the user.
         attr_accessor event: String
 
+        # UTC Unix Timestamp when DTMF Event was received by server.
         attr_accessor received_at: Integer
 
+        # The event type, must be `input_audio_buffer.dtmf_event_received`.
         attr_accessor type: :"input_audio_buffer.dtmf_event_received"
 
+        # @param event
+        #   The telephone keypad that was pressed by the user.
+        # @param received_at
+        #   UTC Unix Timestamp when DTMF Event was received by server.
+        # @param type
+        #   The event type, must be `input_audio_buffer.dtmf_event_received`.
         def initialize: (
           event: String,
           received_at: Integer,

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

@@ -10,14 +10,32 @@ module OpenAI
         }
 
       class InputAudioBufferSpeechStartedEvent < OpenAI::Internal::Type::BaseModel
+        # Milliseconds from the start of all audio written to the buffer during the
+        # session when speech was first detected. This will correspond to the beginning of
+        # audio sent to the model, and thus includes the `prefix_padding_ms` configured in
+        # the Session.
         attr_accessor audio_start_ms: Integer
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the user message item that will be created when speech stops.
         attr_accessor item_id: String
 
+        # The event type, must be `input_audio_buffer.speech_started`.
         attr_accessor type: :"input_audio_buffer.speech_started"
 
+        # @param audio_start_ms
+        #   Milliseconds from the start of all audio written to the buffer during the
+        #   session when speech was first detected. This will correspond to the beginning of
+        #   audio sent to the model, and thus includes the `prefix_padding_ms` configured in
+        #   the Session.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the user message item that will be created when speech stops.
+        # @param type
+        #   The event type, must be `input_audio_buffer.speech_started`.
         def initialize: (
           audio_start_ms: Integer,
           event_id: String,

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

@@ -10,14 +10,30 @@ module OpenAI
         }
 
       class InputAudioBufferSpeechStoppedEvent < OpenAI::Internal::Type::BaseModel
+        # Milliseconds since the session started when speech stopped. This will correspond
+        # to the end of audio sent to the model, and thus includes the
+        # `min_silence_duration_ms` configured in the Session.
         attr_accessor audio_end_ms: Integer
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the user message item that will be created.
         attr_accessor item_id: String
 
+        # The event type, must be `input_audio_buffer.speech_stopped`.
         attr_accessor type: :"input_audio_buffer.speech_stopped"
 
+        # @param audio_end_ms
+        #   Milliseconds since the session started when speech stopped. This will correspond
+        #   to the end of audio sent to the model, and thus includes the
+        #   `min_silence_duration_ms` configured in the Session.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the user message item that will be created.
+        # @param type
+        #   The event type, must be `input_audio_buffer.speech_stopped`.
         def initialize: (
           audio_end_ms: Integer,
           event_id: String,

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

@@ -11,16 +11,35 @@ module OpenAI
         }
 
       class InputAudioBufferTimeoutTriggered < OpenAI::Internal::Type::BaseModel
+        # Millisecond offset of audio written to the input audio buffer at the time the
+        # timeout was triggered.
         attr_accessor audio_end_ms: Integer
 
+        # Millisecond offset of audio written to the input audio buffer that was after the
+        # playback time of the last model response.
         attr_accessor audio_start_ms: Integer
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the item associated with this segment.
         attr_accessor item_id: String
 
+        # The event type, must be `input_audio_buffer.timeout_triggered`.
         attr_accessor type: :"input_audio_buffer.timeout_triggered"
 
+        # @param audio_end_ms
+        #   Millisecond offset of audio written to the input audio buffer at the time the
+        #   timeout was triggered.
+        # @param audio_start_ms
+        #   Millisecond offset of audio written to the input audio buffer that was after the
+        #   playback time of the last model response.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the item associated with this segment.
+        # @param type
+        #   The event type, must be `input_audio_buffer.timeout_triggered`.
         def initialize: (
           audio_end_ms: Integer,
           audio_start_ms: Integer,