openai 0.96.0 → 0.98.0

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]

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

@@ -7,6 +7,7 @@ module OpenAI
             {
               environment_template_id: String,
               ?capability_directories: ::Array[String]?,
+              ?desktop: OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Desktop?,
               ?env: ::Hash[Symbol, String]?,
               ?files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?,
               ?name: String?,
@@ -27,6 +28,9 @@ module OpenAI
             # Directories that expose capabilities to the agent.
             attr_accessor capability_directories: ::Array[String]?
 
+            # Replacement desktop configuration, or null to disable the desktop.
+            attr_accessor desktop: OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Desktop?
+
             # Replacement confidential environment values.
             attr_accessor env: ::Hash[Symbol, String]?
 
@@ -55,6 +59,8 @@ module OpenAI
 
             # @param capability_directories
             #   Directories that expose capabilities to the agent.
+            # @param desktop
+            #   Replacement desktop configuration, or null to disable the desktop.
             # @param env
             #   Replacement confidential environment values.
             # @param files
@@ -76,6 +82,7 @@ module OpenAI
             def initialize: (
               environment_template_id: String,
               ?capability_directories: ::Array[String]?,
+              ?desktop: OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Desktop?,
               ?env: ::Hash[Symbol, String]?,
               ?files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?,
               ?name: String?,
@@ -90,6 +97,7 @@ module OpenAI
             def to_hash: -> {
               environment_template_id: String,
               ?capability_directories: ::Array[String]?,
+              ?desktop: OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Desktop?,
               ?env: ::Hash[Symbol, String]?,
               ?files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?,
               ?name: String?,
@@ -101,10 +109,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::TemplateUpdateParams::Network::access,
-                ?allowed_domains: ::Array[String]?
+                ?allowed_domains: ::Array[String]?,
+                ?blocked_domains: ::Array[String]?
               }
 
             class Network < OpenAI::Internal::Type::BaseModel
@@ -114,18 +136,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::TemplateUpdateParams::Network::access,
-                ?allowed_domains: ::Array[String]?
+                ?allowed_domains: ::Array[String]?,
+                ?blocked_domains: ::Array[String]?
               ) -> void
 
               def to_hash: -> {
                 access: OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Network::access,
-                ?allowed_domains: ::Array[String]?
+                ?allowed_domains: ::Array[String]?,
+                ?blocked_domains: ::Array[String]?
               }
 
               type access = :enabled | :disabled | :restricted
@@ -139,7 +172,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::TemplateUpdateParams::Network::access]

data/sig/openai/models/beta/agents/sessions/session_trace.rbs

