openai 0.89.0 → 0.90.0

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A plaintext or encrypted content part exchanged between agents.
+      module AgentContent
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A text content part produced by the agent.
+        variant :output_text, -> { OpenAI::Beta::OutputText }
+
+        # Encrypted content exchanged between agents.
+        variant :encrypted_content, -> { OpenAI::Beta::AgentContent::EncryptedContent }
+
+        class EncryptedContent < OpenAI::Internal::Type::BaseModel
+          # @!attribute encrypted_content
+          #   The encrypted content payload.
+          #
+          #   @return [String]
+          required :encrypted_content, String
+
+          # @!attribute type
+          #   The content type. Always `encrypted_content`.
+          #
+          #   @return [Symbol, :encrypted_content]
+          required :type, const: :encrypted_content
+
+          # @!method initialize(encrypted_content:, type: :encrypted_content)
+          #   Encrypted content exchanged between agents.
+          #
+          #   @param encrypted_content [String]
+          #     The encrypted content payload.
+          #
+          #   @param type [Symbol, :encrypted_content]
+          #     The content type. Always `encrypted_content`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::OutputText, OpenAI::Models::Beta::AgentContent::EncryptedContent)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @see OpenAI::Resources::Beta::Agents#create
+      class AgentCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute model
+        #   The model to use for the agent. The requested model name is preserved.
+        #
+        #   @return [String]
+        required :model, String
+
+        # @!attribute instructions
+        #   Additional instructions appended to the agent's default base instructions. Omit
+        #   or set to null to add no custom instructions.
+        #
+        #   @return [String, nil]
+        optional :instructions, String, nil?: true
+
+        # @!attribute metadata
+        #   Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+        #   characters. Omission or null defaults to an empty map.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+        # @!attribute multi_agent
+        #   Explicit configuration for creating and coordinating subagents.
+        #
+        #   @return [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
+        optional :multi_agent, -> { OpenAI::Beta::MultiAgentConfigParam }, nil?: true
+
+        # @!attribute name
+        #   A human-readable name for the agent. Omission or null leaves the agent unnamed.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute reasoning
+        #   Reasoning configuration for the agent.
+        #
+        #   @return [OpenAI::Models::Beta::AgentReasoningParam, nil]
+        optional :reasoning, -> { OpenAI::Beta::AgentReasoningParam }, nil?: true
+
+        # @!attribute service_tier
+        #   The service tier used for model requests.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentCreateParams::ServiceTier, nil]
+        optional :service_tier, enum: -> { OpenAI::Beta::AgentCreateParams::ServiceTier }, nil?: true
+
+        # @!attribute text
+        #   Configuration for text generated by the agent.
+        #
+        #   @return [OpenAI::Models::Beta::AgentTextParam, nil]
+        optional :text, -> { OpenAI::Beta::AgentTextParam }, nil?: true
+
+        # @!attribute tools
+        #   Tools available to the agent. Defaults to an empty list.
+        #
+        #   @return [Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil]
+        optional(
+          :tools,
+          -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::PersistedAgentToolParam] },
+          nil?: true
+        )
+
+        # @!method initialize(model:, instructions: nil, metadata: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
+        #   @param model [String]
+        #     The model to use for the agent. The requested model name is preserved.
+        #
+        #   @param instructions [String, nil]
+        #     Additional instructions appended to the agent's default base instructions. Omit
+        #     or set to null to add no custom instructions.
+        #
+        #   @param metadata [Hash{Symbol=>String}, nil]
+        #     Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+        #     characters. Omission or null defaults to an empty map.
+        #
+        #   @param multi_agent [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
+        #     Explicit configuration for creating and coordinating subagents.
+        #
+        #   @param name [String, nil]
+        #     A human-readable name for the agent. Omission or null leaves the agent unnamed.
+        #
+        #   @param reasoning [OpenAI::Models::Beta::AgentReasoningParam, nil]
+        #     Reasoning configuration for the agent.
+        #
+        #   @param service_tier [Symbol, OpenAI::Models::Beta::AgentCreateParams::ServiceTier, nil]
+        #     The service tier used for model requests.
+        #
+        #   @param text [OpenAI::Models::Beta::AgentTextParam, nil]
+        #     Configuration for text generated by the agent.
+        #
+        #   @param tools [Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil]
+        #     Tools available to the agent. Defaults to an empty list.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+        # The service tier used for model requests.
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          # Selects the service tier automatically.
+          AUTO = :auto
+
+          # Uses the default service tier.
+          DEFAULT = :default
+
+          # Uses the flex service tier.
+          FLEX = :flex
+
+          # Uses the priority service tier.
+          PRIORITY = :priority
+
+          # Uses the fast service tier.
+          FAST = :fast
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentCreateSubagentCallItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the tool call item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute agent_id
+        #   The ID of the agent that requested the subagent.
+        #
+        #   @return [String]
+        required :agent_id, String
+
+        # @!attribute content
+        #   The task given to the spawned agent.
+        #
+        #   @return [Array<OpenAI::Models::Beta::OutputText, OpenAI::Models::Beta::AgentContent::EncryptedContent>]
+        required :content, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentContent] }
+
+        # @!attribute model
+        #   The model requested for the spawned agent.
+        #
+        #   @return [String, nil]
+        required :model, String, nil?: true
+
+        # @!attribute reasoning_effort
+        #   The reasoning effort requested for the spawned agent.
+        #
+        #   @return [String, nil]
+        required :reasoning_effort, String, nil?: true
+
+        # @!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 `create_subagent_call`.
+        #
+        #   @return [Symbol, :create_subagent_call]
+        required :type, const: :create_subagent_call
+
+        # @!method initialize(id:, agent_id:, content:, model:, reasoning_effort:, status:, turn_id:, type: :create_subagent_call)
+        #   A request to spawn a subagent.
+        #
+        #   @param id [String]
+        #     The ID of the tool call item.
+        #
+        #   @param agent_id [String]
+        #     The ID of the agent that requested the subagent.
+        #
+        #   @param content [Array<OpenAI::Models::Beta::OutputText, OpenAI::Models::Beta::AgentContent::EncryptedContent>]
+        #     The task given to the spawned agent.
+        #
+        #   @param model [String, nil]
+        #     The model requested for the spawned agent.
+        #
+        #   @param reasoning_effort [String, nil]
+        #     The reasoning effort requested for the spawned agent.
+        #
+        #   @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, :create_subagent_call]
+        #     The item type. Always `create_subagent_call`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @see OpenAI::Resources::Beta::Agents#delete
+      class AgentDeleteParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute agent_id
+        #
+        #   @return [String]
+        required :agent_id, String
+
+        # @!method initialize(agent_id:, request_options: {})
+        #   @param agent_id [String]
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @see OpenAI::Resources::Beta::Agents#delete
+      class AgentDeleted < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the deleted agent.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute deleted
+        #   Whether the agent was deleted. Always `true`.
+        #
+        #   @return [Boolean]
+        required :deleted, OpenAI::Internal::Type::Boolean
+
+        # @!attribute object
+        #   The object type. Always `agent.deleted`.
+        #
+        #   @return [Symbol, :"agent.deleted"]
+        required :object, const: :"agent.deleted"
+
+        # @!method initialize(id:, deleted:, object: :"agent.deleted")
+        #   A deleted reusable agent.
+        #
+        #   @param id [String]
+        #     The ID of the deleted agent.
+        #
+        #   @param deleted [Boolean]
+        #     Whether the agent was deleted. Always `true`.
+        #
+        #   @param object [Symbol, :"agent.deleted"]
+        #     The object type. Always `agent.deleted`.
+      end
+    end
+  end
+end

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