openai 0.97.0 → 0.98.0

data/lib/openai/internal/type/union.rb

@@ -88,7 +88,7 @@ module OpenAI
         # @param value [Object]
         #
         # @return [OpenAI::Internal::Type::Converter, Class, nil]
-        private def resolve_variant(value)
+        private def resolve_variant(value, state: nil)
           case [@discriminator, value]
           in [_, OpenAI::Internal::Type::BaseModel]
             value.class
@@ -101,18 +101,18 @@ module OpenAI
 
             key = key.to_sym if key.is_a?(String)
             _, found = known_variants.find { |k,| !k.nil? && k == key }
-            return found.call if found
+            return OpenAI::Internal::Type::Converter.resolve_type(found, state: state) if found
 
             known_variants.each do |variant_key, variant_fn|
               next unless variant_key.nil?
 
-              target = variant_fn.call
+              target = OpenAI::Internal::Type::Converter.resolve_type(variant_fn, state: state)
               next unless target.is_a?(Class) && target <= OpenAI::Internal::Type::BaseModel
 
               field = target.known_fields[@discriminator]
               next unless field
 
-              type = field.fetch(:type_fn).call
+              type = OpenAI::Internal::Type::Converter.resolve_type(field.fetch(:type_fn), state: state)
               next unless OpenAI::Internal::Type::Enum === type
 
               return target if type === key
@@ -174,7 +174,7 @@ module OpenAI
         def coerce(value, state:)
           strictness = state.fetch(:strictness)
           previous_error = state.fetch(:error)
-          if (target = resolve_variant(value))
+          if (target = resolve_variant(value, state: state))
             return OpenAI::Internal::Type::Converter.coerce(target, value, state: state)
           end
 
@@ -182,7 +182,7 @@ module OpenAI
 
           alternatives = []
           known_variants.each_with_index do |(_, variant_fn), index|
-            target = variant_fn.call
+            target = OpenAI::Internal::Type::Converter.resolve_type(variant_fn, state: state)
             exact = state[:exactness] = {yes: 0, no: 0, maybe: 0}
             state[:branched] += 1
 

data/lib/openai/models/beta/agents/sessions/session_trace.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Traces#list
+          class SessionTrace < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The root turn ID. Use this ID as the pagination anchor.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created_at
+            #   The Unix timestamp in seconds when the root turn was created.
+            #
+            #   @return [Integer]
+            required :created_at, Integer
+
+            # @!attribute object
+            #   The object type, which is always `agent.session.trace`.
+            #
+            #   @return [Symbol, :"agent.session.trace"]
+            required :object, const: :"agent.session.trace"
+
+            # @!attribute otlp
+            #   An OTLP JSON ExportTraceServiceRequest containing resourceSpans. Only currently
+            #   published data is returned; later trace updates are not awaited.
+            #
+            #   @return [Hash{Symbol=>Object}]
+            required :otlp, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+
+            # @!attribute session_id
+            #   The session that owns this trace.
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!method initialize(id:, created_at:, otlp:, session_id:, object: :"agent.session.trace")
+            #   @param id [String]
+            #     The root turn ID. Use this ID as the pagination anchor.
+            #
+            #   @param created_at [Integer]
+            #     The Unix timestamp in seconds when the root turn was created.
+            #
+            #   @param otlp [Hash{Symbol=>Object}]
+            #     An OTLP JSON ExportTraceServiceRequest containing resourceSpans. Only currently
+            #     published data is returned; later trace updates are not awaited.
+            #
+            #   @param session_id [String]
+            #     The session that owns this trace.
+            #
+            #   @param object [Symbol, :"agent.session.trace"]
+            #     The object type, which is always `agent.session.trace`.
+          end
+        end
+
+        SessionTrace = Sessions::SessionTrace
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/sessions/trace_list_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Sessions
+          # @see OpenAI::Resources::Beta::Agents::Sessions::Traces#list
+          class TraceListParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute session_id
+            #
+            #   @return [String]
+            required :session_id, String
+
+            # @!attribute after
+            #   Return resources after this resource ID in the selected order.
+            #
+            #   @return [String, nil]
+            optional :after, String
+
+            # @!attribute limit
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!attribute order
+            #   The order in which resources are returned. Defaults to `desc`.
+            #
+            #   @return [Symbol, OpenAI::Models::Beta::Agents::Sessions::TraceListParams::Order, nil]
+            optional :order, enum: -> { OpenAI::Beta::Agents::Sessions::TraceListParams::Order }
+
+            # @!method initialize(session_id:, after: nil, limit: nil, order: nil, request_options: {})
+            #   @param session_id [String]
+            #
+            #   @param after [String]
+            #     Return resources after this resource ID in the selected order.
+            #
+            #   @param limit [Integer]
+            #     The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            #
+            #   @param order [Symbol, OpenAI::Models::Beta::Agents::Sessions::TraceListParams::Order]
+            #     The order in which resources are returned. Defaults to `desc`.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # The order in which resources are returned. Defaults to `desc`.
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              # Returns resources in ascending order.
+              ASC = :asc
+
+              # Returns resources in descending order.
+              DESC = :desc
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/vaults/credential.rb

