openai 0.96.0 → 0.97.0

data/sig/openai/models/beta/agent_session_item.rbs

@@ -8,6 +8,9 @@ module OpenAI
         | OpenAI::Beta::AgentSessionItem::FunctionCallOutput
         | OpenAI::Beta::AgentSessionItem::AgentMessage
         | OpenAI::Beta::AgentMcpCallItem
+        | OpenAI::Beta::AgentSessionItem::ComputerUseCall
+        | OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest
+        | OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult
         | OpenAI::Beta::AgentWebSearchCallItem
         | OpenAI::Beta::AgentCommandExecutionItem
         | OpenAI::Beta::AgentCreateSubagentCallItem
@@ -148,6 +151,365 @@ module OpenAI
           }
         end
 
+        type computer_use_call =
+          {
+            id: String,
+            output: OpenAI::Beta::AgentSessionItem::ComputerUseCall::Output?,
+            status: OpenAI::Models::Beta::agent_function_call_status,
+            title: String?,
+            turn_id: String,
+            ?type: :computer_use_call
+          }
+
+        class ComputerUseCall < OpenAI::Internal::Type::BaseModel
+          # The ID of the activity item.
+          attr_accessor id: String
+
+          # The last screenshot emitted by the model. Null when screenshot inclusion is
+          # disabled or the call emitted no screenshot.
+          attr_accessor output: OpenAI::Beta::AgentSessionItem::ComputerUseCall::Output?
+
+          # The execution status of the activity.
+          attr_accessor status: OpenAI::Models::Beta::agent_function_call_status
+
+          # A model-generated description of the activity, when available.
+          attr_accessor title: String?
+
+          # The ID of the turn that contains this item.
+          attr_accessor turn_id: String
+
+          # The item type. Always `computer_use_call`.
+          attr_accessor type: :computer_use_call
+
+          # @param id
+          #   The ID of the activity item.
+          # @param output
+          #   The last screenshot emitted by the model. Null when screenshot inclusion is
+          #   disabled or the call emitted no screenshot.
+          # @param status
+          #   The execution status of the activity.
+          # @param title
+          #   A model-generated description of the activity, when available.
+          # @param turn_id
+          #   The ID of the turn that contains this item.
+          # @param type
+          #   The item type. Always `computer_use_call`.
+          def initialize: (
+            id: String,
+            output: OpenAI::Beta::AgentSessionItem::ComputerUseCall::Output?,
+            status: OpenAI::Models::Beta::agent_function_call_status,
+            title: String?,
+            turn_id: String,
+            ?type: :computer_use_call
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            output: OpenAI::Beta::AgentSessionItem::ComputerUseCall::Output?,
+            status: OpenAI::Models::Beta::agent_function_call_status,
+            title: String?,
+            turn_id: String,
+            ?type: :computer_use_call
+          }
+
+          type output = { image_url: String, ?type: :computer_screenshot }
+
+          class Output < OpenAI::Internal::Type::BaseModel
+            # The complete JPEG image as a base64 data URL.
+            attr_accessor image_url: String
+
+            # The content type. Always `computer_screenshot`.
+            attr_accessor type: :computer_screenshot
+
+            # @param image_url
+            #   The complete JPEG image as a base64 data URL.
+            # @param type
+            #   The content type. Always `computer_screenshot`.
+            def initialize: (
+              image_url: String,
+              ?type: :computer_screenshot
+            ) -> void
+
+            def to_hash: -> { image_url: String, ?type: :computer_screenshot }
+          end
+        end
+
+        type computer_use_approval_request =
+          {
+            id: String,
+            request: OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request,
+            request_id: String,
+            turn_id: String,
+            ?type: :computer_use_approval_request
+          }
+
+        class ComputerUseApprovalRequest < OpenAI::Internal::Type::BaseModel
+          # The stable history item ID.
+          attr_accessor id: String
+
+          # A registered form awaiting the application's response.
+          attr_accessor request: OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request
+
+          attr_accessor request_id: String
+
+          attr_accessor turn_id: String
+
+          # The item type. Always computer_use_approval_request.
+          attr_accessor type: :computer_use_approval_request
+
+          # @param id
+          #   The stable history item ID.
+          # @param request
+          #   A registered form awaiting the application's response.
+          # @param type
+          #   The item type. Always computer_use_approval_request.
+          def initialize: (
+            id: String,
+            request: OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request,
+            request_id: String,
+            turn_id: String,
+            ?type: :computer_use_approval_request
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            request: OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request,
+            request_id: String,
+            turn_id: String,
+            ?type: :computer_use_approval_request
+          }
+
+          type request =
+            {
+              credential_origin: String?,
+              fields: ::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Field],
+              options: ::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Option],
+              reason: String?,
+              ?type: :browser_authentication
+            }
+
+          class Request < OpenAI::Internal::Type::BaseModel
+            # The registered form or frame origin where values will be entered.
+            attr_accessor credential_origin: String?
+
+            # Controls to render. All submitted values are sensitive.
+            attr_accessor fields: ::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Field]
+
+            # Sign-in methods. Empty for a plain form.
+            attr_accessor options: ::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Option]
+
+            # Why the agent needs the user to sign in.
+            attr_accessor reason: String?
+
+            # The type of the object. Always `browser_authentication`.
+            attr_accessor type: :browser_authentication
+
+            # @param credential_origin
+            #   The registered form or frame origin where values will be entered.
+            # @param fields
+            #   Controls to render. All submitted values are sensitive.
+            # @param options
+            #   Sign-in methods. Empty for a plain form.
+            # @param reason
+            #   Why the agent needs the user to sign in.
+            # @param type
+            #   The type of the object. Always `browser_authentication`.
+            def initialize: (
+              credential_origin: String?,
+              fields: ::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Field],
+              options: ::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Option],
+              reason: String?,
+              ?type: :browser_authentication
+            ) -> void
+
+            def to_hash: -> {
+              credential_origin: String?,
+              fields: ::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Field],
+              options: ::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Option],
+              reason: String?,
+              ?type: :browser_authentication
+            }
+
+            type field =
+              { id: String, label: String, required: bool, type: String }
+
+            class Field < OpenAI::Internal::Type::BaseModel
+              # The field ID to submit as field_id in a fields entry.
+              attr_accessor id: String
+
+              # The label to display beside the control.
+              attr_accessor label: String
+
+              # Whether this control requires a nonempty value.
+              attr_accessor required: bool
+
+              # The rendering type, such as email, password, or text.
+              attr_accessor type: String
+
+              # @param id
+              #   The field ID to submit as field_id in a fields entry.
+              # @param label
+              #   The label to display beside the control.
+              # @param required
+              #   Whether this control requires a nonempty value.
+              # @param type
+              #   The rendering type, such as email, password, or text.
+              def initialize: (
+                id: String,
+                label: String,
+                required: bool,
+                type: String
+              ) -> void
+
+              def to_hash: -> {
+                id: String,
+                label: String,
+                required: bool,
+                type: String
+              }
+            end
+
+            type option =
+              { id: String, field_ids: ::Array[String], label: String }
+
+            class Option < OpenAI::Internal::Type::BaseModel
+              # The option ID to submit as selected_option.
+              attr_accessor id: String
+
+              # IDs from the registered fields that this method accepts.
+              attr_accessor field_ids: ::Array[String]
+
+              # The method label to display.
+              attr_accessor label: String
+
+              # @param id
+              #   The option ID to submit as selected_option.
+              # @param field_ids
+              #   IDs from the registered fields that this method accepts.
+              # @param label
+              #   The method label to display.
+              def initialize: (
+                id: String,
+                field_ids: ::Array[String],
+                label: String
+              ) -> void
+
+              def to_hash: -> {
+                id: String,
+                field_ids: ::Array[String],
+                label: String
+              }
+            end
+          end
+        end
+
+        type computer_use_approval_request_result =
+          {
+            id: String,
+            request_id: String,
+            response: OpenAI::Models::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::response,
+            turn_id: String,
+            ?type: :computer_use_approval_request_result
+          }
+
+        class ComputerUseApprovalRequestResult < OpenAI::Internal::Type::BaseModel
+          # The stable history item ID.
+          attr_accessor id: String
+
+          # The registered request answered by this item.
+          attr_accessor request_id: String
+
+          # The admitted response, without submitted credential values.
+          attr_accessor response: OpenAI::Models::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::response
+
+          # The ID of the turn that contains this item.
+          attr_accessor turn_id: String
+
+          attr_accessor type: :computer_use_approval_request_result
+
+          # @param id
+          #   The stable history item ID.
+          # @param request_id
+          #   The registered request answered by this item.
+          # @param response
+          #   The admitted response, without submitted credential values.
+          # @param turn_id
+          #   The ID of the turn that contains this item.
+          def initialize: (
+            id: String,
+            request_id: String,
+            response: OpenAI::Models::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::response,
+            turn_id: String,
+            ?type: :computer_use_approval_request_result
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            request_id: String,
+            response: OpenAI::Models::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::response,
+            turn_id: String,
+            ?type: :computer_use_approval_request_result
+          }
+
+          type response =
+            OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Submit
+            | OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Cancel
+
+          module Response
+            extend OpenAI::Internal::Type::Union
+
+            type submit =
+              {
+                ?action: :submit,
+                selected_option: String?,
+                ?type: :browser_authentication
+              }
+
+            class Submit < OpenAI::Internal::Type::BaseModel
+              attr_accessor action: :submit
+
+              # The chosen sign-in method, or null when no options were offered.
+              attr_accessor selected_option: String?
+
+              attr_accessor type: :browser_authentication
+
+              # @param selected_option
+              #   The chosen sign-in method, or null when no options were offered.
+              def initialize: (
+                selected_option: String?,
+                ?action: :submit,
+                ?type: :browser_authentication
+              ) -> void
+
+              def to_hash: -> {
+                ?action: :submit,
+                selected_option: String?,
+                ?type: :browser_authentication
+              }
+            end
+
+            type cancel = { ?action: :cancel, ?type: :browser_authentication }
+
+            class Cancel < OpenAI::Internal::Type::BaseModel
+              attr_accessor action: :cancel
+
+              attr_accessor type: :browser_authentication
+
+              def initialize: (
+                ?action: :cancel,
+                ?type: :browser_authentication
+              ) -> void
+
+              def to_hash: -> {
+                ?action: :cancel,
+                ?type: :browser_authentication
+              }
+            end
+
+            def self?.variants: -> ::Array[OpenAI::Models::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::response]
+          end
+        end
+
         def self?.variants: -> ::Array[OpenAI::Models::Beta::agent_session_item]
       end
     end

