openai 0.96.0 → 0.97.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45b725bdf2e7a6b6837d634f0a91df36e77e4051d3a44019742cd9176ecf53ec
-  data.tar.gz: d42beb5a3f77a5cb8ef597fa8ce4bb80c6a5485252becedbd67ec4e65ef5f674
+  metadata.gz: ad027591f42a7f1aed3f0ac973b22b81f8d4a1171e30d311845b8ece12b0cc30
+  data.tar.gz: 70db67b389fe4053242e587dad3ea8a7fb9477f160278e213c4206cbe03d6289
 SHA512:
-  metadata.gz: 9ac89793e8ba7b821b5d98dbff7b8bf366d6ab251c06fdc2f23422347de291443267343bb5fac7c4c17e4fee1e357873681fdbd761aa16db0d6d59cca7a85c1e
-  data.tar.gz: 284f3124b3d366c6bd1ab7bc9955ed29ce4e5a6da39e08320fcc575847b7bf95f0246208cdb06042c049ef3226c2e3bae6f8551aca343f724c5ced65532b456a
+  metadata.gz: e14a2a0287715824fe9271eed406677661ac595d8b3851f2e24480b3c6d365362f067ad8e207e99cff2246cedd247f6d82a7007a487a37bd8c381dce3b8479d3
+  data.tar.gz: 647c42ecf4d655d2148e23c42253d057ffc569189541fd58333144b73663c3b4cf3adf9d9cfb51b0d98123cdabcd9c8458c2d3f8c169347e3e70a0bcc1978571

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.97.0](https://github.com/openai/openai-ruby/compare/v0.96.0...v0.97.0) (2026-09-29)
+
+
+### Features
+
+* **api:** add computer use to beta agents ([#782](https://github.com/openai/openai-ruby/issues/782)) ([c765120](https://github.com/openai/openai-ruby/commit/c765120933dfab5c9a4cfb1e5eec83faa9b35ee1))
+
 ## [0.96.0](https://github.com/openai/openai-ruby/compare/v0.95.0...v0.96.0) (2026-09-29)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openai", "~> 0.96.0"
+gem "openai", "~> 0.97.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -75,7 +75,7 @@ module OpenAI
         # @!attribute tools
         #   Tools available to the agent.
         #
-        #   @return [Array<OpenAI::Models::Beta::PersistedAgentTool::Function, OpenAI::Models::Beta::PersistedAgentTool::ToolSearch, OpenAI::Models::Beta::PersistedAgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentTool::Mcp, OpenAI::Models::Beta::PersistedAgentTool::WebSearch>]
+        #   @return [Array<OpenAI::Models::Beta::PersistedAgentTool::Function, OpenAI::Models::Beta::PersistedAgentTool::ToolSearch, OpenAI::Models::Beta::PersistedAgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentTool::Mcp, OpenAI::Models::Beta::PersistedAgentTool::WebSearch, OpenAI::Models::Beta::PersistedAgentTool::ComputerUse>]
         required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::PersistedAgentTool] }
 
         # @!attribute updated_at
@@ -118,7 +118,7 @@ module OpenAI
         #   @param text [OpenAI::Models::Beta::AgentText]
         #     The resolved configuration for text generated by the agent.
         #
-        #   @param tools [Array<OpenAI::Models::Beta::PersistedAgentTool::Function, OpenAI::Models::Beta::PersistedAgentTool::ToolSearch, OpenAI::Models::Beta::PersistedAgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentTool::Mcp, OpenAI::Models::Beta::PersistedAgentTool::WebSearch>]
+        #   @param tools [Array<OpenAI::Models::Beta::PersistedAgentTool::Function, OpenAI::Models::Beta::PersistedAgentTool::ToolSearch, OpenAI::Models::Beta::PersistedAgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentTool::Mcp, OpenAI::Models::Beta::PersistedAgentTool::WebSearch, OpenAI::Models::Beta::PersistedAgentTool::ComputerUse>]
         #     Tools available to the agent.
         #
         #   @param updated_at [Integer]

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentBrowserAuthenticationCancelParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute action
+        #
+        #   @return [Symbol, :cancel]
+        required :action, const: :cancel
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :browser_authentication]
+        required :type, const: :browser_authentication
+
+        # @!method initialize(action: :cancel, type: :browser_authentication)
+        #   @param action [Symbol, :cancel]
+        #   @param type [Symbol, :browser_authentication]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentBrowserAuthenticationSubmitParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute action
+        #
+        #   @return [Symbol, :submit]
+        required :action, const: :submit
+
+        # @!attribute fields
+        #   Values for up to six active fields in the required action. The submitted
+        #   field-value mapping and selected option must fit within 120 KiB of JSON.
+        #
+        #   @return [Array<OpenAI::Models::Beta::AgentBrowserAuthenticationSubmitParam::Field>]
+        required(
+          :fields,
+          -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::AgentBrowserAuthenticationSubmitParam::Field] }
+        )
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :browser_authentication]
+        required :type, const: :browser_authentication
+
+        # @!attribute selected_option
+        #   The chosen method. Required when the required action contains options.
+        #
+        #   @return [String, nil]
+        optional :selected_option, String, nil?: true
+
+        # @!method initialize(fields:, selected_option: nil, action: :submit, type: :browser_authentication)
+        #   @param fields [Array<OpenAI::Models::Beta::AgentBrowserAuthenticationSubmitParam::Field>]
+        #     Values for up to six active fields in the required action. The submitted
+        #     field-value mapping and selected option must fit within 120 KiB of JSON.
+        #
+        #   @param selected_option [String, nil]
+        #     The chosen method. Required when the required action contains options.
+        #
+        #   @param action [Symbol, :submit]
+        #
+        #   @param type [Symbol, :browser_authentication]
+
+        class Field < OpenAI::Internal::Type::BaseModel
+          # @!attribute field_id
+          #   The field ID from the required action.
+          #
+          #   @return [String]
+          required :field_id, String
+
+          # @!attribute value
+          #   The value to enter into the registered control.
+          #
+          #   @return [String]
+          required :value, String
+
+          # @!method initialize(field_id:, value:)
+          #   One user-entered value, including non-password fields such as an email address.
+          #
+          #   @param field_id [String]
+          #     The field ID from the required action.
+          #
+          #   @param value [String]
+          #     The value to enter into the registered control.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentBrowserOriginAccessParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute decision
+        #   Whether to allow, deny, or cancel the requested origin access.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentBrowserOriginAccessParam::Decision]
+        required :decision, enum: -> { OpenAI::Beta::AgentBrowserOriginAccessParam::Decision }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :browser_origin_access]
+        required :type, const: :browser_origin_access
+
+        # @!method initialize(decision:, type: :browser_origin_access)
+        #   @param decision [Symbol, OpenAI::Models::Beta::AgentBrowserOriginAccessParam::Decision]
+        #     Whether to allow, deny, or cancel the requested origin access.
+        #
+        #   @param type [Symbol, :browser_origin_access]
+
+        # Whether to allow, deny, or cancel the requested origin access.
+        #
+        # @see OpenAI::Models::Beta::AgentBrowserOriginAccessParam#decision
+        module Decision
+          extend OpenAI::Internal::Type::Enum
+
+          # Allow the browser to access this origin.
+          APPROVE = :approve
+
+          # Deny access to this origin.
+          DENY = :deny
+
+          # Dismiss this request without approving access.
+          CANCEL = :cancel
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -63,7 +63,7 @@ module OpenAI
         # @!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]
