openai 0.96.0 → 0.98.0

data/rbi/openai/models/beta/agents/sessions/trace_list_params.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        module Sessions
+
+          class TraceListParams < OpenAI::Internal::Type::BaseModel
+
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::Agents::Sessions::TraceListParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            sig { returns(String) }
+            attr_accessor :session_id
+
+            # Return resources after this resource ID in the selected order.
+            sig { returns(T.nilable(String)) }
+            attr_reader :after
+
+            sig { params(after: String).void }
+            attr_writer :after
+
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :limit
+
+            sig { params(limit: Integer).void }
+            attr_writer :limit
+
+            # The order in which resources are returned. Defaults to `desc`.
+            sig { returns(T.nilable(OpenAI::Beta::Agents::Sessions::TraceListParams::Order::OrSymbol)) }
+            attr_reader :order
+
+            sig { params(order: OpenAI::Beta::Agents::Sessions::TraceListParams::Order::OrSymbol).void }
+            attr_writer :order
+
+            sig do
+              params(
+
+                session_id: String,
+
+                after: String,
+
+                limit: Integer,
+
+                order: OpenAI::Beta::Agents::Sessions::TraceListParams::Order::OrSymbol,
+
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              session_id:,
+
+              # Return resources after this resource ID in the selected order.
+              after: nil,
+
+              # The maximum number of resources to return, between 1 and 100. Defaults to 20.
+              limit: nil,
+
+              # The order in which resources are returned. Defaults to `desc`.
+              order: nil,
+
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  session_id: String,
+                  after: String,
+                  limit: Integer,
+                  order: OpenAI::Beta::Agents::Sessions::TraceListParams::Order::OrSymbol,
+                  request_options: OpenAI::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The order in which resources are returned. Defaults to `desc`.
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Agents::Sessions::TraceListParams::Order) }
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              # Returns resources in ascending order.
+              ASC = T.let(:asc, OpenAI::Beta::Agents::Sessions::TraceListParams::Order::TaggedSymbol)
+
+              # Returns resources in descending order.
+              DESC = T.let(:desc, OpenAI::Beta::Agents::Sessions::TraceListParams::Order::TaggedSymbol)
+
+              sig { override.returns(T::Array[OpenAI::Beta::Agents::Sessions::TraceListParams::Order::TaggedSymbol]) }
+              def self.values
+              end
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agents/vaults/credential.rbi

@@ -64,14 +64,14 @@ module OpenAI
 
                 created_at: Integer,
 
-                metadata: T::Hash[Symbol, String],
-
                 name: String,
 
                 updated_at: Integer,
 
                 vault_id: String,
 
+                metadata: T::Hash[Symbol, String],
+
                 object: Symbol
               )
                 .returns(T.attached_class)
@@ -87,9 +87,6 @@ module OpenAI
               # The Unix timestamp, in seconds, when the credential was created.
               created_at:,
 
-              # Application-defined key-value pairs associated with this credential.
-              metadata:,
-
               # The human-readable name of the credential.
               name:,
 
@@ -99,6 +96,9 @@ module OpenAI
               # The ID of the vault containing this credential.
               vault_id:,
 
+              # Application-defined key-value pairs associated with this credential.
+              metadata: {},
+
               # The object type. Always `vault.credential`.
 
               object: :"vault.credential"

data/rbi/openai/models/beta/beta_response_output_text.rbi

@@ -131,7 +131,7 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :filename
 
-            # The index of the file in the list of files.
+            # The index in the output text at which to insert the file citation.
             sig { returns(Integer) }
             attr_accessor :index
 
@@ -161,7 +161,7 @@ module OpenAI
               # The filename of the file cited.
               filename:,
 
-              # The index of the file in the list of files.
+              # The index in the output text at which to insert the file citation.
               index:,
 
               # The type of the file citation. Always `file_citation`.

data/rbi/openai/models/beta/beta_response_output_text_annotation_added_event.rbi

@@ -155,7 +155,7 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :filename
 
-            # The index of the file in the list of files.
+            # The index in the output text at which to insert the file citation.
             sig { returns(Integer) }
             attr_accessor :index
 
@@ -185,7 +185,7 @@ module OpenAI
               # The filename of the file cited.
               filename:,
 
-              # The index of the file in the list of files.
+              # The index in the output text at which to insert the file citation.
               index:,
 
               # The type of the file citation. Always `file_citation`.