data/sig/openai/models/beta/agent_tool.rbs

@@ -6,6 +6,7 @@ module OpenAI
         | OpenAI::Beta::AgentTool::ProgrammaticToolCalling
         | OpenAI::Beta::AgentTool::Mcp
         | OpenAI::Beta::AgentTool::WebSearch
+        | OpenAI::Beta::AgentTool::ComputerUse
 
       module AgentTool
         extend OpenAI::Internal::Type::Union
@@ -293,6 +294,27 @@ module OpenAI
           end
         end
 
+        type computer_use = { include_screenshots: bool, ?type: :computer_use }
+
+        class ComputerUse < OpenAI::Internal::Type::BaseModel
+          # Whether computer tool outputs include screenshots.
+          attr_accessor include_screenshots: bool
+
+          # The type of the object. Always `computer_use`.
+          attr_accessor type: :computer_use
+
+          # @param include_screenshots
+          #   Whether computer tool outputs include screenshots.
+          # @param type
+          #   The type of the object. Always `computer_use`.
+          def initialize: (
+            include_screenshots: bool,
+            ?type: :computer_use
+          ) -> void
+
+          def to_hash: -> { include_screenshots: bool, ?type: :computer_use }
+        end
+
         def self?.variants: -> ::Array[OpenAI::Models::Beta::agent_tool]
       end
     end