+        #   @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, OpenAI::Models::Beta::PersistedAgentToolParam::ComputerUse>, nil]
         optional(
           :tools,
           -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::PersistedAgentToolParam] },
@@ -99,7 +99,7 @@ module OpenAI
         #     Configuration for generated text. Defaults to the `text` format and medium
         #     verbosity.
         #
-        #   @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]
+        #   @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, OpenAI::Models::Beta::PersistedAgentToolParam::ComputerUse>, nil]
         #     Tools available to the agent. Defaults to an empty list.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]

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

@@ -21,6 +21,12 @@ module OpenAI
         # A call to a tool on an MCP server.
         variant :mcp_call, -> { OpenAI::Beta::AgentMcpCallItem }
 
+        # One execution of the platform-provided computer-use capability.
+        variant :computer_use_call, -> { OpenAI::Beta::AgentOutputItem::ComputerUseCall }
+
+        # A credential-free history record of the emitted login request.
+        variant :computer_use_approval_request, -> { OpenAI::Beta::AgentOutputItem::ComputerUseApprovalRequest }
+
         # A web search call produced by the agent.
         variant :web_search_call, -> { OpenAI::Beta::AgentWebSearchCallItem }
 
@@ -45,8 +51,277 @@ module OpenAI
         # A request to close a subagent.
         variant :close_subagent_call, -> { OpenAI::Beta::AgentCloseSubagentCallItem }
 
