openai 0.96.0 → 0.97.0

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

@@ -55,7 +55,7 @@ module OpenAI
         # @!attribute required_actions
         #   Actions that must be completed before the session can continue.
         #
-        #   @return [Array<OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection>]
+        #   @return [Array<OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection>]
         required(
           :required_actions,
           -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentSession::RequiredAction] }
@@ -104,7 +104,7 @@ module OpenAI
         #   @param metadata [Hash{Symbol=>String}]
         #     Custom string key-value pairs attached to the session.
         #
-        #   @param required_actions [Array<OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection>]
+        #   @param required_actions [Array<OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection>]
         #     Actions that must be completed before the session can continue.
         #
         #   @param status [Symbol, OpenAI::Models::Beta::AgentSession::Status]
@@ -174,7 +174,7 @@ module OpenAI
           # @!attribute tools
           #   Tools available to the agent.
           #
-          #   @return [Array<OpenAI::Models::Beta::AgentTool::Function, OpenAI::Models::Beta::AgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentTool::Mcp, OpenAI::Models::Beta::AgentTool::WebSearch>]
+          #   @return [Array<OpenAI::Models::Beta::AgentTool::Function, OpenAI::Models::Beta::AgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentTool::Mcp, OpenAI::Models::Beta::AgentTool::WebSearch, OpenAI::Models::Beta::AgentTool::ComputerUse>]
           required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentTool] }
 
           # @!method initialize(id:, instructions:, model:, multi_agent:, name:, reasoning:, service_tier:, text:, tools:)
@@ -205,7 +205,7 @@ module OpenAI
           #   @param text [OpenAI::Models::Beta::AgentText]
           #     Configuration for text generated by the agent.
           #
-          #   @param tools [Array<OpenAI::Models::Beta::AgentTool::Function, OpenAI::Models::Beta::AgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentTool::Mcp, OpenAI::Models::Beta::AgentTool::WebSearch>]
+          #   @param tools [Array<OpenAI::Models::Beta::AgentTool::Function, OpenAI::Models::Beta::AgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::AgentTool::Mcp, OpenAI::Models::Beta::AgentTool::WebSearch, OpenAI::Models::Beta::AgentTool::ComputerUse>]
           #     Tools available to the agent.
 
           # The effective service-tier policy for model requests. Defaults to `auto`.
@@ -232,12 +232,258 @@ module OpenAI
 
           discriminator :type
 
+          # Respond to a computer-use request.
+          variant(
+            :computer_use_approval_request,
+            -> { OpenAI::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest }
+          )
+
           # Run a function tool and submit its result.
           variant :function_call, -> { OpenAI::Beta::AgentSession::RequiredAction::FunctionCall }
 
           # Reconnect a session environment.
           variant :environment_connection, -> { OpenAI::Beta::AgentSession::RequiredAction::EnvironmentConnection }
 
+          class ComputerUseApprovalRequest < OpenAI::Internal::Type::BaseModel
+            # @!attribute request
+            #   The information needed to render the request.
+            #
+            #   @return [OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserAuthentication, OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserOriginAccess]
+            required(
+              :request,
+              union: -> { OpenAI::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request }
+            )
+
+            # @!attribute request_id
+            #   The registered request ID to echo when responding.
+            #
+            #   @return [String]
+            required :request_id, String
+
+            # @!attribute turn_id
+            #   The turn that requested approval.
+            #
+            #   @return [String]
+            required :turn_id, String
+
+            # @!attribute type
+            #   The type of the object. Always `computer_use_approval_request`.
+            #
+            #   @return [Symbol, :computer_use_approval_request]
+            required :type, const: :computer_use_approval_request
+
+            # @!method initialize(request:, request_id:, turn_id:, type: :computer_use_approval_request)
+            #   Respond to a computer-use request.
+            #
+            #   @param request [OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserAuthentication, OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserOriginAccess]
+            #     The information needed to render the request.
+            #
+            #   @param request_id [String]
+            #     The registered request ID to echo when responding.
+            #
+            #   @param turn_id [String]
+            #     The turn that requested approval.
+            #
+            #   @param type [Symbol, :computer_use_approval_request]
+            #     The type of the object. Always `computer_use_approval_request`.
+
+            # The information needed to render the request.
+            #
+            # @see OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest#request
+            module Request
+              extend OpenAI::Internal::Type::Union
+
+              discriminator :type
+
+              # A registered form awaiting the application's response.
+              variant(
+                :browser_authentication,
+                -> {
+                  OpenAI::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserAuthentication
+                }
+              )
+
+              # A browser origin awaiting the application's approval decision.
+              variant(
+                :browser_origin_access,
+                -> {
+                  OpenAI::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserOriginAccess
+                }
+              )
+
+              class BrowserAuthentication < 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::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserAuthentication::Field>]
+                required(
+                  :fields,
+                  -> do
+                    OpenAI::Internal::Type::ArrayOf[
+                      OpenAI::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserAuthentication::Field
+                    ]
+                  end
+                )
+
+                # @!attribute options
+                #   Sign-in methods. Empty for a plain form.
+                #
+                #   @return [Array<OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserAuthentication::Option>]
+                required(
+                  :options,
+                  -> do
+                    OpenAI::Internal::Type::ArrayOf[
+                      OpenAI::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserAuthentication::Option
+                    ]
+                  end
+                )
+
+                # @!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::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserAuthentication::Field>]
+                #     Controls to render. All submitted values are sensitive.
+                #
+                #   @param options [Array<OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserAuthentication::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
+
+              class BrowserOriginAccess < OpenAI::Internal::Type::BaseModel
+                # @!attribute origin
+                #   The origin the browser needs permission to access.
+                #
+                #   @return [String]
+                required :origin, String
+
+                # @!attribute reason
+                #   The browser's explanation for this request, or null when unavailable.
+                #
+                #   @return [String, nil]
+                required :reason, String, nil?: true
+
+                # @!attribute type
+                #   The type of the object. Always `browser_origin_access`.
+                #
+                #   @return [Symbol, :browser_origin_access]
+                required :type, const: :browser_origin_access
+
+                # @!method initialize(origin:, reason:, type: :browser_origin_access)
+                #   A browser origin awaiting the application's approval decision.
+                #
+                #   @param origin [String]
+                #     The origin the browser needs permission to access.
+                #
+                #   @param reason [String, nil]
+                #     The browser's explanation for this request, or null when unavailable.
+                #
+                #   @param type [Symbol, :browser_origin_access]
+                #     The type of the object. Always `browser_origin_access`.
+              end
+
+              # @!method self.variants
+              #   @return [Array(OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserAuthentication, OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest::Request::BrowserOriginAccess)]
+            end
+          end
+
           class FunctionCall < OpenAI::Internal::Type::BaseModel
             # @!attribute arguments
             #   The arguments supplied by the model.
