openai 0.101.0 → 0.102.0

data/rbi/openai/models/beta/agents/environment_list_params.rbi

@@ -0,0 +1,136 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        class EnvironmentListParams < 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::EnvironmentListParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # Return environments after this environment 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 environments 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 environments are returned. Defaults to `desc`.
+          sig { returns(T.nilable(OpenAI::Beta::Agents::EnvironmentListParams::Order::OrSymbol)) }
+          attr_reader :order
+
+          sig { params(order: OpenAI::Beta::Agents::EnvironmentListParams::Order::OrSymbol).void }
+          attr_writer :order
+
+          # The hosting type to list. Defaults to `openai_hosted`.
+          sig { returns(T.nilable(OpenAI::Beta::Agents::EnvironmentListParams::Type::OrSymbol)) }
+          attr_reader :type
+
+          sig { params(type: OpenAI::Beta::Agents::EnvironmentListParams::Type::OrSymbol).void }
+          attr_writer :type
+
+          sig do
+            params(
+
+              after: String,
+
+              limit: Integer,
+
+              order: OpenAI::Beta::Agents::EnvironmentListParams::Order::OrSymbol,
+
+              type: OpenAI::Beta::Agents::EnvironmentListParams::Type::OrSymbol,
+
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # Return environments after this environment ID in the selected order.
+            after: nil,
+
+            # The maximum number of environments to return, between 1 and 100. Defaults to 20.
+            limit: nil,
+
+            # The order in which environments are returned. Defaults to `desc`.
+            order: nil,
+
+            # The hosting type to list. Defaults to `openai_hosted`.
+            type: nil,
+
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                after: String,
+                limit: Integer,
+                order: OpenAI::Beta::Agents::EnvironmentListParams::Order::OrSymbol,
+                type: OpenAI::Beta::Agents::EnvironmentListParams::Type::OrSymbol,
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The order in which environments are returned. Defaults to `desc`.
+          module Order
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Agents::EnvironmentListParams::Order) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            # Returns resources in ascending order.
+            ASC = T.let(:asc, OpenAI::Beta::Agents::EnvironmentListParams::Order::TaggedSymbol)
+
+            # Returns resources in descending order.
+            DESC = T.let(:desc, OpenAI::Beta::Agents::EnvironmentListParams::Order::TaggedSymbol)
+
+            sig { override.returns(T::Array[OpenAI::Beta::Agents::EnvironmentListParams::Order::TaggedSymbol]) }
+            def self.values
+            end
+          end
+
+          # The hosting type to list. Defaults to `openai_hosted`.
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Agents::EnvironmentListParams::Type) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            OPENAI_HOSTED = T.let(:openai_hosted, OpenAI::Beta::Agents::EnvironmentListParams::Type::TaggedSymbol)
+
+            sig { override.returns(T::Array[OpenAI::Beta::Agents::EnvironmentListParams::Type::TaggedSymbol]) }
+            def self.values
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -91,6 +91,14 @@ module OpenAI
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_accessor :env
 
+          # An existing prewarmed environment. Cannot be combined with a template or inline
+          # configuration.
+          sig { returns(T.nilable(String)) }
+          attr_reader :environment_id
+
+          sig { params(environment_id: String).void }
+          attr_writer :environment_id
+
           # A reusable hosted template applied before inline session configuration. Omitted
           # fields inherit the template; network overrides cannot broaden its policy.
           sig { returns(T.nilable(String)) }
@@ -161,6 +169,8 @@ module OpenAI
 
               env: T.nilable(T::Hash[Symbol, String]),
 