data/sig/openai/models/beta/agent_tool_param.rbs

@@ -7,6 +7,7 @@ module OpenAI
         | OpenAI::Beta::AgentToolParam::ProgrammaticToolCalling
         | OpenAI::Beta::AgentToolParam::Mcp
         | OpenAI::Beta::AgentToolParam::WebSearch
+        | OpenAI::Beta::AgentToolParam::ComputerUse
 
       module AgentToolParam
         extend OpenAI::Internal::Type::Union
@@ -334,6 +335,30 @@ module OpenAI
           end
         end
 
+        type computer_use = { ?type: :computer_use, ?include_screenshots: bool }
+
+        class ComputerUse < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `computer_use`.
+          attr_accessor type: :computer_use
+
+          # Whether computer tool outputs include screenshots. Defaults to `false`.
+          attr_reader include_screenshots: bool?
+
+          # Whether computer tool outputs include screenshots. Defaults to `false`.
+          def include_screenshots=: (bool) -> bool
+
+          # @param include_screenshots
+          #   Whether computer tool outputs include screenshots. Defaults to `false`.
+          # @param type
+          #   The type of the object. Always `computer_use`.
+          def initialize: (
+            ?include_screenshots: bool,
+            ?type: :computer_use
+          ) -> void
+
+          def to_hash: -> { ?type: :computer_use, ?include_screenshots: bool }
+        end
+
         def self?.variants: -> ::Array[OpenAI::Models::Beta::agent_tool_param]
       end
     end

