openai 0.2.0 → 0.4.0.pre.beta.1

data/lib/openai/models/responses/response_item_list.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseItemList < OpenAI::Internal::Type::BaseModel
+        # @!attribute data
+        #   A list of items used to generate this response.
+        #
+        #   @return [Array<OpenAI::Models::Responses::ResponseInputMessageItem, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseItem::LocalShellCall, OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseItem::McpListTools, OpenAI::Models::Responses::ResponseItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseItem::McpCall>]
+        required :data, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseItem] }
+
+        # @!attribute first_id
+        #   The ID of the first item in the list.
+        #
+        #   @return [String]
+        required :first_id, String
+
+        # @!attribute has_more
+        #   Whether there are more items available.
+        #
+        #   @return [Boolean]
+        required :has_more, OpenAI::Internal::Type::Boolean
+
+        # @!attribute last_id
+        #   The ID of the last item in the list.
+        #
+        #   @return [String]
+        required :last_id, String
+
+        # @!attribute object
+        #   The type of object returned, must be `list`.
+        #
+        #   @return [Symbol, :list]
+        required :object, const: :list
+
+        # @!method initialize(data:, first_id:, has_more:, last_id:, object: :list)
+        #   A list of Response items.
+        #
+        #   @param data [Array<OpenAI::Models::Responses::ResponseInputMessageItem, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseItem::LocalShellCall, OpenAI::Models::Responses::ResponseItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseItem::McpListTools, OpenAI::Models::Responses::ResponseItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseItem::McpCall>] A list of items used to generate this response.
+        #
+        #   @param first_id [String] The ID of the first item in the list.
+        #
+        #   @param has_more [Boolean] Whether there are more items available.
+        #
+        #   @param last_id [String] The ID of the last item in the list.
+        #
+        #   @param object [Symbol, :list] The type of object returned, must be `list`.
+      end
+    end
+
+    ResponseItemList = Responses::ResponseItemList
+  end
+end

