openai 0.68.0 → 0.69.0

data/lib/openai/models/beta/beta_response_content_part_done_event.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseContentPartDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute content_index
+        #   The index of the content part that is done.
+        #
+        #   @return [Integer]
+        required :content_index, Integer
+
+        # @!attribute item_id
+        #   The ID of the output item that the content part was added to.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that the content part was added to.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute part
+        #   The content part that is done.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent::Part::ReasoningText]
+        required :part, union: -> { OpenAI::Beta::BetaResponseContentPartDoneEvent::Part }
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.content_part.done`.
+        #
+        #   @return [Symbol, :"response.content_part.done"]
+        required :type, const: :"response.content_part.done"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseContentPartDoneEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseContentPartDoneEvent::Agent }, nil?: true
+
+        # @!method initialize(content_index:, item_id:, output_index:, part:, sequence_number:, agent: nil, type: :"response.content_part.done")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseContentPartDoneEvent} for more details.
+        #
+        #   Emitted when a content part is done.
+        #
+        #   @param content_index [Integer] The index of the content part that is done.
+        #
+        #   @param item_id [String] The ID of the output item that the content part was added to.
+        #
+        #   @param output_index [Integer] The index of the output item that the content part was added to.
+        #
+        #   @param part [OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent::Part::ReasoningText] The content part that is done.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseContentPartDoneEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.content_part.done"] The type of the event. Always `response.content_part.done`.
+
+        # The content part that is done.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseContentPartDoneEvent#part
+        module Part
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          # A text output from the model.
+          variant :output_text, -> { OpenAI::Beta::BetaResponseOutputText }
+
+          # A refusal from the model.
+          variant :refusal, -> { OpenAI::Beta::BetaResponseOutputRefusal }
+
+          # Reasoning text from the model.
+          variant :reasoning_text, -> { OpenAI::Beta::BetaResponseContentPartDoneEvent::Part::ReasoningText }
+
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            # @!attribute text
+            #   The reasoning text from the model.
+            #
+            #   @return [String]
+            required :text, String
+
+            # @!attribute type
+            #   The type of the reasoning text. Always `reasoning_text`.
+            #
+            #   @return [Symbol, :reasoning_text]
+            required :type, const: :reasoning_text
+
+            # @!method initialize(text:, type: :reasoning_text)
+            #   Reasoning text from the model.
+            #
+            #   @param text [String] The reasoning text from the model.
+            #
+            #   @param type [Symbol, :reasoning_text] The type of the reasoning text. Always `reasoning_text`.
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::BetaResponseOutputText, OpenAI::Models::Beta::BetaResponseOutputRefusal, OpenAI::Models::Beta::BetaResponseContentPartDoneEvent::Part::ReasoningText)]
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseContentPartDoneEvent#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that owns this multi-agent streaming event.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseContentPartDoneEvent = Beta::BetaResponseContentPartDoneEvent
+  end
+end

data/lib/openai/models/beta/beta_response_conversation_param.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseConversationParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the conversation.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The conversation that this response belongs to.
+        #
+        #   @param id [String] The unique ID of the conversation.
+      end
+    end
+
+    BetaResponseConversationParam = Beta::BetaResponseConversationParam
+  end
+end

data/lib/openai/models/beta/beta_response_created_event.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseCreatedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute response
+        #   The response that was created.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponse]
+        required :response, -> { OpenAI::Beta::BetaResponse }
+
+        # @!attribute sequence_number
+        #   The sequence number for this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.created`.
+        #
+        #   @return [Symbol, :"response.created"]
+        required :type, const: :"response.created"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseCreatedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseCreatedEvent::Agent }, nil?: true
+
+        # @!method initialize(response:, sequence_number:, agent: nil, type: :"response.created")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseCreatedEvent} for more details.
+        #
+        #   An event that is emitted when a response is created.
+        #
+        #   @param response [OpenAI::Models::Beta::BetaResponse] The response that was created.
+        #
+        #   @param sequence_number [Integer] The sequence number for this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseCreatedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.created"] The type of the event. Always `response.created`.
+
+        # @see OpenAI::Models::Beta::BetaResponseCreatedEvent#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that owns this multi-agent streaming event.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseCreatedEvent = Beta::BetaResponseCreatedEvent
+  end
+end