data/sig/openai/models/beta/agents/environments/environment_template.rbs

@@ -17,7 +17,8 @@ module OpenAI
               packages: OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Packages,
               plugins: ::Array[OpenAI::Beta::HostedPlugin],
               skills: ::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::skill],
-              updated_at: Integer
+              updated_at: Integer,
+              ?desktop: OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Desktop
             }
 
           class EnvironmentTemplate < OpenAI::Internal::Type::BaseModel
@@ -54,6 +55,14 @@ module OpenAI
             # The Unix timestamp, in seconds, when the template was last updated.
             attr_accessor updated_at: Integer
 
+            # Desktop configuration for each OpenAI-hosted environment.
+            attr_reader desktop: OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Desktop?
+
+            # Desktop configuration for each OpenAI-hosted environment.
+            def desktop=: (
+              OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Desktop
+            ) -> OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Desktop
+
             # @param id
             #   The ID of the reusable environment template.
             # @param capability_directories
@@ -74,6 +83,8 @@ module OpenAI
             #   Safe skill metadata, preserving unresolved version selectors.
             # @param updated_at
             #   The Unix timestamp, in seconds, when the template was last updated.
+            # @param desktop
+            #   Desktop configuration for each OpenAI-hosted environment.
             # @param object
             #   The object type. Always `agent.environment.template`.
             def initialize: (
@@ -87,6 +98,7 @@ module OpenAI
               plugins: ::Array[OpenAI::Beta::HostedPlugin],
               skills: ::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::skill],
               updated_at: Integer,
+              ?desktop: OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Desktop,
               ?object: :"agent.environment.template"
             ) -> void
 
@@ -101,7 +113,8 @@ module OpenAI
               packages: OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Packages,
               plugins: ::Array[OpenAI::Beta::HostedPlugin],
               skills: ::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::skill],
-              updated_at: Integer
+              updated_at: Integer,
+              ?desktop: OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Desktop
             }
 
             type file =
@@ -215,7 +228,7 @@ module OpenAI
                 # Disables network access.
                 DISABLED: :disabled
 
-                # Allows access only to configured domains.
+                # Applies the configured domain restrictions.
                 RESTRICTED: :restricted
 
                 def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::Network::access]
@@ -331,6 +344,19 @@ module OpenAI
 
               def self?.variants: -> ::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::skill]
             end
+
+            type desktop = { enabled: bool }
+
+            class Desktop < OpenAI::Internal::Type::BaseModel
+              # Whether the environment provisions a desktop and browser proxy.
+              attr_accessor enabled: bool
+
+              # @param enabled
+              #   Whether the environment provisions a desktop and browser proxy.
+              def initialize: (enabled: bool) -> void
+
+              def to_hash: -> { enabled: bool }
+            end
           end
         end
       end

data/sig/openai/models/beta/agents/environments/template_create_params.rbs