+        class ComputerUseCall < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the activity item.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute output
+          #   The last screenshot emitted by the model. Null when screenshot inclusion is
+          #   disabled or the call emitted no screenshot.
+          #
+          #   @return [OpenAI::Models::Beta::AgentOutputItem::ComputerUseCall::Output, nil]
+          required :output, -> { OpenAI::Beta::AgentOutputItem::ComputerUseCall::Output }, nil?: true
+
+          # @!attribute status
+          #   The execution status of the activity.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+          required :status, enum: -> { OpenAI::Beta::AgentFunctionCallStatus }
+
+          # @!attribute title
+          #   A model-generated description of the activity, when available.
+          #
+          #   @return [String, nil]
+          required :title, String, nil?: true
+
+          # @!attribute turn_id
+          #   The ID of the turn that contains this item.
+          #
+          #   @return [String]
+          required :turn_id, String
+
+          # @!attribute type
+          #   The item type. Always `computer_use_call`.
+          #
+          #   @return [Symbol, :computer_use_call]
+          required :type, const: :computer_use_call
+
+          # @!method initialize(id:, output:, status:, title:, turn_id:, type: :computer_use_call)
+          #   One execution of the platform-provided computer-use capability.
+          #
+          #   @param id [String]
+          #     The ID of the activity item.
+          #
+          #   @param output [OpenAI::Models::Beta::AgentOutputItem::ComputerUseCall::Output, nil]
+          #     The last screenshot emitted by the model. Null when screenshot inclusion is
+          #     disabled or the call emitted no screenshot.
+          #
+          #   @param status [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+          #     The execution status of the activity.
+          #
+          #   @param title [String, nil]
+          #     A model-generated description of the activity, when available.
+          #
+          #   @param turn_id [String]
+          #     The ID of the turn that contains this item.
+          #
+          #   @param type [Symbol, :computer_use_call]
+          #     The item type. Always `computer_use_call`.
+
+          # @see OpenAI::Models::Beta::AgentOutputItem::ComputerUseCall#output
+          class Output < OpenAI::Internal::Type::BaseModel
+            # @!attribute image_url
+            #   The complete JPEG image as a base64 data URL.
+            #
+            #   @return [String]
+            required :image_url, String
+
+            # @!attribute type
+            #   The content type. Always `computer_screenshot`.
+            #
+            #   @return [Symbol, :computer_screenshot]
+            required :type, const: :computer_screenshot
+
+            # @!method initialize(image_url:, type: :computer_screenshot)
+            #   The last screenshot emitted by the model. Null when screenshot inclusion is
+            #   disabled or the call emitted no screenshot.
+            #
+            #   @param image_url [String]
+            #     The complete JPEG image as a base64 data URL.
+            #
+            #   @param type [Symbol, :computer_screenshot]
+            #     The content type. Always `computer_screenshot`.
+          end
+        end
+
+        class ComputerUseApprovalRequest < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The stable history item ID.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute request
+          #   A registered form awaiting the application's response.
+          #
+          #   @return [OpenAI::Models::Beta::AgentOutputItem::ComputerUseApprovalRequest::Request]
+          required :request, -> { OpenAI::Beta::AgentOutputItem::ComputerUseApprovalRequest::Request }
+
+          # @!attribute request_id
+          #
+          #   @return [String]
+          required :request_id, String
+
+          # @!attribute turn_id
+          #
+          #   @return [String]
+          required :turn_id, String
+
+          # @!attribute type
+          #   The item type. Always computer_use_approval_request.
+          #
+          #   @return [Symbol, :computer_use_approval_request]
+          required :type, const: :computer_use_approval_request
+
+          # @!method initialize(id:, request:, request_id:, turn_id:, type: :computer_use_approval_request)
+          #   A credential-free history record of the emitted login request.
+          #
+          #   @param id [String]
+          #     The stable history item ID.
+          #
+          #   @param request [OpenAI::Models::Beta::AgentOutputItem::ComputerUseApprovalRequest::Request]
+          #     A registered form awaiting the application's response.
+          #
+          #   @param request_id [String]
+          #
+          #   @param turn_id [String]
+          #
+          #   @param type [Symbol, :computer_use_approval_request]
+          #     The item type. Always computer_use_approval_request.
+
+          # @see OpenAI::Models::Beta::AgentOutputItem::ComputerUseApprovalRequest#request
+          class Request < OpenAI::Internal::Type::BaseModel
+            # @!attribute credential_origin
+            #   The registered form or frame origin where values will be entered.
+            #
+            #   @return [String, nil]
+            required :credential_origin, String, nil?: true
+
+            # @!attribute fields
+            #   Controls to render. All submitted values are sensitive.
+            #
+            #   @return [Array<OpenAI::Models::Beta::AgentOutputItem::ComputerUseApprovalRequest::Request::Field>]
+            required(
+              :fields,
+              -> {
+                OpenAI::Internal::Type::ArrayOf[
+                  OpenAI::Beta::AgentOutputItem::ComputerUseApprovalRequest::Request::Field
+                ]
+              }
+            )
+
+            # @!attribute options
+            #   Sign-in methods. Empty for a plain form.
+            #
+            #   @return [Array<OpenAI::Models::Beta::AgentOutputItem::ComputerUseApprovalRequest::Request::Option>]
+            required(
+              :options,
+              -> {
+                OpenAI::Internal::Type::ArrayOf[
+                  OpenAI::Beta::AgentOutputItem::ComputerUseApprovalRequest::Request::Option
+                ]
+              }
+            )
+
+            # @!attribute reason
+            #   Why the agent needs the user to sign in.
+            #
+            #   @return [String, nil]
+            required :reason, String, nil?: true
+
+            # @!attribute type
+            #   The type of the object. Always `browser_authentication`.
+            #
+            #   @return [Symbol, :browser_authentication]
+            required :type, const: :browser_authentication
+
+            # @!method initialize(credential_origin:, fields:, options:, reason:, type: :browser_authentication)
+            #   A registered form awaiting the application's response.
+            #
+            #   @param credential_origin [String, nil]
+            #     The registered form or frame origin where values will be entered.
+            #
+            #   @param fields [Array<OpenAI::Models::Beta::AgentOutputItem::ComputerUseApprovalRequest::Request::Field>]
+            #     Controls to render. All submitted values are sensitive.
+            #
+            #   @param options [Array<OpenAI::Models::Beta::AgentOutputItem::ComputerUseApprovalRequest::Request::Option>]
+            #     Sign-in methods. Empty for a plain form.
+            #
+            #   @param reason [String, nil]
+            #     Why the agent needs the user to sign in.
+            #
+            #   @param type [Symbol, :browser_authentication]
+            #     The type of the object. Always `browser_authentication`.
+            class Field < OpenAI::Internal::Type::BaseModel
+              # @!attribute id
+              #   The field ID to submit as field_id in a fields entry.
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute label
+              #   The label to display beside the control.
+              #
+              #   @return [String]
+              required :label, String
+
+              # @!attribute required
+              #   Whether this control requires a nonempty value.
+              #
+              #   @return [Boolean]
+              required :required, OpenAI::Internal::Type::Boolean
+
+              # @!attribute type
+              #   The rendering type, such as email, password, or text.
+              #
+              #   @return [String]
+              required :type, String
+
+              # @!method initialize(id:, label:, required:, type:)
+              #   A control in a registered browser-login form.
+              #
+              #   @param id [String]
+              #     The field ID to submit as field_id in a fields entry.
+              #
+              #   @param label [String]
+              #     The label to display beside the control.
+              #
+              #   @param required [Boolean]
+              #     Whether this control requires a nonempty value.
+              #
+              #   @param type [String]
+              #     The rendering type, such as email, password, or text.
+            end
+
+            class Option < OpenAI::Internal::Type::BaseModel
+              # @!attribute id
+              #   The option ID to submit as selected_option.
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute field_ids
+              #   IDs from the registered fields that this method accepts.
+              #
+              #   @return [Array<String>]
+              required :field_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+              # @!attribute label
+              #   The method label to display.
+              #
+              #   @return [String]
+              required :label, String
+
+              # @!method initialize(id:, field_ids:, label:)
+              #   A sign-in method and the fields that belong to it.
+              #
+              #   @param id [String]
+              #     The option ID to submit as selected_option.
+              #
+              #   @param field_ids [Array<String>]
+              #     IDs from the registered fields that this method accepts.
+              #
+              #   @param label [String]
+              #     The method label to display.
+            end
+          end
+        end
+
         # @!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)]
+        #   @return [Array(OpenAI::Models::Beta::AgentSessionAssistantMessage, OpenAI::Models::Beta::AgentReasoningItem, OpenAI::Models::Beta::AgentFunctionCallItem, OpenAI::Models::Beta::AgentMcpCallItem, OpenAI::Models::Beta::AgentOutputItem::ComputerUseCall, OpenAI::Models::Beta::AgentOutputItem::ComputerUseApprovalRequest, 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