openai 0.97.0 → 0.98.0

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: (

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

@@ -32,6 +32,7 @@ module OpenAI
             plugins: ::Array[OpenAI::Beta::HostedPlugin],
             skills: ::Array[OpenAI::Models::Beta::hosted_skill],
             ?type: :openai_hosted,
+            ?container_size: OpenAI::Models::Beta::Environment::OpenAIHosted::container_size?,
             ?desktop: OpenAI::Beta::Environment::OpenAIHosted::Desktop
           }
 
@@ -60,6 +61,10 @@ module OpenAI
           # The type of the object. Always `openai_hosted`.
           attr_accessor type: :openai_hosted
 
+          # The effective CPU and memory tier, or null when unknown or outside the public
+          # tiers.
+          attr_accessor container_size: OpenAI::Models::Beta::Environment::OpenAIHosted::container_size?
+
           # The effective desktop configuration.
           attr_reader desktop: OpenAI::Beta::Environment::OpenAIHosted::Desktop?
 
@@ -82,6 +87,9 @@ module OpenAI
           #   Plugins installed in the environment, excluding their archive contents.
           # @param skills
           #   Skills installed in the environment, excluding their archive contents.
+          # @param container_size
+          #   The effective CPU and memory tier, or null when unknown or outside the public
+          #   tiers.
           # @param desktop
           #   The effective desktop configuration.
           # @param type
@@ -94,6 +102,7 @@ module OpenAI
             packages: OpenAI::Beta::Environment::OpenAIHosted::Packages,
             plugins: ::Array[OpenAI::Beta::HostedPlugin],
             skills: ::Array[OpenAI::Models::Beta::hosted_skill],
+            ?container_size: OpenAI::Models::Beta::Environment::OpenAIHosted::container_size?,
             ?desktop: OpenAI::Beta::Environment::OpenAIHosted::Desktop,
             ?type: :openai_hosted
           ) -> void
@@ -107,6 +116,7 @@ module OpenAI
             plugins: ::Array[OpenAI::Beta::HostedPlugin],
             skills: ::Array[OpenAI::Models::Beta::hosted_skill],
             ?type: :openai_hosted,
+            ?container_size: OpenAI::Models::Beta::Environment::OpenAIHosted::container_size?,
             ?desktop: OpenAI::Beta::Environment::OpenAIHosted::Desktop
           }
 
@@ -191,6 +201,18 @@ module OpenAI
             }
           end
 
+          type container_size = :small | :medium | :large
+
+          module ContainerSize
+            extend OpenAI::Internal::Type::Enum
+
+            SMALL: :small
+            MEDIUM: :medium
+            LARGE: :large
+
+            def self?.values: -> ::Array[OpenAI::Models::Beta::Environment::OpenAIHosted::container_size]
+          end
+
           type desktop = { enabled: bool }
 
           class Desktop < OpenAI::Internal::Type::BaseModel

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

