openai 0.89.0 → 0.91.0

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentFunctionCallItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the function call item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute arguments
+        #   The arguments to pass to the function.
+        #
+        #   @return [Object]
+        required :arguments, OpenAI::Internal::Type::Unknown
+
+        # @!attribute call_id
+        #   The ID used to submit the function result.
+        #
+        #   @return [String]
+        required :call_id, String
+
+        # @!attribute name
+        #   The name of the function to call.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute status
+        #   The status of the function call.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        required :status, enum: -> { OpenAI::Beta::AgentFunctionCallStatus }
+
+        # @!attribute turn_id
+        #   The ID of the turn that contains this item.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The item type. Always `function_call`.
+        #
+        #   @return [Symbol, :function_call]
+        required :type, const: :function_call
+
+        # @!method initialize(id:, arguments:, call_id:, name:, status:, turn_id:, type: :function_call)
+        #   A function call produced by the agent.
+        #
+        #   @param id [String]
+        #     The ID of the function call item.
+        #
+        #   @param arguments [Object]
+        #     The arguments to pass to the function.
+        #
+        #   @param call_id [String]
+        #     The ID used to submit the function result.
+        #
+        #   @param name [String]
+        #     The name of the function to call.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        #     The status of the function call.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn that contains this item.
+        #
+        #   @param type [Symbol, :function_call]
+        #     The item type. Always `function_call`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The text or model-input content supplied as a function result.
+      module AgentFunctionCallOutput
+        extend OpenAI::Internal::Type::Union
+
+        variant String
+
+        variant -> { OpenAI::Models::Beta::AgentFunctionCallOutput::InputContentArray }
+
+        # @!method self.variants
+        #   @return [Array(String, Array<OpenAI::Models::Beta::InputContent::InputText, OpenAI::Models::Beta::InputContent::InputImage>)]
+
+        # @type [OpenAI::Internal::Type::Converter]
+        InputContentArray = OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Beta::InputContent }]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A function result represented as text or supported model-input content.
+      module AgentFunctionCallOutputParam
+        extend OpenAI::Internal::Type::Union
+
+        variant String
+
+        variant -> { OpenAI::Models::Beta::AgentFunctionCallOutputParam::InputContentParamArray }
+
+        # @!method self.variants
+        #   @return [Array(String, Array<OpenAI::Models::Beta::InputContentParam::InputText, OpenAI::Models::Beta::InputContentParam::InputImage>)]
+
+        # @type [OpenAI::Internal::Type::Converter]
+        InputContentParamArray = OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Beta::InputContentParam }]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The status of a tool call.
+      module AgentFunctionCallStatus
+        extend OpenAI::Internal::Type::Enum
+
+        # The call is in progress.
+        IN_PROGRESS = :in_progress
+
+        # The call completed successfully.
+        COMPLETED = :completed
+
+        # The call failed.
+        FAILED = :failed
+
+        # The call stopped before completing.
+        INCOMPLETE = :incomplete
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentInterruptSubagentCallItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the tool call item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute recipient_agent_id
+        #   The ID of the agent to interrupt.
+        #
+        #   @return [String]
+        required :recipient_agent_id, String
+
+        # @!attribute sender_agent_id
+        #   The ID of the agent requesting the interrupt.
+        #
+        #   @return [String]
+        required :sender_agent_id, String
+
+        # @!attribute status
+        #   The status of the tool call.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        required :status, enum: -> { OpenAI::Beta::AgentFunctionCallStatus }
+
+        # @!attribute turn_id
+        #   The ID of the turn that contains this item.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The item type. Always `interrupt_subagent_call`.
+        #
+        #   @return [Symbol, :interrupt_subagent_call]
+        required :type, const: :interrupt_subagent_call
+
+        # @!method initialize(id:, recipient_agent_id:, sender_agent_id:, status:, turn_id:, type: :interrupt_subagent_call)
+        #   A request to interrupt a subagent's current turn. The subagent remains
+        #   available.
+        #
+        #   @param id [String]
+        #     The ID of the tool call item.
+        #
+        #   @param recipient_agent_id [String]
+        #     The ID of the agent to interrupt.
+        #
+        #   @param sender_agent_id [String]
+        #     The ID of the agent requesting the interrupt.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        #     The status of the tool call.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn that contains this item.
+        #
+        #   @param type [Symbol, :interrupt_subagent_call]
+        #     The item type. Always `interrupt_subagent_call`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @see OpenAI::Resources::Beta::Agents#list
+      class AgentListParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute after
+        #   Return resources after this resource ID in the selected order.
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!attribute limit
+        #   The maximum number of resources to return.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer, nil?: true
+
+        # @!attribute order
+        #   The order in which resources are returned. Defaults to `desc`.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentListParams::Order, nil]
+        optional :order, enum: -> { OpenAI::Beta::AgentListParams::Order }
+
+        # @!method initialize(after: nil, limit: nil, order: nil, request_options: {})
+        #   @param after [String]
+        #     Return resources after this resource ID in the selected order.
+        #
+        #   @param limit [Integer, nil]
+        #     The maximum number of resources to return.
+        #
+        #   @param order [Symbol, OpenAI::Models::Beta::AgentListParams::Order]
+        #     The order in which resources are returned. Defaults to `desc`.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+        # The order in which resources are returned. Defaults to `desc`.
+        module Order
+          extend OpenAI::Internal::Type::Enum
+
+          # Returns resources in ascending order.
+          ASC = :asc
+
+          # Returns resources in descending order.
+          DESC = :desc
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentMcpCallItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the MCP call item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute arguments
+        #   The arguments passed to the MCP tool.
+        #
+        #   @return [Object]
+        required :arguments, OpenAI::Internal::Type::Unknown
+
+        # @!attribute error
+        #   The error returned by the MCP tool, if any.
+        #
+        #   @return [Object]
+        required :error, OpenAI::Internal::Type::Unknown
+
+        # @!attribute name
+        #   The name of the MCP tool.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute output
+        #   The output returned by the MCP tool, if any.
+        #
+        #   @return [Object]
+        required :output, OpenAI::Internal::Type::Unknown
+
+        # @!attribute server_label
+        #   The label of the MCP server.
+        #
+        #   @return [String]
+        required :server_label, String
+
+        # @!attribute status
+        #   The status of the MCP tool call.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        required :status, enum: -> { OpenAI::Beta::AgentFunctionCallStatus }
+
+        # @!attribute turn_id
+        #   The ID of the turn that contains this item.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The item type. Always `mcp_call`.
+        #
+        #   @return [Symbol, :mcp_call]
+        required :type, const: :mcp_call
+
+        # @!method initialize(id:, arguments:, error:, name:, output:, server_label:, status:, turn_id:, type: :mcp_call)
+        #   A call to a tool on an MCP server.
+        #
+        #   @param id [String]
+        #     The ID of the MCP call item.
+        #
+        #   @param arguments [Object]
+        #     The arguments passed to the MCP tool.
+        #
+        #   @param error [Object]
+        #     The error returned by the MCP tool, if any.
+        #
+        #   @param name [String]
+        #     The name of the MCP tool.
+        #
+        #   @param output [Object]
+        #     The output returned by the MCP tool, if any.
+        #
+        #   @param server_label [String]
+        #     The label of the MCP server.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        #     The status of the MCP tool call.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn that contains this item.
+        #
+        #   @param type [Symbol, :mcp_call]
+        #     The item type. Always `mcp_call`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentOutputCommandExecutionOutputDeltaEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute delta
+        #   The output text that was appended.
+        #
+        #   @return [String]
+        required :delta, String
+
+        # @!attribute event_id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :event_id, String
+
+        # @!attribute item_id
+        #   The ID of the command execution item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the item in the turn output.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute session_id
+        #   The ID of the session associated with the event.
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute turn_id
+        #   The ID of the turn associated with the event, when applicable.
+        #
+        #   @return [String, nil]
+        required :turn_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of the object. Always `agent.output.command_execution_output.delta`.
+        #
+        #   @return [Symbol, :"agent.output.command_execution_output.delta"]
+        required :type, const: :"agent.output.command_execution_output.delta"
+
+        # @!method initialize(delta:, event_id:, item_id:, output_index:, session_id:, turn_id:, type: :"agent.output.command_execution_output.delta")
+        #   Emitted when command execution produces an output delta.
+        #
+        #   @param delta [String]
+        #     The output text that was appended.
+        #
+        #   @param event_id [String]
+        #     The unique ID of the event.
+        #
+        #   @param item_id [String]
+        #     The ID of the command execution item.
+        #
+        #   @param output_index [Integer]
+        #     The index of the item in the turn output.
+        #
+        #   @param session_id [String]
+        #     The ID of the session associated with the event.
+        #
+        #   @param turn_id [String, nil]
+        #     The ID of the turn associated with the event, when applicable.
+        #
+        #   @param type [Symbol, :"agent.output.command_execution_output.delta"]
+        #     The type of the object. Always `agent.output.command_execution_output.delta`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # An output item produced by an agent.
+      module AgentOutputItem
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # An assistant message produced by the agent.
+        variant :message, -> { OpenAI::Beta::AgentSessionAssistantMessage }
+
+        # A reasoning item produced by the agent.
+        variant :reasoning, -> { OpenAI::Beta::AgentReasoningItem }
+
+        # A function call produced by the agent.
+        variant :function_call, -> { OpenAI::Beta::AgentFunctionCallItem }
+
+        # A call to a tool on an MCP server.
+        variant :mcp_call, -> { OpenAI::Beta::AgentMcpCallItem }
+
+        # A web search call produced by the agent.
+        variant :web_search_call, -> { OpenAI::Beta::AgentWebSearchCallItem }
+
+        # A command execution produced by the agent.
+        variant :command_execution, -> { OpenAI::Beta::AgentCommandExecutionItem }
+
+        # A request to spawn a subagent.
+        variant :create_subagent_call, -> { OpenAI::Beta::AgentCreateSubagentCallItem }
+
+        # A request to send input to another agent.
+        variant :send_subagent_input_call, -> { OpenAI::Beta::AgentSendSubagentInputCallItem }
+
+        # A request to resume a subagent.
+        variant :resume_subagent_call, -> { OpenAI::Beta::AgentResumeSubagentCallItem }
+
+        # A request to wait for one or more subagents.
+        variant :wait_for_subagents_call, -> { OpenAI::Beta::AgentWaitForSubagentsCallItem }
+
+        # A request to interrupt a subagent's current turn. The subagent remains available.
+        variant :interrupt_subagent_call, -> { OpenAI::Beta::AgentInterruptSubagentCallItem }
+
+        # A request to close a subagent.
+        variant :close_subagent_call, -> { OpenAI::Beta::AgentCloseSubagentCallItem }
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::AgentSessionAssistantMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentWebSearchCallItem, OpenAI::Models::Beta::AgentCommandExecutionItem, OpenAI::Models::Beta::AgentCreateSubagentCallItem, OpenAI::Models::Beta::AgentSendSubagentInputCallItem, OpenAI::Models::Beta::AgentResumeSubagentCallItem, OpenAI::Models::Beta::AgentWaitForSubagentsCallItem, OpenAI::Models::Beta::AgentInterruptSubagentCallItem, OpenAI::Models::Beta::AgentCloseSubagentCallItem)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The status of an agent output item.
+      module AgentOutputItemStatus
+        extend OpenAI::Internal::Type::Enum
+
+        # The item is in progress.
+        IN_PROGRESS = :in_progress
+
+        # The item is complete.
+        COMPLETED = :completed
+
+        # The item stopped before completing.
+        INCOMPLETE = :incomplete
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentReasoning < OpenAI::Internal::Type::BaseModel
+        # @!attribute effort
+        #   The amount of reasoning effort used by an agent.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentReasoning::Effort, nil]
+        required :effort, enum: -> { OpenAI::Beta::AgentReasoning::Effort }, nil?: true
+
+        # @!attribute summary
+        #   The reasoning summary format requested from an agent.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentReasoning::Summary, nil]
+        required :summary, enum: -> { OpenAI::Beta::AgentReasoning::Summary }, nil?: true
+
+        # @!method initialize(effort:, summary:)
+        #   The reasoning configuration used by an agent.
+        #
+        #   @param effort [Symbol, OpenAI::Models::Beta::AgentReasoning::Effort, nil]
+        #     The amount of reasoning effort used by an agent.
+        #
+        #   @param summary [Symbol, OpenAI::Models::Beta::AgentReasoning::Summary, nil]
+        #     The reasoning summary format requested from an agent.
+
+        # The amount of reasoning effort used by an agent.
+        #
+        # @see OpenAI::Models::Beta::AgentReasoning#effort
+        module Effort
+          extend OpenAI::Internal::Type::Enum
+
+          NONE = :none
+          MINIMAL = :minimal
+          LOW = :low
+          MEDIUM = :medium
+          HIGH = :high
+          XHIGH = :xhigh
+          MAX = :max
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The reasoning summary format requested from an agent.
+        #
+        # @see OpenAI::Models::Beta::AgentReasoning#summary
+        module Summary
+          extend OpenAI::Internal::Type::Enum
+
+          # Returns a concise reasoning summary when supported.
+          CONCISE = :concise
+
+          # Returns a detailed reasoning summary when supported.
+          DETAILED = :detailed
+
+          # Automatically selects the most detailed summary supported by the model.
+          AUTO = :auto
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentReasoningItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the reasoning item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute status
+        #   The status of an agent output item.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentOutputItemStatus, nil]
+        required :status, enum: -> { OpenAI::Beta::AgentOutputItemStatus }, nil?: true
+
+        # @!attribute summary
+        #   The reasoning summaries produced by the agent.
+        #
+        #   @return [Array<OpenAI::Models::Beta::SummaryText>]
+        required :summary, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::SummaryText] }
+
+        # @!attribute turn_id
+        #   The ID of the turn that contains this item.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The item type. Always `reasoning`.
+        #
+        #   @return [Symbol, :reasoning]
+        required :type, const: :reasoning
+
+        # @!method initialize(id:, status:, summary:, turn_id:, type: :reasoning)
+        #   A reasoning item produced by the agent.
+        #
+        #   @param id [String]
+        #     The ID of the reasoning item.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentOutputItemStatus, nil]
+        #     The status of an agent output item.
+        #
+        #   @param summary [Array<OpenAI::Models::Beta::SummaryText>]
+        #     The reasoning summaries produced by the agent.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn that contains this item.
+        #
+        #   @param type [Symbol, :reasoning]
+        #     The item type. Always `reasoning`.
+      end
+    end
+  end
+end