data/rbi/openai/models/beta/environment.rbi

@@ -102,6 +102,18 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # The effective CPU and memory tier, or null when unknown or outside the public
+          # tiers.
+          sig { returns(T.nilable(OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol)) }
+          attr_accessor :container_size
+
+          # The effective desktop configuration.
+          sig { returns(T.nilable(OpenAI::Beta::Environment::OpenAIHosted::Desktop)) }
+          attr_reader :desktop
+
+          sig { params(desktop: OpenAI::Beta::Environment::OpenAIHosted::Desktop::OrHash).void }
+          attr_writer :desktop
+
           # An environment hosted by OpenAI.
           sig do
             params(
@@ -127,6 +139,10 @@ module OpenAI
                 T.any(OpenAI::Beta::HostedSkillReference::OrHash, OpenAI::Beta::HostedSkill::Inline::OrHash)
               ],
 
+              container_size: T.nilable(OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::OrSymbol),
+
+              desktop: OpenAI::Beta::Environment::OpenAIHosted::Desktop::OrHash,
+
               type: Symbol
             )
               .returns(T.attached_class)
@@ -154,6 +170,13 @@ module OpenAI
             # Skills installed in the environment, excluding their archive contents.
             skills:,
 
+            # The effective CPU and memory tier, or null when unknown or outside the public
+            # tiers.
+            container_size: nil,
+
+            # The effective desktop configuration.
+            desktop: nil,
+
             # The type of the object. Always `openai_hosted`.
 
             type: :openai_hosted
@@ -170,7 +193,9 @@ module OpenAI
                 packages: OpenAI::Beta::Environment::OpenAIHosted::Packages,
                 plugins: T::Array[OpenAI::Beta::HostedPlugin],
                 skills: T::Array[OpenAI::Beta::HostedSkill::Variants],
-                type: Symbol
+                type: Symbol,
+                container_size: T.nilable(OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol),
+                desktop: OpenAI::Beta::Environment::OpenAIHosted::Desktop
               }
             )
           end
@@ -238,7 +263,7 @@ module OpenAI
               # Disables network access.
               DISABLED = T.let(:disabled, OpenAI::Beta::Environment::OpenAIHosted::Network::Access::TaggedSymbol)
 
-              # Allows access only to configured domains.
+              # Applies the configured domain restrictions.
               RESTRICTED = T.let(:restricted, OpenAI::Beta::Environment::OpenAIHosted::Network::Access::TaggedSymbol)
 
               sig {
@@ -304,6 +329,61 @@ module OpenAI
             end
 
           end
+
+          # The effective CPU and memory tier, or null when unknown or outside the public
+          # tiers.
+          module ContainerSize
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Environment::OpenAIHosted::ContainerSize) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SMALL = T.let(:small, OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol)
+            MEDIUM = T.let(:medium, OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol)
+            LARGE = T.let(:large, OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol)
+
+            sig { override.returns(T::Array[OpenAI::Beta::Environment::OpenAIHosted::ContainerSize::TaggedSymbol]) }
+            def self.values
+            end
+          end
+
+          class Desktop < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::Environment::OpenAIHosted::Desktop,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # Whether the environment provisions a desktop and browser proxy.
+            sig { returns(T::Boolean) }
+            attr_accessor :enabled
+
+            # The effective desktop configuration.
+            sig do
+              params(
+
+                enabled: T::Boolean
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # Whether the environment provisions a desktop and browser proxy.
+
+              enabled:
+            )
+            end
+
+            sig do
+              override.returns(
+                {enabled: T::Boolean}
+              )
+            end
+            def to_hash
+            end
+
+          end
         end
 
         class SelfHosted < OpenAI::Internal::Type::BaseModel

data/rbi/openai/models/beta/environment_param.rbi

@@ -72,6 +72,21 @@ module OpenAI
           sig { returns(T.nilable(T::Array[String])) }
           attr_accessor :capability_directories
 