data/lib/openai/models/responses/response_mcp_call_arguments_delta_event.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseMcpCallArgumentsDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute delta
+        #   The partial update to the arguments for the MCP tool call.
+        #
+        #   @return [Object]
+        required :delta, OpenAI::Internal::Type::Unknown
+
+        # @!attribute item_id
+        #   The unique identifier of the MCP tool call item being processed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response's output array.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_call.arguments_delta'.
+        #
+        #   @return [Symbol, :"response.mcp_call.arguments_delta"]
+        required :type, const: :"response.mcp_call.arguments_delta"
+
+        # @!method initialize(delta:, item_id:, output_index:, sequence_number:, type: :"response.mcp_call.arguments_delta")
+        #   Emitted when there is a delta (partial update) to the arguments of an MCP tool
+        #   call.
+        #
+        #   @param delta [Object] The partial update to the arguments for the MCP tool call.
+        #
+        #   @param item_id [String] The unique identifier of the MCP tool call item being processed.
+        #
+        #   @param output_index [Integer] The index of the output item in the response's output array.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.mcp_call.arguments_delta"] The type of the event. Always 'response.mcp_call.arguments_delta'.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_mcp_call_arguments_done_event.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseMcpCallArgumentsDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute arguments
+        #   The finalized arguments for the MCP tool call.
+        #
+        #   @return [Object]
+        required :arguments, OpenAI::Internal::Type::Unknown
+
+        # @!attribute item_id
+        #   The unique identifier of the MCP tool call item being processed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response's output array.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_call.arguments_done'.
+        #
+        #   @return [Symbol, :"response.mcp_call.arguments_done"]
+        required :type, const: :"response.mcp_call.arguments_done"
+
+        # @!method initialize(arguments:, item_id:, output_index:, sequence_number:, type: :"response.mcp_call.arguments_done")
+        #   Emitted when the arguments for an MCP tool call are finalized.
+        #
+        #   @param arguments [Object] The finalized arguments for the MCP tool call.
+        #
+        #   @param item_id [String] The unique identifier of the MCP tool call item being processed.
+        #
+        #   @param output_index [Integer] The index of the output item in the response's output array.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.mcp_call.arguments_done"] The type of the event. Always 'response.mcp_call.arguments_done'.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_mcp_call_completed_event.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseMcpCallCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_call.completed'.
+        #
+        #   @return [Symbol, :"response.mcp_call.completed"]
+        required :type, const: :"response.mcp_call.completed"
+
+        # @!method initialize(sequence_number:, type: :"response.mcp_call.completed")
+        #   Emitted when an MCP tool call has completed successfully.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.mcp_call.completed"] The type of the event. Always 'response.mcp_call.completed'.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_mcp_call_failed_event.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseMcpCallFailedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_call.failed'.
+        #
+        #   @return [Symbol, :"response.mcp_call.failed"]
+        required :type, const: :"response.mcp_call.failed"
+
+        # @!method initialize(sequence_number:, type: :"response.mcp_call.failed")
+        #   Emitted when an MCP tool call has failed.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.mcp_call.failed"] The type of the event. Always 'response.mcp_call.failed'.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_mcp_call_in_progress_event.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseMcpCallInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The unique identifier of the MCP tool call item being processed.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item in the response's output array.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_call.in_progress'.
+        #
+        #   @return [Symbol, :"response.mcp_call.in_progress"]
+        required :type, const: :"response.mcp_call.in_progress"
+
+        # @!method initialize(item_id:, output_index:, sequence_number:, type: :"response.mcp_call.in_progress")
+        #   Emitted when an MCP tool call is in progress.
+        #
+        #   @param item_id [String] The unique identifier of the MCP tool call item being processed.
+        #
+        #   @param output_index [Integer] The index of the output item in the response's output array.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.mcp_call.in_progress"] The type of the event. Always 'response.mcp_call.in_progress'.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_mcp_list_tools_completed_event.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseMcpListToolsCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_list_tools.completed'.
+        #
+        #   @return [Symbol, :"response.mcp_list_tools.completed"]
+        required :type, const: :"response.mcp_list_tools.completed"
+
+        # @!method initialize(sequence_number:, type: :"response.mcp_list_tools.completed")
+        #   Emitted when the list of available MCP tools has been successfully retrieved.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.mcp_list_tools.completed"] The type of the event. Always 'response.mcp_list_tools.completed'.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_mcp_list_tools_failed_event.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseMcpListToolsFailedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_list_tools.failed'.
+        #
+        #   @return [Symbol, :"response.mcp_list_tools.failed"]
+        required :type, const: :"response.mcp_list_tools.failed"
+
+        # @!method initialize(sequence_number:, type: :"response.mcp_list_tools.failed")
+        #   Emitted when the attempt to list available MCP tools has failed.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.mcp_list_tools.failed"] The type of the event. Always 'response.mcp_list_tools.failed'.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_mcp_list_tools_in_progress_event.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseMcpListToolsInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always 'response.mcp_list_tools.in_progress'.
+        #
+        #   @return [Symbol, :"response.mcp_list_tools.in_progress"]
+        required :type, const: :"response.mcp_list_tools.in_progress"
+
+        # @!method initialize(sequence_number:, type: :"response.mcp_list_tools.in_progress")
+        #   Emitted when the system is in the process of retrieving the list of available
+        #   MCP tools.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param type [Symbol, :"response.mcp_list_tools.in_progress"] The type of the event. Always 'response.mcp_list_tools.in_progress'.
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_output_audio.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseOutputAudio < OpenAI::Internal::Type::BaseModel
+        # @!attribute data
+        #   Base64-encoded audio data from the model.
+        #
+        #   @return [String]
+        required :data, String
+
+        # @!attribute transcript
+        #   The transcript of the audio data from the model.
+        #
+        #   @return [String]
+        required :transcript, String
+
+        # @!attribute type
+        #   The type of the output audio. Always `output_audio`.
+        #
+        #   @return [Symbol, :output_audio]
+        required :type, const: :output_audio
+
+        # @!method initialize(data:, transcript:, type: :output_audio)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::ResponseOutputAudio} for more details.
+        #
+        #   An audio output from the model.
+        #
+        #   @param data [String] Base64-encoded audio data from the model.
+        #
+        #   @param transcript [String] The transcript of the audio data from the model.
+        #
+        #   @param type [Symbol, :output_audio] The type of the output audio. Always `output_audio`.
+      end
+    end
+  end
+end