+              environment_id: String,
+
               environment_template_id: String,
 
               files: T.nilable(
@@ -209,6 +219,10 @@ module OpenAI
             # Environment variables made available to the agent.
             env: nil,
 
+            # An existing prewarmed environment. Cannot be combined with a template or inline
+            # configuration.
+            environment_id: nil,
+
             # A reusable hosted template applied before inline session configuration. Omitted
             # fields inherit the template; network overrides cannot broaden its policy.
             environment_template_id: nil,
@@ -247,6 +261,7 @@ module OpenAI
                 container_size: OpenAI::Beta::EnvironmentParam::OpenAIHosted::ContainerSize::OrSymbol,
                 desktop: T.nilable(OpenAI::Beta::EnvironmentParam::OpenAIHosted::Desktop),
                 env: T.nilable(T::Hash[Symbol, String]),
+                environment_id: String,
                 environment_template_id: String,
                 files: T.nilable(
                   T::Array[

data/rbi/openai/models/chat/chat_completion_audio_param.rbi

@@ -25,7 +25,7 @@ module OpenAI
         # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
         # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
         # for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
-        # samples. Voices created from text prompts are supported only in Live.
+        # samples.
         sig {
           returns(
             T.any(
@@ -63,7 +63,7 @@ module OpenAI
           # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
           # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
           # for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
-          # samples. Voices created from text prompts are supported only in Live.
+          # samples.
 
           voice:
         )
@@ -108,7 +108,7 @@ module OpenAI
         # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
         # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
         # for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
-        # samples. Voices created from text prompts are supported only in Live.
+        # samples.
         module Voice
           extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/realtime/realtime_audio_config_output.rbi

@@ -58,8 +58,7 @@ module OpenAI
         # `cedar`. You may also provide a custom voice object with an `id`, for example
         # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
         # model has responded with audio at least once. Custom voices must be created from
-        # audio samples. Voices created from text prompts are supported only in Live. We
-        # recommend `marin` and `cedar` for best quality.
+        # audio samples. We recommend `marin` and `cedar` for best quality.
         sig {
           returns(
             T.nilable(
@@ -123,8 +122,7 @@ module OpenAI
           # `cedar`. You may also provide a custom voice object with an `id`, for example
           # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
           # model has responded with audio at least once. Custom voices must be created from
-          # audio samples. Voices created from text prompts are supported only in Live. We
-          # recommend `marin` and `cedar` for best quality.
+          # audio samples. We recommend `marin` and `cedar` for best quality.
 
           voice: nil
         )
@@ -155,8 +153,7 @@ module OpenAI
         # `cedar`. You may also provide a custom voice object with an `id`, for example
         # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
         # model has responded with audio at least once. Custom voices must be created from
-        # audio samples. Voices created from text prompts are supported only in Live. We
-        # recommend `marin` and `cedar` for best quality.
+        # audio samples. We recommend `marin` and `cedar` for best quality.
         module Voice
           extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi

@@ -81,8 +81,7 @@ module OpenAI
           # `cedar`. You may also provide a custom voice object with an `id`, for example
           # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
           # model has responded with audio at least once. Custom voices must be created from
-          # audio samples. Voices created from text prompts are supported only in Live. We
-          # recommend `marin` and `cedar` for best quality.
+          # audio samples. We recommend `marin` and `cedar` for best quality.
           sig {
             returns(
               T.nilable(
@@ -135,8 +134,7 @@ module OpenAI
             # `cedar`. You may also provide a custom voice object with an `id`, for example
             # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
             # model has responded with audio at least once. Custom voices must be created from
-            # audio samples. Voices created from text prompts are supported only in Live. We
-            # recommend `marin` and `cedar` for best quality.
+            # audio samples. We recommend `marin` and `cedar` for best quality.
 
             voice: nil
           )
@@ -166,8 +164,7 @@ module OpenAI
           # `cedar`. You may also provide a custom voice object with an `id`, for example
           # `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
           # model has responded with audio at least once. Custom voices must be created from
-          # audio samples. Voices created from text prompts are supported only in Live. We
-          # recommend `marin` and `cedar` for best quality.
+          # audio samples. We recommend `marin` and `cedar` for best quality.
           module Voice
             extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/webhooks/agent_environment_failed_webhook_event.rbi

@@ -0,0 +1,134 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Webhooks
+
+      class AgentEnvironmentFailedWebhookEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Webhooks::AgentEnvironmentFailedWebhookEvent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp, in seconds, when the event was created.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Identifies the environment whose lifecycle changed.
+        sig { returns(OpenAI::Webhooks::AgentEnvironmentFailedWebhookEvent::Data) }
+        attr_reader :data
+
+        sig { params(data: OpenAI::Webhooks::AgentEnvironmentFailedWebhookEvent::Data::OrHash).void }
+        attr_writer :data
+
+        # The object type. Always `event`.
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        # The event type. Always `agent.environment.failed`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Sent when setup fails for a prewarmed OpenAI-hosted environment before it is
+        # attached to a session.
+        sig do
+          params(
+
+            id: String,
+
+            created_at: Integer,
+
+            data: OpenAI::Webhooks::AgentEnvironmentFailedWebhookEvent::Data::OrHash,
+
+            object: Symbol,
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The unique ID of the event.
+          id:,
+
+          # The Unix timestamp, in seconds, when the event was created.
+          created_at:,
+
+          # Identifies the environment whose lifecycle changed.
+          data:,
+
+          # The object type. Always `event`.
+          object: :event,
+
+          # The event type. Always `agent.environment.failed`.
+
+          type: :"agent.environment.failed"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::AgentEnvironmentFailedWebhookEvent::Data,
+              object: Symbol,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Webhooks::AgentEnvironmentFailedWebhookEvent::Data,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The ID of the environment.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Identifies the environment whose lifecycle changed.
+          sig do
+            params(
+
+              id: String
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The ID of the environment.
+
+            id:
+          )
+          end
+
+          sig do
+            override.returns(
+              {id: String}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/webhooks/agent_environment_ready_webhook_event.rbi

@@ -0,0 +1,134 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Webhooks
+
+      class AgentEnvironmentReadyWebhookEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Webhooks::AgentEnvironmentReadyWebhookEvent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp, in seconds, when the event was created.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Identifies the environment whose lifecycle changed.
+        sig { returns(OpenAI::Webhooks::AgentEnvironmentReadyWebhookEvent::Data) }
+        attr_reader :data
+
+        sig { params(data: OpenAI::Webhooks::AgentEnvironmentReadyWebhookEvent::Data::OrHash).void }
+        attr_writer :data
+
+        # The object type. Always `event`.
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        # The event type. Always `agent.environment.ready`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Sent when a prewarmed OpenAI-hosted environment finishes setup before being
+        # attached to a session.
+        sig do
+          params(
+
+            id: String,
+
+            created_at: Integer,
+
+            data: OpenAI::Webhooks::AgentEnvironmentReadyWebhookEvent::Data::OrHash,
+
+            object: Symbol,
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The unique ID of the event.
+          id:,
+
+          # The Unix timestamp, in seconds, when the event was created.
+          created_at:,
+
+          # Identifies the environment whose lifecycle changed.
+          data:,
+
+          # The object type. Always `event`.
+          object: :event,
+
+          # The event type. Always `agent.environment.ready`.
+
+          type: :"agent.environment.ready"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::AgentEnvironmentReadyWebhookEvent::Data,
+              object: Symbol,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Webhooks::AgentEnvironmentReadyWebhookEvent::Data,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The ID of the environment.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Identifies the environment whose lifecycle changed.
+          sig do
+            params(
+
+              id: String
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The ID of the environment.
+
+            id:
+          )
+          end
+
+          sig do
+            override.returns(
+              {id: String}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi

@@ -5,13 +5,15 @@ module OpenAI
 
     module Webhooks
 
-      # Sent when an agent session requires an action. Retrieve the session for action
-      # details.
+      # Sent when setup fails for a prewarmed OpenAI-hosted environment before it is
+      # attached to a session.
       module UnwrapWebhookEvent
         extend OpenAI::Internal::Type::Union
 
         Variants = T.type_alias do
           T.any(
+            OpenAI::Webhooks::AgentEnvironmentFailedWebhookEvent,
+            OpenAI::Webhooks::AgentEnvironmentReadyWebhookEvent,
             OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent,
             OpenAI::Webhooks::AgentSessionCreatedWebhookEvent,
             OpenAI::Webhooks::AgentSessionFailedWebhookEvent,

data/rbi/openai/models/webhooks/webhook_create_params.rbi

@@ -121,6 +121,14 @@ module OpenAI
           )
           VIDEO_COMPLETED = T.let(:"video.completed", OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol)
           VIDEO_FAILED = T.let(:"video.failed", OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol)
+          AGENT_ENVIRONMENT_READY = T.let(
+            :"agent.environment.ready",
+            OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol
+          )
+          AGENT_ENVIRONMENT_FAILED = T.let(
+            :"agent.environment.failed",
+            OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol
+          )
           AGENT_SESSION_CREATED = T.let(
             :"agent.session.created",
             OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol

data/rbi/openai/models/webhooks/webhook_test_params.rbi

@@ -106,6 +106,14 @@ module OpenAI
           )
           VIDEO_COMPLETED = T.let(:"video.completed", OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol)
           VIDEO_FAILED = T.let(:"video.failed", OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol)
+          AGENT_ENVIRONMENT_READY = T.let(
+            :"agent.environment.ready",
+            OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol
+          )
+          AGENT_ENVIRONMENT_FAILED = T.let(
+            :"agent.environment.failed",
+            OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol
+          )
           AGENT_SESSION_CREATED = T.let(
             :"agent.session.created",
             OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol

data/rbi/openai/models/webhooks/webhook_update_params.rbi

@@ -138,6 +138,14 @@ module OpenAI
           )
           VIDEO_COMPLETED = T.let(:"video.completed", OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol)
           VIDEO_FAILED = T.let(:"video.failed", OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol)
+          AGENT_ENVIRONMENT_READY = T.let(
+            :"agent.environment.ready",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          AGENT_ENVIRONMENT_FAILED = T.let(
+            :"agent.environment.failed",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
           AGENT_SESSION_CREATED = T.let(
             :"agent.session.created",
             OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol

data/rbi/openai/resources/audio/speech.rbi

@@ -41,8 +41,7 @@ module OpenAI
           # object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
           # voices are available in the
           # [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
-          # Custom voices must be created from audio samples. Voices created from text
-          # prompts are supported only in Live.
+          # Custom voices must be created from audio samples.
           voice:,
           # Control the voice of your generated audio with additional instructions. Does not
           # work with `tts-1` or `tts-1-hd`.

data/rbi/openai/resources/audio/voices.rbi

@@ -8,23 +8,20 @@ module OpenAI
       # Turn audio into text or text into audio.
       class Voices
 
-        # Creates a voice from a text prompt or from a consent recording and an audio
-        # sample.
+        # Create a custom voice you can use for audio output (for example, in
+        # Text-to-Speech and the Realtime API). This requires an audio sample and a
+        # previously uploaded consent recording.
         #
-        # For prompt-based creation, send `type: "prompt"` with a `name` and `prompt` as
-        # JSON or multipart form data. For creation from an audio sample, send
-        # `type: "audio_sample"` with a `name`, `audio_sample`, and `consent` recording ID
-        # as multipart form data. The type defaults to `audio_sample` when omitted.
+        # Send `name`, `audio_sample`, and the `consent` recording ID as multipart form
+        # data. The optional `type` defaults to `audio_sample`.
         #
-        # Returns the saved voice's metadata. Voices created from text prompts are
-        # supported only in Live, not in Realtime or the speech endpoint. The response
-        # does not include preview audio.
+        # Returns the saved voice's metadata. See the
+        # [custom voices guide](https://developers.openai.com/api/docs/guides/text-to-speech#custom-voices)
+        # for requirements and best practices. Custom voices are limited to eligible
+        # customers.
         sig {
           params(
-            body: T.any(
-              OpenAI::Audio::VoiceCreateParams::Body::AudioSample::OrHash,
-              OpenAI::Audio::VoiceCreateParams::Body::Prompt::OrHash
-            ),
+            body: OpenAI::Audio::VoiceCreateParams::Body::AudioSample::OrHash,
             request_options: OpenAI::RequestOptions::OrHash
           )
             .returns(OpenAI::Audio::Voice)