@@ -55,7 +55,11 @@ module OpenAI
             #   @return [String]
             required :vault_id, String
 
-            # @!method initialize(id:, auth:, created_at:, metadata:, name:, updated_at:, vault_id:, object: :"vault.credential")
+            def initialize(data = {})
+              super({metadata: {}, **data})
+            end
+
+            # @!method initialize(id:, auth:, created_at:, name:, updated_at:, vault_id:, metadata: {}, object: :"vault.credential")
             #   Metadata for a stored credential. Secret values are never returned.
             #
             #   @param id [String]
@@ -67,9 +71,6 @@ module OpenAI
             #   @param created_at [Integer]
             #     The Unix timestamp, in seconds, when the credential was created.
             #
-            #   @param metadata [Hash{Symbol=>String}]
-            #     Application-defined key-value pairs associated with this credential.
-            #
             #   @param name [String]
             #     The human-readable name of the credential.
             #
@@ -79,6 +80,9 @@ module OpenAI
             #   @param vault_id [String]
             #     The ID of the vault containing this credential.
             #
+            #   @param metadata [Hash{Symbol=>String}]
+            #     Application-defined key-value pairs associated with this credential.
+            #
             #   @param object [Symbol, :"vault.credential"]
             #     The object type. Always `vault.credential`.
           end

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

@@ -79,7 +79,7 @@ module OpenAI
             required :filename, String
 
             # @!attribute index
-            #   The index of the file in the list of files.
+            #   The index in the output text at which to insert the file citation.
             #
             #   @return [Integer]
             required :index, Integer
@@ -100,7 +100,7 @@ module OpenAI
             #     The filename of the file cited.
             #
             #   @param index [Integer]
-            #     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 [Symbol, :file_citation]
             #     The type of the file citation. Always `file_citation`.

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

@@ -126,7 +126,7 @@ module OpenAI
             required :filename, String
 
             # @!attribute index
-            #   The index of the file in the list of files.
+            #   The index in the output text at which to insert the file citation.
             #
             #   @return [Integer]
             required :index, Integer
@@ -147,7 +147,7 @@ module OpenAI
             #     The filename of the file cited.
             #
             #   @param index [Integer]
-            #     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 [Symbol, :file_citation]
             #     The type of the file citation. Always `file_citation`.

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

@@ -82,13 +82,26 @@ module OpenAI
           #   @return [Symbol, :openai_hosted]
           required :type, const: :openai_hosted
 
+          # @!attribute container_size
+          #   The effective CPU and memory tier, or null when unknown or outside the public
+          #   tiers.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::Environment::OpenAIHosted::ContainerSize, nil]
+          optional(
+            :container_size,
+            enum: -> {
+              OpenAI::Beta::Environment::OpenAIHosted::ContainerSize
+            },
+            nil?: true
+          )
+
           # @!attribute desktop
           #   The effective desktop configuration.
           #
           #   @return [OpenAI::Models::Beta::Environment::OpenAIHosted::Desktop, nil]
           optional :desktop, -> { OpenAI::Beta::Environment::OpenAIHosted::Desktop }
 
-          # @!method initialize(id:, capability_directories:, files:, network:, packages:, plugins:, skills:, desktop: nil, type: :openai_hosted)
+          # @!method initialize(id:, capability_directories:, files:, network:, packages:, plugins:, skills:, container_size: nil, desktop: nil, type: :openai_hosted)
           #   An environment hosted by OpenAI.
           #
           #   @param id [String]