data/lib/openai/models/beta/beta_response_custom_tool_call.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseCustomToolCall < OpenAI::Internal::Type::BaseModel
+        # @!attribute call_id
+        #   An identifier used to map this custom tool call to a tool call output.
+        #
+        #   @return [String]
+        required :call_id, String
+
+        # @!attribute input
+        #   The input for the custom tool call generated by the model.
+        #
+        #   @return [String]
+        required :input, String
+
+        # @!attribute name
+        #   The name of the custom tool being called.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   The type of the custom tool call. Always `custom_tool_call`.
+        #
+        #   @return [Symbol, :custom_tool_call]
+        required :type, const: :custom_tool_call
+
+        # @!attribute id
+        #   The unique ID of the custom tool call in the OpenAI platform.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute agent
+        #   The agent that produced this item.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseCustomToolCall::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseCustomToolCall::Agent }, nil?: true
+
+        # @!attribute caller_
+        #   The execution context that produced this tool call.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseCustomToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseCustomToolCall::Caller::Program, nil]
+        optional :caller_,
+                 union: -> { OpenAI::Beta::BetaResponseCustomToolCall::Caller },
+                 api_name: :caller,
+                 nil?: true
+
+        # @!attribute namespace
+        #   The namespace of the custom tool being called.
+        #
+        #   @return [String, nil]
+        optional :namespace, String
+
+        # @!method initialize(call_id:, input:, name:, id: nil, agent: nil, caller_: nil, namespace: nil, type: :custom_tool_call)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseCustomToolCall} for more details.
+        #
+        #   A call to a custom tool created by the model.
+        #
+        #   @param call_id [String] An identifier used to map this custom tool call to a tool call output.
+        #
+        #   @param input [String] The input for the custom tool call generated by the model.
+        #
+        #   @param name [String] The name of the custom tool being called.
+        #
+        #   @param id [String] The unique ID of the custom tool call in the OpenAI platform.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseCustomToolCall::Agent, nil] The agent that produced this item.
+        #
+        #   @param caller_ [OpenAI::Models::Beta::BetaResponseCustomToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseCustomToolCall::Caller::Program, nil] The execution context that produced this tool call.
+        #
+        #   @param namespace [String] The namespace of the custom tool being called.
+        #
+        #   @param type [Symbol, :custom_tool_call] The type of the custom tool call. Always `custom_tool_call`.
+
+        # @see OpenAI::Models::Beta::BetaResponseCustomToolCall#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that produced this item.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+
+        # The execution context that produced this tool call.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseCustomToolCall#caller_
+        module Caller
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          variant :direct, -> { OpenAI::Beta::BetaResponseCustomToolCall::Caller::Direct }
+
+          variant :program, -> { OpenAI::Beta::BetaResponseCustomToolCall::Caller::Program }
+
+          class Direct < OpenAI::Internal::Type::BaseModel
+            # @!attribute type
+            #
+            #   @return [Symbol, :direct]
+            required :type, const: :direct
+
+            # @!method initialize(type: :direct)
+            #   @param type [Symbol, :direct]
+          end
+
+          class Program < OpenAI::Internal::Type::BaseModel
+            # @!attribute caller_id
+            #   The call ID of the program item that produced this tool call.
+            #
+            #   @return [String]
+            required :caller_id, String
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :program]
+            required :type, const: :program
+
+            # @!method initialize(caller_id:, type: :program)
+            #   @param caller_id [String] The call ID of the program item that produced this tool call.
+            #
+            #   @param type [Symbol, :program]
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::BetaResponseCustomToolCall::Caller::Direct, OpenAI::Models::Beta::BetaResponseCustomToolCall::Caller::Program)]
+        end
+      end
+    end
+
+    BetaResponseCustomToolCall = Beta::BetaResponseCustomToolCall
+  end
+end