@@ -0,0 +1,65 @@
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        class SessionTrace = Sessions::SessionTrace
+
+        module Sessions
+          type session_trace =
+            {
+              id: String,
+              created_at: Integer,
+              ?object: :"agent.session.trace",
+              otlp: ::Hash[Symbol, top],
+              session_id: String
+            }
+
+          class SessionTrace < OpenAI::Internal::Type::BaseModel
+            # The root turn ID. Use this ID as the pagination anchor.
+            attr_accessor id: String
+
+            # The Unix timestamp in seconds when the root turn was created.
+            attr_accessor created_at: Integer
+
+            # The object type, which is always `agent.session.trace`.
+            attr_accessor object: :"agent.session.trace"
+
+            # An OTLP JSON ExportTraceServiceRequest containing resourceSpans. Only currently
+            # published data is returned; later trace updates are not awaited.
+            attr_accessor otlp: ::Hash[Symbol, top]
+
+            # The session that owns this trace.
+            attr_accessor session_id: String
+
+            # @param id
+            #   The root turn ID. Use this ID as the pagination anchor.
+            # @param created_at
+            #   The Unix timestamp in seconds when the root turn was created.
+            # @param otlp
+            #   An OTLP JSON ExportTraceServiceRequest containing resourceSpans. Only currently
+            #   published data is returned; later trace updates are not awaited.
+            # @param session_id
+            #   The session that owns this trace.
+            # @param object
+            #   The object type, which is always `agent.session.trace`.
+            def initialize: (
+              id: String,
+              created_at: Integer,
+              otlp: ::Hash[Symbol, top],
+              session_id: String,
+              ?object: :"agent.session.trace"
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              created_at: Integer,
+              ?object: :"agent.session.trace",
+              otlp: ::Hash[Symbol, top],
+              session_id: String
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agents/sessions/trace_list_params.rbs

@@ -0,0 +1,81 @@
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          type trace_list_params =
+            {
+              session_id: String,
+              ?after: String,
+              ?limit: Integer,
+              ?order: OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order,
+              ?request_options: OpenAI::request_opts
+            }
+
+          class TraceListParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            attr_accessor session_id: String
+
+            # Return resources after this resource ID in the selected order.
+            attr_reader after: String?
+
+            # Return resources after this resource ID in the selected order.
+            def after=: (String) -> String
+
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            attr_reader limit: Integer?
+
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            def limit=: (Integer) -> Integer
+
+            # The order in which resources are returned. Defaults to `desc`.
+            attr_reader order: OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order?
+
+            # The order in which resources are returned. Defaults to `desc`.
+            def order=: (
+              OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order
+            ) -> OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order
+
+            # @param after
+            #   Return resources after this resource ID in the selected order.
+            # @param limit
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            # @param order
+            #   The order in which resources are returned. Defaults to `desc`.
+            def initialize: (
+              session_id: String,
+              ?after: String,
+              ?limit: Integer,
+              ?order: OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order,
+              ?request_options: OpenAI::request_opts
+            ) -> void
+
+            def to_hash: -> {
+              session_id: String,
+              ?after: String,
+              ?limit: Integer,
+              ?order: OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order,
+              ?request_options: OpenAI::RequestOptions
+            }
+
+            type order = :asc | :desc
+
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              # Returns resources in ascending order.
+              ASC: :asc
+
+              # Returns resources in descending order.
+              DESC: :desc
+
+              def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agents/vaults/credential.rbs

@@ -8,7 +8,7 @@ module OpenAI
               id: String,
               auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth,
               created_at: Integer,
-              metadata: ::Hash[Symbol, String],
+              ?metadata: ::Hash[Symbol, String],
               name: String,
               ?object: :"vault.credential",
               updated_at: Integer,
@@ -46,24 +46,24 @@ module OpenAI
             #   The authentication method and non-secret configuration of the credential.
             # @param created_at
             #   The Unix timestamp, in seconds, when the credential was created.
-            # @param metadata
-            #   Application-defined key-value pairs associated with this credential.
             # @param name
             #   The human-readable name of the credential.
             # @param updated_at
             #   The Unix timestamp, in seconds, when the credential was last updated.
             # @param vault_id
             #   The ID of the vault containing this credential.
+            # @param metadata
+            #   Application-defined key-value pairs associated with this credential.
             # @param object
             #   The object type. Always `vault.credential`.
             def initialize: (
               id: String,
               auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth,
               created_at: Integer,
-              metadata: ::Hash[Symbol, String],
               name: String,
               updated_at: Integer,
               vault_id: String,
+              ?metadata: ::Hash[Symbol, String],
               ?object: :"vault.credential"
             ) -> void
 
@@ -71,7 +71,7 @@ module OpenAI
               id: String,
               auth: OpenAI::Models::Beta::Agents::Vaults::credential_auth,
               created_at: Integer,
-              metadata: ::Hash[Symbol, String],
+              ?metadata: ::Hash[Symbol, String],
               name: String,
               ?object: :"vault.credential",
               updated_at: Integer,

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

@@ -71,7 +71,7 @@ module OpenAI
             # The filename of the file cited.
             attr_accessor filename: String
 
-            # The index of the file in the list of files.
+            # The index in the output text at which to insert the file citation.
             attr_accessor index: Integer
 
             # The type of the file citation. Always `file_citation`.
@@ -82,7 +82,7 @@ module OpenAI
             # @param filename
             #   The filename of the file cited.
             # @param index
-            #   The index of the file in the list of files.
+            #   The index in the output text at which to insert the file citation.
             # @param type
             #   The type of the file citation. Always `file_citation`.
             def initialize: (

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

@@ -102,7 +102,7 @@ module OpenAI
             # The filename of the file cited.
             attr_accessor filename: String
 
-            # The index of the file in the list of files.
+            # The index in the output text at which to insert the file citation.
             attr_accessor index: Integer
 
             # The type of the file citation. Always `file_citation`.
@@ -113,7 +113,7 @@ module OpenAI
             # @param filename
             #   The filename of the file cited.
             # @param index
-            #   The index of the file in the list of files.
+            #   The index in the output text at which to insert the file citation.
             # @param type
             #   The type of the file citation. Always `file_citation`.
             def initialize: (