@@ -112,6 +125,10 @@ module OpenAI
           #   @param skills [Array<OpenAI::Models::Beta::HostedSkillReference, OpenAI::Models::Beta::HostedSkill::Inline>]
           #     Skills installed in the environment, excluding their archive contents.
           #
+          #   @param container_size [Symbol, OpenAI::Models::Beta::Environment::OpenAIHosted::ContainerSize, nil]
+          #     The effective CPU and memory tier, or null when unknown or outside the public
+          #     tiers.
+          #
           #   @param desktop [OpenAI::Models::Beta::Environment::OpenAIHosted::Desktop]
           #     The effective desktop configuration.
           #
@@ -194,6 +211,21 @@ module OpenAI
             #     System packages installed in the environment.
           end
 
+          # The effective CPU and memory tier, or null when unknown or outside the public
+          # tiers.
+          #
+          # @see OpenAI::Models::Beta::Environment::OpenAIHosted#container_size
+          module ContainerSize
+            extend OpenAI::Internal::Type::Enum
+
+            SMALL = :small
+            MEDIUM = :medium
+            LARGE = :large
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # @see OpenAI::Models::Beta::Environment::OpenAIHosted#desktop
           class Desktop < OpenAI::Internal::Type::BaseModel
             # @!attribute enabled

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

@@ -46,6 +46,12 @@ module OpenAI
           #   @return [Array<String>, nil]
           optional :capability_directories, OpenAI::Internal::Type::ArrayOf[String], nil?: true
 
+          # @!attribute container_size
+          #   The hosted container size. Omission selects the medium tier.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::ContainerSize, nil]
+          optional :container_size, enum: -> { OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize }
+
           # @!attribute desktop
           #   Desktop provisioning. Omission or null inherits the template setting, or
           #   defaults to disabled.
@@ -122,7 +128,7 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(capability_directories: nil, desktop: nil, env: nil, environment_template_id: nil, files: nil, network: nil, packages: nil, plugins: nil, setup_commands: nil, skills: nil, type: :openai_hosted)
+          # @!method initialize(capability_directories: nil, container_size: nil, desktop: nil, env: nil, environment_template_id: nil, files: nil, network: nil, packages: nil, plugins: nil, setup_commands: nil, skills: nil, type: :openai_hosted)
           #   An existing OpenAI-hosted environment or new inline/template-based hosted
           #   configuration.
           #
@@ -130,6 +136,9 @@ module OpenAI
           #     Directories that contain capabilities exposed to the agent. Defaults to an empty
           #     list.
           #
+          #   @param container_size [Symbol, OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::ContainerSize]
+          #     The hosted container size. Omission selects the medium tier.
+          #
           #   @param desktop [OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Desktop, nil]
           #     Desktop provisioning. Omission or null inherits the template setting, or
           #     defaults to disabled.
@@ -164,6 +173,20 @@ module OpenAI
           #   @param type [Symbol, :openai_hosted]
           #     The type of the object. Always `openai_hosted`.
 
+          # The hosted container size. Omission selects the medium tier.
+          #
+          # @see OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted#container_size
+          module ContainerSize
+            extend OpenAI::Internal::Type::Enum
+
+            SMALL = :small
+            MEDIUM = :medium
+            LARGE = :large
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # @see OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted#desktop
           class Desktop < OpenAI::Internal::Type::BaseModel
             # @!attribute enabled

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

@@ -46,6 +46,9 @@ module OpenAI
           # The request exceeds the available rate limit.
           RATE_LIMIT_EXCEEDED = :rate_limit_exceeded
 
+          # Flex processing is temporarily unavailable.
+          FLEX_UNAVAILABLE = :flex_unavailable
+
           # The model service is temporarily overloaded.
           SERVER_OVERLOADED = :server_overloaded
 

data/lib/openai/models/chat/chat_completion_content_part_image.rb

@@ -73,6 +73,7 @@ module OpenAI
             AUTO = :auto
             LOW = :low
             HIGH = :high
+            ORIGINAL = :original
 
             # @!method self.values
             #   @return [Array<Symbol>]