+          # The hosted container size. Omission selects the medium tier.
+          sig { returns(T.nilable(OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::OrSymbol)) }
+          attr_reader :container_size
+
+          sig { params(container_size: OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::OrSymbol).void }
+          attr_writer :container_size
+
+          # Desktop provisioning. Omission or null inherits the template setting, or
+          # defaults to disabled.
+          sig { returns(T.nilable(OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop)) }
+          attr_reader :desktop
+
+          sig { params(desktop: T.nilable(OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop::OrHash)).void }
+          attr_writer :desktop
+
           # Environment variables made available to the agent.
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_accessor :env
@@ -140,6 +155,10 @@ module OpenAI
 
               capability_directories: T.nilable(T::Array[String]),
 
+              container_size: OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::OrSymbol,
+
+              desktop: T.nilable(OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop::OrHash),
+
               env: T.nilable(T::Hash[Symbol, String]),
 
               environment_template_id: String,
@@ -180,6 +199,13 @@ module OpenAI
             # list.
             capability_directories: nil,
 
+            # The hosted container size. Omission selects the medium tier.
+            container_size: nil,
+
+            # Desktop provisioning. Omission or null inherits the template setting, or
+            # defaults to disabled.
+            desktop: nil,
+
             # Environment variables made available to the agent.
             env: nil,
 
@@ -218,6 +244,8 @@ module OpenAI
               {
                 type: Symbol,
                 capability_directories: T.nilable(T::Array[String]),
+                container_size: OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::OrSymbol,
+                desktop: T.nilable(OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop),
                 env: T.nilable(T::Hash[Symbol, String]),
                 environment_template_id: String,
                 files: T.nilable(
@@ -243,6 +271,63 @@ module OpenAI
           def to_hash
           end
 
+          # The hosted container size. Omission selects the medium tier.
+          module ContainerSize
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SMALL = T.let(:small, OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::TaggedSymbol)
+            MEDIUM = T.let(:medium, OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::TaggedSymbol)
+            LARGE = T.let(:large, OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::TaggedSymbol)
+
+            sig {
+              override.returns(T::Array[OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::TaggedSymbol])
+            }
+            def self.values
+            end
+          end
+
+          class Desktop < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # Whether to provision the desktop and its browser proxy.
+            sig { returns(T::Boolean) }
+            attr_accessor :enabled
+
+            # Desktop provisioning. Omission or null inherits the template setting, or
+            # defaults to disabled.
+            sig do
+              params(
+
+                enabled: T::Boolean
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # Whether to provision the desktop and its browser proxy.
+
+              enabled:
+            )
+            end
+
+            sig do
+              override.returns(
+                {enabled: T::Boolean}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
           class Network < OpenAI::Internal::Type::BaseModel
             OrHash = T.type_alias do
               T.any(
@@ -259,6 +344,12 @@ module OpenAI
             sig { returns(T.nilable(T::Array[String])) }
             attr_accessor :allowed_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.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_accessor :blocked_domains
+
             # Network access policy for the environment. Defaults to disabled for GA requests
             # and enabled for beta requests.
             sig do
@@ -266,7 +357,9 @@ module OpenAI
 
                 access: OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network::Access::OrSymbol,
 
-                allowed_domains: T.nilable(T::Array[String])
+                allowed_domains: T.nilable(T::Array[String]),
+
+                blocked_domains: T.nilable(T::Array[String])
               )
                 .returns(T.attached_class)
             end
@@ -276,8 +369,13 @@ module OpenAI
               access:,
 
               # Domains the environment may access when network access is restricted.
+              allowed_domains: nil,
+
+              # 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.
 
-              allowed_domains: nil
+              blocked_domains: nil
             )
             end
 
@@ -285,7 +383,8 @@ module OpenAI
               override.returns(
                 {
                   access: OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network::Access::OrSymbol,
-                  allowed_domains: T.nilable(T::Array[String])
+                  allowed_domains: T.nilable(T::Array[String]),
+                  blocked_domains: T.nilable(T::Array[String])
                 }
               )
             end
@@ -307,7 +406,7 @@ module OpenAI
               # Disables network access.
               DISABLED = T.let(:disabled, OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network::Access::TaggedSymbol)
 
-              # Allows access only to configured domains.
+              # Applies the configured domain restrictions.
               RESTRICTED = T.let(
                 :restricted,
                 OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network::Access::TaggedSymbol

data/rbi/openai/models/beta/persisted_agent_tool.rbi

@@ -15,7 +15,8 @@ module OpenAI
             OpenAI::Beta::PersistedAgentTool::ToolSearch,
             OpenAI::Beta::PersistedAgentTool::ProgrammaticToolCalling,
             OpenAI::Beta::PersistedAgentTool::Mcp,
-            OpenAI::Beta::PersistedAgentTool::WebSearch
+            OpenAI::Beta::PersistedAgentTool::WebSearch,
+            OpenAI::Beta::PersistedAgentTool::ComputerUse
           )
         end
 
@@ -495,6 +496,53 @@ module OpenAI
           end
         end
 
+        class ComputerUse < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::PersistedAgentTool::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::PersistedAgentTool::Variants]) }
         def self.variants
         end

