openai 0.92.0 → 0.93.0

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

@@ -9,18 +9,29 @@ module OpenAI
         }
 
       class ResponseCreateEvent < OpenAI::Internal::Type::BaseModel
+        # The event type, must be `response.create`.
         attr_accessor type: :"response.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
 
+        # Create a new Realtime response with these parameters
         attr_reader response: OpenAI::Realtime::RealtimeResponseCreateParams?
 
+        # Create a new Realtime response with these parameters
         def response=: (
           OpenAI::Realtime::RealtimeResponseCreateParams
         ) -> OpenAI::Realtime::RealtimeResponseCreateParams
 
+        # @param event_id
+        #   Optional client-generated ID used to identify this event.
+        # @param response
+        #   Create a new Realtime response with these parameters
+        # @param type
+        #   The event type, must be `response.create`.
         def initialize: (
           ?event_id: String,
           ?response: OpenAI::Realtime::RealtimeResponseCreateParams,

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

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

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

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class ResponseDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The response resource.
         attr_accessor response: OpenAI::Realtime::RealtimeResponse
 
+        # The event type, must be `response.done`.
         attr_accessor type: :"response.done"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param response
+        #   The response resource.
+        # @param type
+        #   The event type, must be `response.done`.
         def initialize: (
           event_id: String,
           response: OpenAI::Realtime::RealtimeResponse,

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseFunctionCallArgumentsDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The ID of the function call.
         attr_accessor call_id: String
 
+        # The arguments delta as a JSON string.
         attr_accessor delta: String
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the function call 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.function_call_arguments.delta`.
         attr_accessor type: :"response.function_call_arguments.delta"
 
+        # @param call_id
+        #   The ID of the function call.
+        # @param delta
+        #   The arguments delta as a JSON string.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the function call 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.function_call_arguments.delta`.
         def initialize: (
           call_id: String,
           delta: String,

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

@@ -14,22 +14,46 @@ module OpenAI
         }
 
       class ResponseFunctionCallArgumentsDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The final arguments as a JSON string.
         attr_accessor arguments: String
 
+        # The ID of the function call.
         attr_accessor call_id: String
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the function call item.
         attr_accessor item_id: String
 
+        # The name of the function that was called.
         attr_accessor name: 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.function_call_arguments.done`.
         attr_accessor type: :"response.function_call_arguments.done"
 
+        # @param arguments
+        #   The final arguments as a JSON string.
+        # @param call_id
+        #   The ID of the function call.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the function call item.
+        # @param name
+        #   The name of the function that was called.
+        # @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.function_call_arguments.done`.
         def initialize: (
           arguments: String,
           call_id: String,

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseMcpCallArgumentsDelta < OpenAI::Internal::Type::BaseModel
+        # The JSON-encoded arguments delta.
         attr_accessor delta: String
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the MCP tool call 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.mcp_call_arguments.delta`.
         attr_accessor type: :"response.mcp_call_arguments.delta"
 
+        # If present, indicates the delta text was obfuscated.
         attr_accessor obfuscation: String?
 
+        # @param delta
+        #   The JSON-encoded arguments delta.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the MCP tool call item.
+        # @param output_index
+        #   The index of the output item in the response.
+        # @param response_id
+        #   The ID of the response.
+        # @param obfuscation
+        #   If present, indicates the delta text was obfuscated.
+        # @param type
+        #   The event type, must be `response.mcp_call_arguments.delta`.
         def initialize: (
           delta: String,
           event_id: String,

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

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class ResponseMcpCallArgumentsDone < OpenAI::Internal::Type::BaseModel
+        # The final JSON-encoded arguments string.
         attr_accessor arguments: String
 
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the MCP tool call 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.mcp_call_arguments.done`.
         attr_accessor type: :"response.mcp_call_arguments.done"
 
+        # @param arguments
+        #   The final JSON-encoded arguments string.
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the MCP tool call 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.mcp_call_arguments.done`.
         def initialize: (
           arguments: String,
           event_id: String,

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

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class ResponseMcpCallCompleted < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the MCP tool call item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response.
         attr_accessor output_index: Integer
 
+        # The event type, must be `response.mcp_call.completed`.
         attr_accessor type: :"response.mcp_call.completed"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the MCP tool call item.
+        # @param output_index
+        #   The index of the output item in the response.
+        # @param type
+        #   The event type, must be `response.mcp_call.completed`.
         def initialize: (
           event_id: String,
           item_id: String,

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

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class ResponseMcpCallFailed < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the MCP tool call item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response.
         attr_accessor output_index: Integer
 
+        # The event type, must be `response.mcp_call.failed`.
         attr_accessor type: :"response.mcp_call.failed"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the MCP tool call item.
+        # @param output_index
+        #   The index of the output item in the response.
+        # @param type
+        #   The event type, must be `response.mcp_call.failed`.
         def initialize: (
           event_id: String,
           item_id: String,

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

@@ -10,14 +10,26 @@ module OpenAI
         }
 
       class ResponseMcpCallInProgress < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The ID of the MCP tool call item.
         attr_accessor item_id: String
 
+        # The index of the output item in the response.
         attr_accessor output_index: Integer
 
+        # The event type, must be `response.mcp_call.in_progress`.
         attr_accessor type: :"response.mcp_call.in_progress"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item_id
+        #   The ID of the MCP tool call item.
+        # @param output_index
+        #   The index of the output item in the response.
+        # @param type
+        #   The event type, must be `response.mcp_call.in_progress`.
         def initialize: (
           event_id: String,
           item_id: String,

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

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ResponseOutputItemAddedEvent < 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 index of the output item in the Response.
         attr_accessor output_index: Integer
 
+        # The ID of the Response to which the item belongs.
         attr_accessor response_id: String
 
+        # The event type, must be `response.output_item.added`.
         attr_accessor type: :"response.output_item.added"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item
+        #   A single item within a Realtime conversation.
+        # @param output_index
+        #   The index of the output item in the Response.
+        # @param response_id
+        #   The ID of the Response to which the item belongs.
+        # @param type
+        #   The event type, must be `response.output_item.added`.
         def initialize: (
           event_id: String,
           item: OpenAI::Models::Realtime::conversation_item,

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

@@ -11,16 +11,31 @@ module OpenAI
         }
 
       class ResponseOutputItemDoneEvent < 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 index of the output item in the Response.
         attr_accessor output_index: Integer
 
+        # The ID of the Response to which the item belongs.
         attr_accessor response_id: String
 
+        # The event type, must be `response.output_item.done`.
         attr_accessor type: :"response.output_item.done"
 
+        # @param event_id
+        #   The unique ID of the server event.
+        # @param item
+        #   A single item within a Realtime conversation.
+        # @param output_index
+        #   The index of the output item in the Response.
+        # @param response_id
+        #   The ID of the Response to which the item belongs.
+        # @param type
+        #   The event type, must be `response.output_item.done`.
         def initialize: (
           event_id: String,
           item: OpenAI::Models::Realtime::conversation_item,

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # The index of the content part in the item's content array.
         attr_accessor content_index: Integer
 
+        # The text 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_text.delta`.
         attr_accessor type: :"response.output_text.delta"
 
+        # @param content_index
+        #   The index of the content part in the item's content array.
+        # @param delta
+        #   The text 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_text.delta`.
         def initialize: (
           content_index: Integer,
           delta: String,

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

@@ -13,20 +13,41 @@ module OpenAI
         }
 
       class ResponseTextDoneEvent < 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 text content.
         attr_accessor text: String
 
+        # The event type, must be `response.output_text.done`.
         attr_accessor type: :"response.output_text.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 text
+        #   The final text content.
+        # @param type
+        #   The event type, must be `response.output_text.done`.
         def initialize: (
           content_index: Integer,
           event_id: String,

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

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class SessionCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The session configuration.
         attr_accessor session: OpenAI::Models::Realtime::SessionCreatedEvent::session
 
+        # 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 session configuration.
+        # @param type
+        #   The event type, must be `session.created`.
         def initialize: (
           event_id: String,
           session: OpenAI::Models::Realtime::SessionCreatedEvent::session,

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

@@ -9,14 +9,35 @@ module OpenAI
         }
 
       class SessionUpdateEvent < OpenAI::Internal::Type::BaseModel
+        # Update the Realtime session. Choose either a realtime session or a transcription
+        # session.
         attr_accessor session: OpenAI::Models::Realtime::SessionUpdateEvent::session
 
+        # The event type, must be `session.update`.
         attr_accessor type: :"session.update"
 
+        # Optional client-generated ID used to identify this event. This is an arbitrary
+        # string that a client may assign. It will be passed back if there is an error
+        # with the event, but the corresponding `session.updated` event will not include
+        # it.
         attr_reader event_id: String?
 
+        # Optional client-generated ID used to identify this event. This is an arbitrary
+        # string that a client may assign. It will be passed back if there is an error
+        # with the event, but the corresponding `session.updated` event will not include
+        # it.
         def event_id=: (String) -> String
 
+        # @param session
+        #   Update the Realtime session. Choose either a realtime session or a transcription
+        #   session.
+        # @param event_id
+        #   Optional client-generated ID used to identify this event. This is an arbitrary
+        #   string that a client may assign. It will be passed back if there is an error
+        #   with the event, but the corresponding `session.updated` event will not include
+        #   it.
+        # @param type
+        #   The event type, must be `session.update`.
         def initialize: (
           session: OpenAI::Models::Realtime::SessionUpdateEvent::session,
           ?event_id: String,

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

@@ -9,12 +9,21 @@ module OpenAI
         }
 
       class SessionUpdatedEvent < OpenAI::Internal::Type::BaseModel
+        # The unique ID of the server event.
         attr_accessor event_id: String
 
+        # The session configuration.
         attr_accessor session: OpenAI::Models::Realtime::SessionUpdatedEvent::session
 
+        # 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 session configuration.
+        # @param type
+        #   The event type, must be `session.updated`.
         def initialize: (
           event_id: String,
           session: OpenAI::Models::Realtime::SessionUpdatedEvent::session,