openai 0.20.0 → 0.21.0

data/lib/openai/models/realtime/response_created_event.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute response
+        #   The response resource.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeResponse]
+        required :response, -> { OpenAI::Realtime::RealtimeResponse }
+
+        # @!attribute type
+        #   The event type, must be `response.created`.
+        #
+        #   @return [Symbol, :"response.created"]
+        required :type, const: :"response.created"
+
+        # @!method initialize(event_id:, response:, type: :"response.created")
+        #   Returned when a new Response is created. The first event of response creation,
+        #   where the response is in an initial state of `in_progress`.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param response [OpenAI::Models::Realtime::RealtimeResponse] The response resource.
+        #
+        #   @param type [Symbol, :"response.created"] The event type, must be `response.created`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_done_event.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute response
+        #   The response resource.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeResponse]
+        required :response, -> { OpenAI::Realtime::RealtimeResponse }
+
+        # @!attribute type
+        #   The event type, must be `response.done`.
+        #
+        #   @return [Symbol, :"response.done"]
+        required :type, const: :"response.done"
+
+        # @!method initialize(event_id:, response:, type: :"response.done")
+        #   Returned when a Response is done streaming. Always emitted, no matter the final
+        #   state. The Response object included in the `response.done` event will include
+        #   all output Items in the Response but will omit the raw audio data.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param response [OpenAI::Models::Realtime::RealtimeResponse] The response resource.
+        #
+        #   @param type [Symbol, :"response.done"] The event type, must be `response.done`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_function_call_arguments_delta_event.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseFunctionCallArgumentsDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute call_id
+        #   The ID of the function call.
+        #
+        #   @return [String]
+        required :call_id, String
+
+        # @!attribute delta
+        #   The arguments delta as a JSON string.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the function call item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute response_id
+        #   The ID of the response.
+        #
+        #   @return [String]
+        required :response_id, String
+
+        # @!attribute type
+        #   The event type, must be `response.function_call_arguments.delta`.
+        #
+        #   @return [Symbol, :"response.function_call_arguments.delta"]
+        required :type, const: :"response.function_call_arguments.delta"
+
+        # @!method initialize(call_id:, delta:, event_id:, item_id:, output_index:, response_id:, type: :"response.function_call_arguments.delta")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::ResponseFunctionCallArgumentsDeltaEvent} for more
+        #   details.
+        #
+        #   Returned when the model-generated function call arguments are updated.
+        #
+        #   @param call_id [String] The ID of the function call.
+        #
+        #   @param delta [String] The arguments delta as a JSON string.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the function call item.
+        #
+        #   @param output_index [Integer] The index of the output item in the response.
+        #
+        #   @param response_id [String] The ID of the response.
+        #
+        #   @param type [Symbol, :"response.function_call_arguments.delta"] The event type, must be `response.function_call_arguments.delta`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_function_call_arguments_done_event.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseFunctionCallArgumentsDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute arguments
+        #   The final arguments as a JSON string.
+        #
+        #   @return [String]
+        required :arguments, String
+
+        # @!attribute call_id
+        #   The ID of the function call.
+        #
+        #   @return [String]
+        required :call_id, String
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the function call item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute response_id
+        #   The ID of the response.
+        #
+        #   @return [String]
+        required :response_id, String
+
+        # @!attribute type
+        #   The event type, must be `response.function_call_arguments.done`.
+        #
+        #   @return [Symbol, :"response.function_call_arguments.done"]
+        required :type, const: :"response.function_call_arguments.done"
+
+        # @!method initialize(arguments:, call_id:, event_id:, item_id:, output_index:, response_id:, type: :"response.function_call_arguments.done")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::ResponseFunctionCallArgumentsDoneEvent} for more
+        #   details.
+        #
+        #   Returned when the model-generated function call arguments are done streaming.
+        #   Also emitted when a Response is interrupted, incomplete, or cancelled.
+        #
+        #   @param arguments [String] The final arguments as a JSON string.
+        #
+        #   @param call_id [String] The ID of the function call.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the function call item.
+        #
+        #   @param output_index [Integer] The index of the output item in the response.
+        #
+        #   @param response_id [String] The ID of the response.
+        #
+        #   @param type [Symbol, :"response.function_call_arguments.done"] The event type, must be `response.function_call_arguments.done`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_mcp_call_arguments_delta.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseMcpCallArgumentsDelta < OpenAI::Internal::Type::BaseModel
+        # @!attribute delta
+        #   The JSON-encoded arguments delta.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the MCP tool call item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute response_id
+        #   The ID of the response.
+        #
+        #   @return [String]
+        required :response_id, String
+
+        # @!attribute type
+        #   The event type, must be `response.mcp_call_arguments.delta`.
+        #
+        #   @return [Symbol, :"response.mcp_call_arguments.delta"]
+        required :type, const: :"response.mcp_call_arguments.delta"
+
+        # @!attribute obfuscation
+        #   If present, indicates the delta text was obfuscated.
+        #
+        #   @return [String, nil]
+        optional :obfuscation, String, nil?: true
+
+        # @!method initialize(delta:, event_id:, item_id:, output_index:, response_id:, obfuscation: nil, type: :"response.mcp_call_arguments.delta")
+        #   Returned when MCP tool call arguments are updated during response generation.
+        #
+        #   @param delta [String] The JSON-encoded arguments delta.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the MCP tool call item.
+        #
+        #   @param output_index [Integer] The index of the output item in the response.
+        #
+        #   @param response_id [String] The ID of the response.
+        #
+        #   @param obfuscation [String, nil] If present, indicates the delta text was obfuscated.
+        #
+        #   @param type [Symbol, :"response.mcp_call_arguments.delta"] The event type, must be `response.mcp_call_arguments.delta`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_mcp_call_arguments_done.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseMcpCallArgumentsDone < OpenAI::Internal::Type::BaseModel
+        # @!attribute arguments
+        #   The final JSON-encoded arguments string.
+        #
+        #   @return [String]
+        required :arguments, String
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the MCP tool call item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute response_id
+        #   The ID of the response.
+        #
+        #   @return [String]
+        required :response_id, String
+
+        # @!attribute type
+        #   The event type, must be `response.mcp_call_arguments.done`.
+        #
+        #   @return [Symbol, :"response.mcp_call_arguments.done"]
+        required :type, const: :"response.mcp_call_arguments.done"
+
+        # @!method initialize(arguments:, event_id:, item_id:, output_index:, response_id:, type: :"response.mcp_call_arguments.done")
+        #   Returned when MCP tool call arguments are finalized during response generation.
+        #
+        #   @param arguments [String] The final JSON-encoded arguments string.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the MCP tool call item.
+        #
+        #   @param output_index [Integer] The index of the output item in the response.
+        #
+        #   @param response_id [String] The ID of the response.
+        #
+        #   @param type [Symbol, :"response.mcp_call_arguments.done"] The event type, must be `response.mcp_call_arguments.done`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_mcp_call_completed.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseMcpCallCompleted < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the MCP tool call item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute type
+        #   The event type, must be `response.mcp_call.completed`.
+        #
+        #   @return [Symbol, :"response.mcp_call.completed"]
+        required :type, const: :"response.mcp_call.completed"
+
+        # @!method initialize(event_id:, item_id:, output_index:, type: :"response.mcp_call.completed")
+        #   Returned when an MCP tool call has completed successfully.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the MCP tool call item.
+        #
+        #   @param output_index [Integer] The index of the output item in the response.
+        #
+        #   @param type [Symbol, :"response.mcp_call.completed"] The event type, must be `response.mcp_call.completed`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_mcp_call_failed.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseMcpCallFailed < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the MCP tool call item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute type
+        #   The event type, must be `response.mcp_call.failed`.
+        #
+        #   @return [Symbol, :"response.mcp_call.failed"]
+        required :type, const: :"response.mcp_call.failed"
+
+        # @!method initialize(event_id:, item_id:, output_index:, type: :"response.mcp_call.failed")
+        #   Returned when an MCP tool call has failed.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the MCP tool call item.
+        #
+        #   @param output_index [Integer] The index of the output item in the response.
+        #
+        #   @param type [Symbol, :"response.mcp_call.failed"] The event type, must be `response.mcp_call.failed`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_mcp_call_in_progress.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseMcpCallInProgress < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the MCP tool call item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute type
+        #   The event type, must be `response.mcp_call.in_progress`.
+        #
+        #   @return [Symbol, :"response.mcp_call.in_progress"]
+        required :type, const: :"response.mcp_call.in_progress"
+
+        # @!method initialize(event_id:, item_id:, output_index:, type: :"response.mcp_call.in_progress")
+        #   Returned when an MCP tool call has started and is in progress.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the MCP tool call item.
+        #
+        #   @param output_index [Integer] The index of the output item in the response.
+        #
+        #   @param type [Symbol, :"response.mcp_call.in_progress"] The event type, must be `response.mcp_call.in_progress`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_output_item_added_event.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseOutputItemAddedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item
+        #   A single item within a Realtime conversation.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        required :item, union: -> { OpenAI::Realtime::ConversationItem }
+
+        # @!attribute output_index
+        #   The index of the output item in the Response.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute response_id
+        #   The ID of the Response to which the item belongs.
+        #
+        #   @return [String]
+        required :response_id, String
+
+        # @!attribute type
+        #   The event type, must be `response.output_item.added`.
+        #
+        #   @return [Symbol, :"response.output_item.added"]
+        required :type, const: :"response.output_item.added"
+
+        # @!method initialize(event_id:, item:, output_index:, response_id:, type: :"response.output_item.added")
+        #   Returned when a new Item is created during Response generation.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest] A single item within a Realtime conversation.
+        #
+        #   @param output_index [Integer] The index of the output item in the Response.
+        #
+        #   @param response_id [String] The ID of the Response to which the item belongs.
+        #
+        #   @param type [Symbol, :"response.output_item.added"] The event type, must be `response.output_item.added`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_output_item_done_event.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseOutputItemDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item
+        #   A single item within a Realtime conversation.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        required :item, union: -> { OpenAI::Realtime::ConversationItem }
+
+        # @!attribute output_index
+        #   The index of the output item in the Response.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute response_id
+        #   The ID of the Response to which the item belongs.
+        #
+        #   @return [String]
+        required :response_id, String
+
+        # @!attribute type
+        #   The event type, must be `response.output_item.done`.
+        #
+        #   @return [Symbol, :"response.output_item.done"]
+        required :type, const: :"response.output_item.done"
+
+        # @!method initialize(event_id:, item:, output_index:, response_id:, type: :"response.output_item.done")
+        #   Returned when an Item is done streaming. Also emitted when a Response is
+        #   interrupted, incomplete, or cancelled.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest] A single item within a Realtime conversation.
+        #
+        #   @param output_index [Integer] The index of the output item in the Response.
+        #
+        #   @param response_id [String] The ID of the Response to which the item belongs.
+        #
+        #   @param type [Symbol, :"response.output_item.done"] The event type, must be `response.output_item.done`.
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/response_text_delta_event.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class ResponseTextDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the content part in the item's content array.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute delta
+        #   The text delta.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute event_id
+        #   The unique ID of the server event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute response_id
+        #   The ID of the response.
+        #
+        #   @return [String]
+        required :response_id, String
+
+        # @!attribute type
+        #   The event type, must be `response.output_text.delta`.
+        #
+        #   @return [Symbol, :"response.output_text.delta"]
+        required :type, const: :"response.output_text.delta"
+
+        # @!method initialize(content_index:, delta:, event_id:, item_id:, output_index:, response_id:, type: :"response.output_text.delta")
+        #   Returned when the text value of an "output_text" content part is updated.
+        #
+        #   @param content_index [Integer] The index of the content part in the item's content array.
+        #
+        #   @param delta [String] The text delta.
+        #
+        #   @param event_id [String] The unique ID of the server event.
+        #
+        #   @param item_id [String] The ID of the item.
+        #
+        #   @param output_index [Integer] The index of the output item in the response.
+        #
+        #   @param response_id [String] The ID of the response.
+        #
+        #   @param type [Symbol, :"response.output_text.delta"] The event type, must be `response.output_text.delta`.
+      end
+    end
+  end
+end