openai 0.96.0 → 0.97.0

data/rbi/openai/models/beta/agent_session_item.rbi

@@ -17,6 +17,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,
@@ -227,6 +230,617 @@ module OpenAI
 
         end
 
+        class ComputerUseCall < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::AgentSessionItem::ComputerUseCall,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The ID of the activity item.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The last screenshot emitted by the model. Null when screenshot inclusion is
+          # disabled or the call emitted no screenshot.
+          sig { returns(T.nilable(OpenAI::Beta::AgentSessionItem::ComputerUseCall::Output)) }
+          attr_reader :output
+
+          sig { params(output: T.nilable(OpenAI::Beta::AgentSessionItem::ComputerUseCall::Output::OrHash)).void }
+          attr_writer :output
+
+          # The execution status of the activity.
+          sig { returns(OpenAI::Beta::AgentFunctionCallStatus::TaggedSymbol) }
+          attr_accessor :status
+
+          # A model-generated description of the activity, when available.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :title
+
+          # The ID of the turn that contains this item.
+          sig { returns(String) }
+          attr_accessor :turn_id
+
+          # The item type. Always `computer_use_call`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # One execution of the platform-provided computer-use capability.
+          sig do
+            params(
+
+              id: String,
+
+              output: T.nilable(OpenAI::Beta::AgentSessionItem::ComputerUseCall::Output::OrHash),
+
+              status: OpenAI::Beta::AgentFunctionCallStatus::OrSymbol,
+
+              title: T.nilable(String),
+
+              turn_id: String,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The ID of the activity item.
+            id:,
+
+            # The last screenshot emitted by the model. Null when screenshot inclusion is
+            # disabled or the call emitted no screenshot.
+            output:,
+
+            # The execution status of the activity.
+            status:,
+
+            # A model-generated description of the activity, when available.
+            title:,
+
+            # The ID of the turn that contains this item.
+            turn_id:,
+
+            # The item type. Always `computer_use_call`.
+
+            type: :computer_use_call
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                output: T.nilable(OpenAI::Beta::AgentSessionItem::ComputerUseCall::Output),
+                status: OpenAI::Beta::AgentFunctionCallStatus::TaggedSymbol,
+                title: T.nilable(String),
+                turn_id: String,
+                type: Symbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Output < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::AgentSessionItem::ComputerUseCall::Output,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The complete JPEG image as a base64 data URL.
+            sig { returns(String) }
+            attr_accessor :image_url
+
+            # The content type. Always `computer_screenshot`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # The last screenshot emitted by the model. Null when screenshot inclusion is
+            # disabled or the call emitted no screenshot.
+            sig do
+              params(
+
+                image_url: String,
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The complete JPEG image as a base64 data URL.
+              image_url:,
+
+              # The content type. Always `computer_screenshot`.
+
+              type: :computer_screenshot
+            )
+            end
+
+            sig do
+              override.returns(
+                {image_url: String, type: Symbol}
+              )
+            end
+            def to_hash
+            end
+
+          end
+        end
+
+        class ComputerUseApprovalRequest < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The stable history item ID.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # A registered form awaiting the application's response.
+          sig { returns(OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request) }
+          attr_reader :request
+
+          sig { params(request: OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::OrHash).void }
+          attr_writer :request
+
+          sig { returns(String) }
+          attr_accessor :request_id
+
+          sig { returns(String) }
+          attr_accessor :turn_id
+
+          # The item type. Always computer_use_approval_request.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # A credential-free history record of the emitted login request.
+          sig do
+            params(
+
+              id: String,
+
+              request: OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::OrHash,
+
+              request_id: String,
+
+              turn_id: String,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The stable history item ID.
+            id:,
+
+            # A registered form awaiting the application's response.
+            request:,
+
+            request_id:,
+
+            turn_id:,
+
+            # The item type. Always computer_use_approval_request.
+
+            type: :computer_use_approval_request
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                request: OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request,
+                request_id: String,
+                turn_id: String,
+                type: Symbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Request < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The registered form or frame origin where values will be entered.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :credential_origin
+
+            # Controls to render. All submitted values are sensitive.
+            sig { returns(T::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Field]) }
+            attr_accessor :fields
+
+            # Sign-in methods. Empty for a plain form.
+            sig { returns(T::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Option]) }
+            attr_accessor :options
+
+            # Why the agent needs the user to sign in.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :reason
+
+            # The type of the object. Always `browser_authentication`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # A registered form awaiting the application's response.
+            sig do
+              params(
+
+                credential_origin: T.nilable(String),
+
+                fields: T::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Field::OrHash],
+
+                options: T::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Option::OrHash],
+
+                reason: T.nilable(String),
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The registered form or frame origin where values will be entered.
+              credential_origin:,
+
+              # Controls to render. All submitted values are sensitive.
+              fields:,
+
+              # Sign-in methods. Empty for a plain form.
+              options:,
+
+              # Why the agent needs the user to sign in.
+              reason:,
+
+              # The type of the object. Always `browser_authentication`.
+
+              type: :browser_authentication
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  credential_origin: T.nilable(String),
+                  fields: T::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Field],
+                  options: T::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Option],
+                  reason: T.nilable(String),
+                  type: Symbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Field < OpenAI::Internal::Type::BaseModel
+              OrHash = T.type_alias do
+                T.any(
+                  OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Field,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+              # The field ID to submit as field_id in a fields entry.
+              sig { returns(String) }
+              attr_accessor :id
+
+              # The label to display beside the control.
+              sig { returns(String) }
+              attr_accessor :label
+
+              # Whether this control requires a nonempty value.
+              sig { returns(T::Boolean) }
+              attr_accessor :required
+
+              # The rendering type, such as email, password, or text.
+              sig { returns(String) }
+              attr_accessor :type
+
+              # A control in a registered browser-login form.
+              sig do
+                params(
+
+                  id: String,
+
+                  label: String,
+
+                  required: T::Boolean,
+
+                  type: String
+                )
+                  .returns(T.attached_class)
+              end
+              def self.new(
+
+                # The field ID to submit as field_id in a fields entry.
+                id:,
+
+                # The label to display beside the control.
+                label:,
+
+                # Whether this control requires a nonempty value.
+                required:,
+
+                # The rendering type, such as email, password, or text.
+
+                type:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {id: String, label: String, required: T::Boolean, type: String}
+                )
+              end
+              def to_hash
+              end
+
+            end
+
+            class Option < OpenAI::Internal::Type::BaseModel
+              OrHash = T.type_alias do
+                T.any(
+                  OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::Request::Option,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+              # The option ID to submit as selected_option.
+              sig { returns(String) }
+              attr_accessor :id
+
+              # IDs from the registered fields that this method accepts.
+              sig { returns(T::Array[String]) }
+              attr_accessor :field_ids
+
+              # The method label to display.
+              sig { returns(String) }
+              attr_accessor :label
+
+              # A sign-in method and the fields that belong to it.
+              sig do
+                params(
+
+                  id: String,
+
+                  field_ids: T::Array[String],
+
+                  label: String
+                )
+                  .returns(T.attached_class)
+              end
+              def self.new(
+
+                # The option ID to submit as selected_option.
+                id:,
+
+                # IDs from the registered fields that this method accepts.
+                field_ids:,
+
+                # The method label to display.
+
+                label:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {id: String, field_ids: T::Array[String], label: String}
+                )
+              end
+              def to_hash
+              end
+
+            end
+          end
+        end
+
+        class ComputerUseApprovalRequestResult < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The stable history item ID.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The registered request answered by this item.
+          sig { returns(String) }
+          attr_accessor :request_id
+
+          # The admitted response, without submitted credential values.
+          sig { returns(OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Variants) }
+          attr_accessor :response
+
+          # The ID of the turn that contains this item.
+          sig { returns(String) }
+          attr_accessor :turn_id
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # A credential-free record of an admitted response, not proof of completion.
+          sig do
+            params(
+
+              id: String,
+
+              request_id: String,
+
+              response: T.any(
+                OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Submit::OrHash,
+                OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Cancel::OrHash
+              ),
+
+              turn_id: String,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The stable history item ID.
+            id:,
+
+            # The registered request answered by this item.
+            request_id:,
+
+            # The admitted response, without submitted credential values.
+            response:,
+
+            # The ID of the turn that contains this item.
+            turn_id:,
+
+            type: :computer_use_approval_request_result
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                request_id: String,
+                response: OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Variants,
+                turn_id: String,
+                type: Symbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The admitted response, without submitted credential values.
+          module Response
+            extend OpenAI::Internal::Type::Union
+
+            Variants = T.type_alias {
+              T.any(
+                OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Submit,
+                OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Cancel
+              )
+            }
+
+            class Submit < OpenAI::Internal::Type::BaseModel
+              OrHash = T.type_alias do
+                T.any(
+                  OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Submit,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+              sig { returns(Symbol) }
+              attr_accessor :action
+
+              # The chosen sign-in method, or null when no options were offered.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :selected_option
+
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              sig do
+                params(
+
+                  selected_option: T.nilable(String),
+
+                  action: Symbol,
+
+                  type: Symbol
+                )
+                  .returns(T.attached_class)
+              end
+              def self.new(
+
+                # The chosen sign-in method, or null when no options were offered.
+                selected_option:,
+
+                action: :submit,
+
+                type: :browser_authentication
+              )
+              end
+
+              sig do
+                override.returns(
+                  {action: Symbol, selected_option: T.nilable(String), type: Symbol}
+                )
+              end
+              def to_hash
+              end
+
+            end
+
+            class Cancel < OpenAI::Internal::Type::BaseModel
+              OrHash = T.type_alias do
+                T.any(
+                  OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Cancel,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+              sig { returns(Symbol) }
+              attr_accessor :action
+
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              sig do
+                params(
+
+                  action: Symbol,
+
+                  type: Symbol
+                )
+                  .returns(T.attached_class)
+              end
+              def self.new(
+
+                action: :cancel,
+
+                type: :browser_authentication
+              )
+              end
+
+              sig do
+                override.returns(
+                  {action: Symbol, type: Symbol}
+                )
+              end
+              def to_hash
+              end
+
+            end
+
+            sig {
+              override.returns(
+                T::Array[OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::Response::Variants]
+              )
+            }
+            def self.variants
+            end
+
+          end
+        end
+
         sig { override.returns(T::Array[OpenAI::Beta::AgentSessionItem::Variants]) }
         def self.variants
         end

data/rbi/openai/models/beta/agent_session_turn_item_added_event.rbi

@@ -51,6 +51,9 @@ module OpenAI
               OpenAI::Beta::AgentSessionItem::FunctionCallOutput::OrHash,
               OpenAI::Beta::AgentSessionItem::AgentMessage::OrHash,
               OpenAI::Beta::AgentMcpCallItem::OrHash,
+              OpenAI::Beta::AgentSessionItem::ComputerUseCall::OrHash,
+              OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequest::OrHash,
+              OpenAI::Beta::AgentSessionItem::ComputerUseApprovalRequestResult::OrHash,
               OpenAI::Beta::AgentWebSearchCallItem::OrHash,
               OpenAI::Beta::AgentCommandExecutionItem::OrHash,
               OpenAI::Beta::AgentCreateSubagentCallItem::OrHash,

data/rbi/openai/models/beta/agent_session_turn_item_done_event.rbi

@@ -49,6 +49,8 @@ module OpenAI
               OpenAI::Beta::AgentReasoningItem::OrHash,
               OpenAI::Beta::AgentFunctionCallItem::OrHash,
               OpenAI::Beta::AgentMcpCallItem::OrHash,
+              OpenAI::Beta::AgentOutputItem::ComputerUseCall::OrHash,
+              OpenAI::Beta::AgentOutputItem::ComputerUseApprovalRequest::OrHash,
               OpenAI::Beta::AgentWebSearchCallItem::OrHash,
               OpenAI::Beta::AgentCommandExecutionItem::OrHash,
               OpenAI::Beta::AgentCreateSubagentCallItem::OrHash,

data/rbi/openai/models/beta/agent_tool.rbi

@@ -14,7 +14,8 @@ module OpenAI
             OpenAI::Beta::AgentTool::Function,
             OpenAI::Beta::AgentTool::ProgrammaticToolCalling,
             OpenAI::Beta::AgentTool::Mcp,
-            OpenAI::Beta::AgentTool::WebSearch
+            OpenAI::Beta::AgentTool::WebSearch,
+            OpenAI::Beta::AgentTool::ComputerUse
           )
         end
 
@@ -455,6 +456,53 @@ module OpenAI
           end
         end
 
+        class ComputerUse < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::AgentTool::ComputerUse,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # Whether computer tool outputs include screenshots.
+          sig { returns(T::Boolean) }
+          attr_accessor :include_screenshots
+
+          # The type of the object. Always `computer_use`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Browser use in an OpenAI-hosted session.
+          sig do
+            params(
+
+              include_screenshots: T::Boolean,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # Whether computer tool outputs include screenshots.
+            include_screenshots:,
+
+            # The type of the object. Always `computer_use`.
+
+            type: :computer_use
+          )
+          end
+
+          sig do
+            override.returns(
+              {include_screenshots: T::Boolean, type: Symbol}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
         sig { override.returns(T::Array[OpenAI::Beta::AgentTool::Variants]) }
         def self.variants
         end