data/rbi/openai/models/beta/persisted_agent_tool_param.rbi

@@ -15,7 +15,8 @@ module OpenAI
             OpenAI::Beta::PersistedAgentToolParam::ToolSearch,
             OpenAI::Beta::PersistedAgentToolParam::ProgrammaticToolCalling,
             OpenAI::Beta::PersistedAgentToolParam::Mcp,
-            OpenAI::Beta::PersistedAgentToolParam::WebSearch
+            OpenAI::Beta::PersistedAgentToolParam::WebSearch,
+            OpenAI::Beta::PersistedAgentToolParam::ComputerUse
           )
         end
 
@@ -534,6 +535,56 @@ module OpenAI
           end
         end
 
+        class ComputerUse < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::PersistedAgentToolParam::ComputerUse,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The type of the object. Always `computer_use`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Whether computer tool outputs include screenshots. Defaults to `false`.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :include_screenshots
+
+          sig { params(include_screenshots: T::Boolean).void }
+          attr_writer :include_screenshots
+
+          # 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. Defaults to `false`.
+            include_screenshots: nil,
+
+            # The type of the object. Always `computer_use`.
+
+            type: :computer_use
+          )
+          end
+
+          sig do
+            override.returns(
+              {type: Symbol, include_screenshots: T::Boolean}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
         sig { override.returns(T::Array[OpenAI::Beta::PersistedAgentToolParam::Variants]) }
         def self.variants
         end

data/rbi/openai/models/beta/session_turn_error.rbi

@@ -76,6 +76,9 @@ module OpenAI
           # The request exceeds the available rate limit.
           RATE_LIMIT_EXCEEDED = T.let(:rate_limit_exceeded, OpenAI::Beta::SessionTurnError::Code::TaggedSymbol)
 
+          # Flex processing is temporarily unavailable.
+          FLEX_UNAVAILABLE = T.let(:flex_unavailable, OpenAI::Beta::SessionTurnError::Code::TaggedSymbol)
+
           # The model service is temporarily overloaded.
           SERVER_OVERLOADED = T.let(:server_overloaded, OpenAI::Beta::SessionTurnError::Code::TaggedSymbol)
 

data/rbi/openai/models/chat/chat_completion_content_part_image.rbi

@@ -140,6 +140,7 @@ module OpenAI
             AUTO = T.let(:auto, OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail::TaggedSymbol)
             LOW = T.let(:low, OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail::TaggedSymbol)
             HIGH = T.let(:high, OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail::TaggedSymbol)
+            ORIGINAL = T.let(:original, OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail::TaggedSymbol)
 
             sig {
               override.returns(T::Array[OpenAI::Chat::ChatCompletionContentPartImage::ImageURL::Detail::TaggedSymbol])

data/rbi/openai/models/live/fork_server_event.rbi

@@ -159,7 +159,14 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
-          # A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to
+          # The event_id of the client command, when supplied.
+          sig { returns(T.nilable(String)) }
+          attr_reader :client_event_id
+
+          sig { params(client_event_id: String).void }
+          attr_writer :client_event_id
+
+          # A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
           # sideband observers; this is not a client command.
           sig do
             params(
@@ -168,6 +175,8 @@ module OpenAI
 
               event_id: String,
 
+              client_event_id: String,
+
               type: Symbol
             )
               .returns(T.attached_class)
@@ -178,13 +187,16 @@ module OpenAI
 
             event_id:,
 
+            # The event_id of the client command, when supplied.
+            client_event_id: nil,
+
             type: :"transport.dtmf.send"
           )
           end
 
           sig do
             override.returns(
-              {event: String, event_id: String, type: Symbol}
+              {event: String, event_id: String, type: Symbol, client_event_id: T.nilable(String)}
             )
           end
           def to_hash