@@ -312,7 +558,7 @@ module OpenAI
           end
 
           # @!method self.variants
-          #   @return [Array(OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection)]
+          #   @return [Array(OpenAI::Models::Beta::AgentSession::RequiredAction::ComputerUseApprovalRequest, OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection)]
         end
 
         # The current status of the session.

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

@@ -9,6 +9,12 @@ module OpenAI
 
         discriminator :type
 
+        # Responds to a pending Computer Use approval request.
+        variant(
+          :"agent.session.input.computer_use_approval_request_result",
+          -> { OpenAI::Beta::AgentSessionInputParam::AgentSessionInputComputerUseApprovalRequestResult }
+        )
+
         # Adds one or more user messages and starts a turn.
         variant(
           :"agent.session.input.message",
@@ -27,6 +33,63 @@ module OpenAI
           -> { OpenAI::Beta::AgentSessionInputParam::AgentSessionInputToolResult }
         )
 
+        class AgentSessionInputComputerUseApprovalRequestResult < OpenAI::Internal::Type::BaseModel
+          # @!attribute request_id
+          #   The registered request ID from the required action.
+          #
+          #   @return [String]
+          required :request_id, String
+
+          # @!attribute response
+          #   The response for this request type.
+          #
+          #   @return [OpenAI::Models::Beta::AgentBrowserAuthenticationSubmitParam, OpenAI::Models::Beta::AgentBrowserAuthenticationCancelParam, OpenAI::Models::Beta::AgentBrowserOriginAccessParam]
+          required(
+            :response,
+            union: -> {
+              OpenAI::Beta::AgentSessionInputParam::AgentSessionInputComputerUseApprovalRequestResult::Response
+            }
+          )
+
+          # @!attribute type
+          #   The type of the object. Always
+          #   `agent.session.input.computer_use_approval_request_result`.
+          #
+          #   @return [Symbol, :"agent.session.input.computer_use_approval_request_result"]
+          required :type, const: :"agent.session.input.computer_use_approval_request_result"
+
+          # @!method initialize(request_id:, response:, type: :"agent.session.input.computer_use_approval_request_result")
+          #   Responds to a pending Computer Use approval request.
+          #
+          #   @param request_id [String]
+          #     The registered request ID from the required action.
+          #
+          #   @param response [OpenAI::Models::Beta::AgentBrowserAuthenticationSubmitParam, OpenAI::Models::Beta::AgentBrowserAuthenticationCancelParam, OpenAI::Models::Beta::AgentBrowserOriginAccessParam]
+          #     The response for this request type.
+          #
+          #   @param type [Symbol, :"agent.session.input.computer_use_approval_request_result"]
+          #     The type of the object. Always
+          #     `agent.session.input.computer_use_approval_request_result`.
+
+          # The response for this request type.
+          #
+          # @see OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputComputerUseApprovalRequestResult#response
+          module Response
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            variant :browser_authentication, -> { OpenAI::Beta::AgentBrowserAuthenticationSubmitParam }
+
+            variant :browser_authentication, -> { OpenAI::Beta::AgentBrowserAuthenticationCancelParam }
+
+            variant :browser_origin_access, -> { OpenAI::Beta::AgentBrowserOriginAccessParam }
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Beta::AgentBrowserAuthenticationSubmitParam, OpenAI::Models::Beta::AgentBrowserAuthenticationCancelParam, OpenAI::Models::Beta::AgentBrowserOriginAccessParam)]
+          end
+        end
+
         class AgentSessionInputMessage < OpenAI::Internal::Type::BaseModel
           # @!attribute input
           #   The user messages to add to the session.
@@ -124,7 +187,7 @@ module OpenAI
         end
 
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputMessage, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputCancel, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputToolResult)]
+        #   @return [Array(OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputComputerUseApprovalRequestResult, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputMessage, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputCancel, OpenAI::Models::Beta::AgentSessionInputParam::AgentSessionInputToolResult)]
       end
     end
   end