data/lib/openai/models/live/fork_server_event.rb

@@ -67,7 +67,7 @@ module OpenAI
         # A SIP DTMF keypress received from the caller. Delivered only to sideband observers.
         variant :"transport.dtmf.received", -> { OpenAI::Live::ForkServerEvent::TransportDtmfReceived }
 
-        # A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to sideband observers; this is not a client command.
+        # A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to sideband observers; this is not a client command.
         variant :"transport.dtmf.send", -> { OpenAI::Live::ForkServerEvent::TransportDtmfSend }
 
         # The outbound SIP provider leg is ringing or providing early media. Delivered only to sideband observers.
@@ -148,12 +148,23 @@ module OpenAI
           #   @return [Symbol, :"transport.dtmf.send"]
           required :type, const: :"transport.dtmf.send"
 
-          # @!method initialize(event:, event_id:, type: :"transport.dtmf.send")
-          #   A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to
+          # @!attribute client_event_id
+          #   The event_id of the client command, when supplied.
+          #
+          #   @return [String, nil]
+          optional :client_event_id, String
+
+          # @!method initialize(event:, event_id:, client_event_id: nil, type: :"transport.dtmf.send")
+          #   A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
           #   sideband observers; this is not a client command.
           #
           #   @param event [String]
+          #
           #   @param event_id [String]
+          #
+          #   @param client_event_id [String]
+          #     The event_id of the client command, when supplied.
+          #
           #   @param type [Symbol, :"transport.dtmf.send"]
         end
 

data/lib/openai/models/live/server_event.rb

@@ -67,7 +67,7 @@ module OpenAI
         # A SIP DTMF keypress received from the caller. Delivered only to sideband observers.
         variant :"transport.dtmf.received", -> { OpenAI::Live::ServerEvent::TransportDtmfReceived }
 
-        # A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to sideband observers; this is not a client command.
+        # A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to sideband observers; this is not a client command.
         variant :"transport.dtmf.send", -> { OpenAI::Live::ServerEvent::TransportDtmfSend }
 
         # The outbound SIP provider leg is ringing or providing early media. Delivered only to sideband observers.
@@ -148,12 +148,23 @@ module OpenAI
           #   @return [Symbol, :"transport.dtmf.send"]
           required :type, const: :"transport.dtmf.send"
 
-          # @!method initialize(event:, event_id:, type: :"transport.dtmf.send")
-          #   A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to
+          # @!attribute client_event_id
+          #   The event_id of the client command, when supplied.
+          #
+          #   @return [String, nil]
+          optional :client_event_id, String
+
+          # @!method initialize(event:, event_id:, client_event_id: nil, type: :"transport.dtmf.send")
+          #   A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
           #   sideband observers; this is not a client command.
           #
           #   @param event [String]
+          #
           #   @param event_id [String]
+          #
+          #   @param client_event_id [String]
+          #     The event_id of the client command, when supplied.
+          #
           #   @param type [Symbol, :"transport.dtmf.send"]
         end
 

data/lib/openai/models/realtime/translations/client_secret_create_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      module Translations
+        # @see OpenAI::Resources::Realtime::Translations::ClientSecrets#create
+        class ClientSecretCreateParams < OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!method initialize(session:, expires_after: nil, request_options: {})
+          #   @param session [OpenAI::Models::Realtime::RealtimeTranslationSessionCreateRequest]
+          #     Realtime translation session configuration. Translation sessions stream source
+          #     audio in and translated audio plus transcript deltas out continuously.
+          #
+          #   @param expires_after [OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter]
+          #     Configuration for the client secret expiration. Expiration refers to the time
+          #     after which a client secret will no longer be valid for creating sessions. The
+          #     session itself may continue after that time once started. A secret can be used
+          #     to create multiple sessions until it expires.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/responses/response_output_text.rb

@@ -87,7 +87,7 @@ module OpenAI
             required :filename, String
 
             # @!attribute index
-            #   The index of the file in the list of files.
+            #   The index in the output text at which to insert the file citation.
             #
             #   @return [Integer]
             required :index, Integer
@@ -108,7 +108,7 @@ module OpenAI
             #     The filename of the file cited.
             #
             #   @param index [Integer]