@@ -6,6 +6,7 @@ module OpenAI
           type template_create_params =
             {
               ?capability_directories: ::Array[String]?,
+              ?desktop: OpenAI::Beta::Agents::Environments::TemplateCreateParams::Desktop?,
               ?env: ::Hash[Symbol, String]?,
               ?files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?,
               ?name: String?,
@@ -25,6 +26,10 @@ module OpenAI
             # list.
             attr_accessor capability_directories: ::Array[String]?
 
+            # Desktop provisioning. Omission or null inherits the template setting, or
+            # defaults to disabled.
+            attr_accessor desktop: OpenAI::Beta::Agents::Environments::TemplateCreateParams::Desktop?
+
             # Environment variables made available to the agent.
             attr_accessor env: ::Hash[Symbol, String]?
 
@@ -54,6 +59,9 @@ module OpenAI
             # @param capability_directories
             #   Directories that contain capabilities exposed to the agent. Defaults to an empty
             #   list.
+            # @param desktop
+            #   Desktop provisioning. Omission or null inherits the template setting, or
+            #   defaults to disabled.
             # @param env
             #   Environment variables made available to the agent.
             # @param files
@@ -74,6 +82,7 @@ module OpenAI
             #   list.
             def initialize: (
               ?capability_directories: ::Array[String]?,
+              ?desktop: OpenAI::Beta::Agents::Environments::TemplateCreateParams::Desktop?,
               ?env: ::Hash[Symbol, String]?,
               ?files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?,
               ?name: String?,
@@ -87,6 +96,7 @@ module OpenAI
 
             def to_hash: -> {
               ?capability_directories: ::Array[String]?,
+              ?desktop: OpenAI::Beta::Agents::Environments::TemplateCreateParams::Desktop?,
               ?env: ::Hash[Symbol, String]?,
               ?files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?,
               ?name: String?,
@@ -98,10 +108,24 @@ module OpenAI
               ?request_options: OpenAI::RequestOptions
             }
 
+            type desktop = { enabled: bool }
+
+            class Desktop < OpenAI::Internal::Type::BaseModel
+              # Whether to provision the desktop and its browser proxy.
+              attr_accessor enabled: bool
+
+              # @param enabled
+              #   Whether to provision the desktop and its browser proxy.
+              def initialize: (enabled: bool) -> void
+
+              def to_hash: -> { enabled: bool }
+            end
+
             type network =
               {
                 access: OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network::access,
-                ?allowed_domains: ::Array[String]?
+                ?allowed_domains: ::Array[String]?,
+                ?blocked_domains: ::Array[String]?
               }
 
             class Network < OpenAI::Internal::Type::BaseModel
@@ -111,18 +135,29 @@ module OpenAI
               # Domains the environment may access when network access is restricted.
               attr_accessor allowed_domains: ::Array[String]?
 
+              # Domains blocked for both executor and browser when access is restricted. A
+              # nonempty list requires `access: restricted` and cannot be combined with nonempty
+              # `allowed_domains`. Wildcard domains are not supported.
+              attr_accessor blocked_domains: ::Array[String]?
+
               # @param access
               #   The environment's network access mode.
               # @param allowed_domains
               #   Domains the environment may access when network access is restricted.
+              # @param blocked_domains
+              #   Domains blocked for both executor and browser when access is restricted. A
+              #   nonempty list requires `access: restricted` and cannot be combined with nonempty
+              #   `allowed_domains`. Wildcard domains are not supported.
               def initialize: (
                 access: OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network::access,
-                ?allowed_domains: ::Array[String]?
+                ?allowed_domains: ::Array[String]?,
+                ?blocked_domains: ::Array[String]?
               ) -> void
 
               def to_hash: -> {
                 access: OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network::access,
-                ?allowed_domains: ::Array[String]?
+                ?allowed_domains: ::Array[String]?,
+                ?blocked_domains: ::Array[String]?
               }
 
               type access = :enabled | :disabled | :restricted
@@ -136,7 +171,7 @@ module OpenAI
                 # Disables network access.
                 DISABLED: :disabled
 
-                # Allows access only to configured domains.
+                # Applies the configured domain restrictions.
                 RESTRICTED: :restricted
 
                 def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network::access]