data/lib/openai/models/beta/beta_response_custom_tool_call_input_delta_event.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseCustomToolCallInputDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute delta
+        #   The incremental input data (delta) for the custom tool call.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute item_id
+        #   Unique identifier for the API item associated with this event.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output this delta applies to.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The event type identifier.
+        #
+        #   @return [Symbol, :"response.custom_tool_call_input.delta"]
+        required :type, const: :"response.custom_tool_call_input.delta"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseCustomToolCallInputDeltaEvent::Agent }, nil?: true
+
+        # @!method initialize(delta:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.custom_tool_call_input.delta")
+        #   Event representing a delta (partial update) to the input of a custom tool call.
+        #
+        #   @param delta [String] The incremental input data (delta) for the custom tool call.
+        #
+        #   @param item_id [String] Unique identifier for the API item associated with this event.
+        #
+        #   @param output_index [Integer] The index of the output this delta applies to.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.custom_tool_call_input.delta"] The event type identifier.
+
+        # @see OpenAI::Models::Beta::BetaResponseCustomToolCallInputDeltaEvent#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that owns this multi-agent streaming event.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseCustomToolCallInputDeltaEvent = Beta::BetaResponseCustomToolCallInputDeltaEvent
+  end
+end

data/lib/openai/models/beta/beta_response_custom_tool_call_input_done_event.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseCustomToolCallInputDoneEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute input
+        #   The complete input data for the custom tool call.
+        #
+        #   @return [String]
+        required :input, String
+
+        # @!attribute item_id
+        #   Unique identifier for the API item associated with this event.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output this event applies to.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The event type identifier.
+        #
+        #   @return [Symbol, :"response.custom_tool_call_input.done"]
+        required :type, const: :"response.custom_tool_call_input.done"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseCustomToolCallInputDoneEvent::Agent }, nil?: true
+
+        # @!method initialize(input:, item_id:, output_index:, sequence_number:, agent: nil, type: :"response.custom_tool_call_input.done")
+        #   Event indicating that input for a custom tool call is complete.
+        #
+        #   @param input [String] The complete input data for the custom tool call.
+        #
+        #   @param item_id [String] Unique identifier for the API item associated with this event.
+        #
+        #   @param output_index [Integer] The index of the output this event applies to.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.custom_tool_call_input.done"] The event type identifier.
+
+        # @see OpenAI::Models::Beta::BetaResponseCustomToolCallInputDoneEvent#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that owns this multi-agent streaming event.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseCustomToolCallInputDoneEvent = Beta::BetaResponseCustomToolCallInputDoneEvent
+  end
+end

data/lib/openai/models/beta/beta_response_custom_tool_call_item.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseCustomToolCallItem < OpenAI::Models::Beta::BetaResponseCustomToolCall
+        # @!attribute id
+        #   The unique ID of the custom tool call item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute status
+        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are returned via API.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseCustomToolCallItem::Status]
+        required :status, enum: -> { OpenAI::Beta::BetaResponseCustomToolCallItem::Status }
+
+        # @!attribute created_by
+        #   The identifier of the actor that created the item.
+        #
+        #   @return [String, nil]
+        optional :created_by, String
+
+        # @!method initialize(id:, status:, created_by: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseCustomToolCallItem} for more details.
+        #
+        #   A call to a custom tool created by the model.
+        #
+        #   @param id [String] The unique ID of the custom tool call item.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseCustomToolCallItem::Status] The status of the item. One of `in_progress`, `completed`, or
+        #
+        #   @param created_by [String] The identifier of the actor that created the item.
+
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS = :in_progress
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaResponseCustomToolCallItem = Beta::BetaResponseCustomToolCallItem
+  end
+end