-            #     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 [Symbol, :file_citation]
             #     The type of the file citation. Always `file_citation`.

data/lib/openai/models/responses/response_output_text_annotation_added_event.rb

@@ -117,7 +117,7 @@ module OpenAI
             required :filename, String
 
             # @!attribute index
-            #   The index of the file in the list of files.
+            #   The index in the output text at which to insert the file citation.
             #
             #   @return [Integer]
             required :index, Integer
@@ -138,7 +138,7 @@ module OpenAI
             #     The filename of the file cited.
             #
             #   @param index [Integer]
-            #     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 [Symbol, :file_citation]
             #     The type of the file citation. Always `file_citation`.

data/lib/openai/resources/beta/agents/environments/files.rb

@@ -1,11 +1,42 @@
 # frozen_string_literal: true
 
+require_relative "../../../../helpers/beta/agents/files"
+
 module OpenAI
   module Resources
     class Beta
       class Agents
         class Environments
           class Files
+            # Upload selected local files for a new hosted environment (beta).
+            # @return [OpenAI::Helpers::Beta::Agents::PreparedFiles]
+            def prepare(files, request_options: {})
+              OpenAI::Helpers::Beta::Agents::FilePreparation
+                .new(client: @client, environment_files: self)
+                .prepare(files, request_options: request_options)
+            end
+
+            # Upload an explicitly selected directory snapshot (beta).
+            # @return [OpenAI::Helpers::Beta::Agents::PreparedFiles]
+            def prepare_directory(directory, destination:, include:, request_options: {})
+              OpenAI::Helpers::Beta::Agents::FilePreparation
+                .new(client: @client, environment_files: self)
+                .prepare_directory(
+                  directory,
+                  destination: destination,
+                  include: include,
+                  request_options: request_options
+                )
+            end
+
+            # Upload and stage a local file in an existing environment (beta).
+            # @return [OpenAI::Helpers::Beta::Agents::PreparedFiles]
+            def upload(environment_id, file:, path:, request_options: {})
+              OpenAI::Helpers::Beta::Agents::FilePreparation
+                .new(client: @client, environment_files: self)
+                .upload(environment_id, file: file, path: path, request_options: request_options)
+            end
+
             # Copies inline bytes or a Files API file into a connected execution environment.
             # See
             # [environment files](https://developers.openai.com/api/docs/guides/agents-api/environments/files).

data/lib/openai/resources/beta/agents/sessions/artifacts.rb

@@ -1,11 +1,19 @@
 # frozen_string_literal: true
 
+require_relative "../../../../helpers/beta/agents/artifacts"
+
 module OpenAI
   module Resources
     class Beta
       class Agents
         class Sessions
           class Artifacts
+            # Access artifacts from exactly this completed turn (beta).
+            # @return [OpenAI::Helpers::Beta::Agents::ResultArtifacts]
+            def for_result(result)
+              OpenAI::Helpers::Beta::Agents::ResultArtifacts.new(artifacts: self, client: @client, result: result)
+            end
+
             # Retrieves immutable metadata for one durable session artifact. See
             # [session artifacts](https://developers.openai.com/api/docs/guides/agents-api/environments/files#openai-hosted-artifacts).
             #

data/lib/openai/resources/beta/agents/sessions/events.rb

@@ -6,11 +6,12 @@ module OpenAI
       class Agents
         class Sessions
           class Events
-            # Submits message, cancellation, or tool-result events to a managed agent session.
-            # Cancellation can recover a still-open turn whose backend execution has ended by
-            # marking it cancelled and abandoning unpublished outputs. Saved results,
-            # published files, and existing terminal outcomes are preserved. HTTP 202 confirms
-            # acceptance, not durable completion. See
+            # Submits message, cancellation, tool-result, or computer-use approval-response
+            # events to a managed agent session. Cancellation can recover a still-open turn
+            # whose backend execution has ended by marking it cancelled and abandoning
+            # unpublished outputs. Saved results, published files, and existing terminal
+            # outcomes are preserved. HTTP 202 confirms acceptance, not durable completion.
+            # See
             # [session events](https://developers.openai.com/api/docs/guides/agents-api/sessions/events).
             #
             # @overload create(session_id, events:, idempotency_key: nil, request_options: {})