@@ -26,6 +26,7 @@ module OpenAI
           {
             ?type: :openai_hosted,
             ?capability_directories: ::Array[String]?,
+            ?container_size: OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::container_size,
             ?desktop: OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop?,
             ?env: ::Hash[Symbol, String]?,
             ?environment_template_id: String,
@@ -45,6 +46,14 @@ module OpenAI
           # list.
           attr_accessor capability_directories: ::Array[String]?
 
+          # The hosted container size. Omission selects the medium tier.
+          attr_reader container_size: OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::container_size?
+
+          # The hosted container size. Omission selects the medium tier.
+          def container_size=: (
+            OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::container_size
+          ) -> OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::container_size
+
           # Desktop provisioning. Omission or null inherits the template setting, or
           # defaults to disabled.
           attr_accessor desktop: OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop?
@@ -83,6 +92,8 @@ module OpenAI
           # @param capability_directories
           #   Directories that contain capabilities exposed to the agent. Defaults to an empty
           #   list.
+          # @param container_size
+          #   The hosted container size. Omission selects the medium tier.
           # @param desktop
           #   Desktop provisioning. Omission or null inherits the template setting, or
           #   defaults to disabled.
@@ -109,6 +120,7 @@ module OpenAI
           #   The type of the object. Always `openai_hosted`.
           def initialize: (
             ?capability_directories: ::Array[String]?,
+            ?container_size: OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::container_size,
             ?desktop: OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop?,
             ?env: ::Hash[Symbol, String]?,
             ?environment_template_id: String,
@@ -124,6 +136,7 @@ module OpenAI
           def to_hash: -> {
             ?type: :openai_hosted,
             ?capability_directories: ::Array[String]?,
+            ?container_size: OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::container_size,
             ?desktop: OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop?,
             ?env: ::Hash[Symbol, String]?,
             ?environment_template_id: String,
@@ -135,6 +148,18 @@ module OpenAI
             ?skills: ::Array[OpenAI::Models::Beta::hosted_skill_param]?
           }
 
+          type container_size = :small | :medium | :large
+
+          module ContainerSize
+            extend OpenAI::Internal::Type::Enum
+
+            SMALL: :small
+            MEDIUM: :medium
+            LARGE: :large
+
+            def self?.values: -> ::Array[OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::container_size]
+          end
+
           type desktop = { enabled: bool }
 
           class Desktop < OpenAI::Internal::Type::BaseModel

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

@@ -31,6 +31,7 @@ module OpenAI
           | :usage_limit_exceeded
           | :credit_balance_exhausted
           | :rate_limit_exceeded
+          | :flex_unavailable
           | :server_overloaded
           | :cyber_policy
           | :misalignment_policy_violation
@@ -63,6 +64,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/sig/openai/models/chat/chat_completion_content_part_image.rbs

@@ -81,7 +81,7 @@ module OpenAI
             ?detail: OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::detail
           }
 
-          type detail = :auto | :low | :high
+          type detail = :auto | :low | :high | :original
 
           module Detail
             extend OpenAI::Internal::Type::Enum
@@ -89,6 +89,7 @@ module OpenAI
             AUTO: :auto
             LOW: :low
             HIGH: :high
+            ORIGINAL: :original
 
             def self?.values: -> ::Array[OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::detail]
           end

data/sig/openai/models/live/fork_server_event.rbs

@@ -81,7 +81,12 @@ module OpenAI
         end
 
         type transport_dtmf_send =
-          { event: String, event_id: String, ?type: :"transport.dtmf.send" }
+          {
+            event: String,
+            event_id: String,
+            ?type: :"transport.dtmf.send",
+            ?client_event_id: String
+          }
 
         class TransportDtmfSend < OpenAI::Internal::Type::BaseModel
           attr_accessor event: String
@@ -90,16 +95,26 @@ module OpenAI
 
           attr_accessor type: :"transport.dtmf.send"
 
+          # The event_id of the client command, when supplied.
+          attr_reader client_event_id: String?
+
+          # The event_id of the client command, when supplied.
+          def client_event_id=: (String) -> String
+
+          # @param client_event_id
+          #   The event_id of the client command, when supplied.
           def initialize: (
             event: String,
             event_id: String,
+            ?client_event_id: String,
             ?type: :"transport.dtmf.send"
           ) -> void
 
           def to_hash: -> {
             event: String,
             event_id: String,
-            ?type: :"transport.dtmf.send"
+            ?type: :"transport.dtmf.send",
+            ?client_event_id: String
           }
         end
 

data/sig/openai/models/live/server_event.rbs

@@ -81,7 +81,12 @@ module OpenAI
         end
 
         type transport_dtmf_send =
-          { event: String, event_id: String, ?type: :"transport.dtmf.send" }
+          {
+            event: String,
+            event_id: String,
+            ?type: :"transport.dtmf.send",
+            ?client_event_id: String
+          }
 
         class TransportDtmfSend < OpenAI::Internal::Type::BaseModel
           attr_accessor event: String
@@ -90,16 +95,26 @@ module OpenAI
 
           attr_accessor type: :"transport.dtmf.send"
 
+          # The event_id of the client command, when supplied.
+          attr_reader client_event_id: String?
+
+          # The event_id of the client command, when supplied.
+          def client_event_id=: (String) -> String
+
+          # @param client_event_id
+          #   The event_id of the client command, when supplied.
           def initialize: (
             event: String,
             event_id: String,
+            ?client_event_id: String,
             ?type: :"transport.dtmf.send"
           ) -> void
 
           def to_hash: -> {
             event: String,
             event_id: String,
-            ?type: :"transport.dtmf.send"
+            ?type: :"transport.dtmf.send",
+            ?client_event_id: String
           }
         end
 

data/sig/openai/models/realtime/translations/client_secret_create_params.rbs

@@ -0,0 +1,39 @@
+module OpenAI
+  module Models
+    module Realtime
+      module Translations
+        type client_secret_create_params =
+          {
+            session: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest,
+            ?expires_after: OpenAI::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter,
+            ?request_options: OpenAI::request_opts
+          }
+
+        class ClientSecretCreateParams < OpenAI::Models::Realtime::RealtimeTranslationClientSecretCreateRequest
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @param session
+          #   Realtime translation session configuration. Translation sessions stream source
+          #   audio in and translated audio plus transcript deltas out continuously.
+          # @param expires_after
+          #   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.
+          def initialize: (
+            session: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest,
+            ?expires_after: OpenAI::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            session: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest,
+            ?expires_after: OpenAI::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter,
+            ?request_options: OpenAI::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/responses/response_output_text.rbs

@@ -69,7 +69,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`.
@@ -80,7 +80,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/responses/response_output_text_annotation_added_event.rbs

@@ -92,7 +92,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`.
@@ -103,7 +103,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/resources/beta/agents/environments/files.rbs

@@ -4,6 +4,23 @@ module OpenAI
       class Agents
         class Environments
           class Files
+            # Beta file helpers.
+            def prepare: (
+              Hash[String, String | Pathname] files,
+              ?request_options: OpenAI::request_opts
+            ) -> OpenAI::Helpers::Beta::Agents::PreparedFiles
+            def prepare_directory: (
+              String | Pathname directory,
+              destination: String,
+              include: Array[String],
+              ?request_options: OpenAI::request_opts
+            ) -> OpenAI::Helpers::Beta::Agents::PreparedFiles
+            def upload: (
+              String environment_id,
+              file: String | Pathname,
+              path: String,
+              ?request_options: OpenAI::request_opts
+            ) -> OpenAI::Helpers::Beta::Agents::PreparedFiles
             def create: (
               String environment_id,
               hosted_environment_file_param: OpenAI::Models::Beta::hosted_environment_file_param,

data/sig/openai/resources/beta/agents/sessions/artifacts.rbs

@@ -4,6 +4,10 @@ module OpenAI
       class Agents
         class Sessions
           class Artifacts
+            # Beta result-scoped downloads.
+            def for_result: (
+              OpenAI::Helpers::Beta::Agents::TurnResult result
+            ) -> OpenAI::Helpers::Beta::Agents::ResultArtifacts
             def retrieve: (
               String artifact_id,
               session_id: String,

data/sig/openai/resources/beta/agents/sessions/traces.rbs

@@ -0,0 +1,21 @@
+module OpenAI
+  module Resources
+    class Beta
+      class Agents
+        class Sessions
+          class Traces
+            def list: (
+              String session_id,
+              ?after: String,
+              ?limit: Integer,
+              ?order: OpenAI::Models::Beta::Agents::Sessions::TraceListParams::order,
+              ?request_options: OpenAI::request_opts
+            ) -> OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Sessions::SessionTrace]
+
+            def initialize: (client: OpenAI::Client) -> void
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/resources/beta/agents/sessions.rbs

@@ -11,6 +11,8 @@ module OpenAI
 
           attr_reader events: OpenAI::Resources::Beta::Agents::Sessions::Events
 
+          attr_reader traces: OpenAI::Resources::Beta::Agents::Sessions::Traces
+
           attr_reader turns: OpenAI::Resources::Beta::Agents::Sessions::Turns
 
           def create: (
@@ -27,11 +29,12 @@ module OpenAI
             environment: OpenAI::Models::Beta::environment_param,
             ?agent: OpenAI::Beta::Agents::SessionCreateParams::Agent,
             ?agent_id: String,
+            ?output_type: singleton(OpenAI::Helpers::StructuredOutput::BaseModel)?,
             ?input: OpenAI::Models::Beta::Agents::SessionCreateParams::input?,
             ?metadata: ::Hash[Symbol, String]?,
             ?vault_ids: ::Array[String]?,
             ?request_options: OpenAI::request_opts
-          ) -> OpenAI::Internal::Stream[OpenAI::Models::Beta::agent_session_event]
+          ) -> OpenAI::Helpers::Beta::Agents::CreationStream
 
           def retrieve: (
             String session_id,

data/sig/openai/resources/realtime/translations/client_secrets.rbs

@@ -0,0 +1,17 @@
+module OpenAI
+  module Resources
+    class Realtime
+      class Translations
+        class ClientSecrets
+          def create: (
+            session: OpenAI::Realtime::RealtimeTranslationSessionCreateRequest,
+            ?expires_after: OpenAI::Realtime::RealtimeTranslationClientSecretCreateRequest::ExpiresAfter,
+            ?request_options: OpenAI::request_opts
+          ) -> OpenAI::Realtime::RealtimeTranslationClientSecretCreateResponse
+
+          def initialize: (client: OpenAI::Client) -> void
+        end
+      end
+    end
+  end
+end

data/sig/openai/resources/realtime/translations.rbs

@@ -0,0 +1,11 @@
+module OpenAI
+  module Resources
+    class Realtime
+      class Translations
+        attr_reader client_secrets: OpenAI::Resources::Realtime::Translations::ClientSecrets
+
+        def initialize: (client: OpenAI::Client) -> void
+      end
+    end
+  end
+end

data/sig/openai/resources/realtime.rbs

@@ -5,6 +5,8 @@ module OpenAI
 
       attr_reader calls: OpenAI::Resources::Realtime::Calls
 
+      attr_reader translations: OpenAI::Resources::Realtime::Translations
+
       def initialize: (client: OpenAI::Client) -> void
     end
   end