openai 0.97.0 → 0.99.0

data/rbi/openai/models/webhooks/agent_session_in_progress_webhook_event.rbi

@@ -0,0 +1,151 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Webhooks
+
+      class AgentSessionInProgressWebhookEvent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Webhooks::AgentSessionInProgressWebhookEvent,
+            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
+
+        sig { returns(OpenAI::Webhooks::AgentSessionInProgressWebhookEvent::Data) }
+        attr_reader :data
+
+        sig { params(data: OpenAI::Webhooks::AgentSessionInProgressWebhookEvent::Data::OrHash).void }
+        attr_writer :data
+
+        # The object type. Always `event`.
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        # The event type. Always `agent.session.in_progress`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Sent when an agent session enters the in-progress state.
+        sig do
+          params(
+
+            id: String,
+
+            created_at: Integer,
+
+            data: OpenAI::Webhooks::AgentSessionInProgressWebhookEvent::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:,
+
+          data:,
+
+          # The object type. Always `event`.
+          object: :event,
+
+          # The event type. Always `agent.session.in_progress`.
+
+          type: :"agent.session.in_progress"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::AgentSessionInProgressWebhookEvent::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::AgentSessionInProgressWebhookEvent::Data,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The ID of the session.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The environment type: `none`, `openai_hosted`, or `self_hosted`.
+          sig { returns(String) }
+          attr_accessor :environment_type
+
+          # The ID of the environment, when one exists.
+          sig { returns(T.nilable(String)) }
+          attr_reader :environment_id
+
+          sig { params(environment_id: String).void }
+          attr_writer :environment_id
+
+          sig do
+            params(
+
+              id: String,
+
+              environment_type: String,
+
+              environment_id: String
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The ID of the session.
+            id:,
+
+            # The environment type: `none`, `openai_hosted`, or `self_hosted`.
+            environment_type:,
+
+            # The ID of the environment, when one exists.
+
+            environment_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {id: String, environment_type: String, environment_id: String}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -5,12 +5,18 @@ module OpenAI
 
     module Webhooks
 
-      # Sent when a batch API request has been cancelled.
+      # Sent when an agent session requires an action. Retrieve the session for action
+      # details.
       module UnwrapWebhookEvent
         extend OpenAI::Internal::Type::Union
 
         Variants = T.type_alias do
           T.any(
+            OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent,
+            OpenAI::Webhooks::AgentSessionCreatedWebhookEvent,
+            OpenAI::Webhooks::AgentSessionFailedWebhookEvent,
+            OpenAI::Webhooks::AgentSessionIdleWebhookEvent,
+            OpenAI::Webhooks::AgentSessionInProgressWebhookEvent,
             OpenAI::Webhooks::BatchCancelledWebhookEvent,
             OpenAI::Webhooks::BatchCompletedWebhookEvent,
             OpenAI::Webhooks::BatchExpiredWebhookEvent,

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

@@ -121,6 +121,26 @@ 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_SESSION_CREATED = T.let(
+            :"agent.session.created",
+            OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_ACTION_REQUIRED = T.let(
+            :"agent.session.action_required",
+            OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_IN_PROGRESS = T.let(
+            :"agent.session.in_progress",
+            OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_IDLE = T.let(
+            :"agent.session.idle",
+            OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_FAILED = T.let(
+            :"agent.session.failed",
+            OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol
+          )
           SAFETY_ALERT_CREATED = T.let(
             :"safety.alert.created",
             OpenAI::Webhooks::WebhookCreateParams::EventType::TaggedSymbol

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

@@ -106,6 +106,26 @@ 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_SESSION_CREATED = T.let(
+            :"agent.session.created",
+            OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_ACTION_REQUIRED = T.let(
+            :"agent.session.action_required",
+            OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_IN_PROGRESS = T.let(
+            :"agent.session.in_progress",
+            OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_IDLE = T.let(
+            :"agent.session.idle",
+            OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_FAILED = T.let(
+            :"agent.session.failed",
+            OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol
+          )
           SAFETY_ALERT_CREATED = T.let(
             :"safety.alert.created",
             OpenAI::Webhooks::WebhookTestParams::EventType::TaggedSymbol

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

@@ -138,6 +138,26 @@ 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_SESSION_CREATED = T.let(
+            :"agent.session.created",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_ACTION_REQUIRED = T.let(
+            :"agent.session.action_required",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_IN_PROGRESS = T.let(
+            :"agent.session.in_progress",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_IDLE = T.let(
+            :"agent.session.idle",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
+          AGENT_SESSION_FAILED = T.let(
+            :"agent.session.failed",
+            OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol
+          )
           SAFETY_ALERT_CREATED = T.let(
             :"safety.alert.created",
             OpenAI::Webhooks::WebhookUpdateParams::EventType::TaggedSymbol

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

@@ -41,6 +41,8 @@ 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.
           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

@@ -0,0 +1,49 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Audio
+
+      # 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.
+        #
+        # 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.
+        #
+        # 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.
+        sig {
+          params(
+            body: T.any(
+              OpenAI::Audio::VoiceCreateParams::Body::AudioSample::OrHash,
+              OpenAI::Audio::VoiceCreateParams::Body::Prompt::OrHash
+            ),
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(OpenAI::Audio::Voice)
+        }
+        def create(
+          # Creates a voice from a consent recording and an audio sample. Requires
+          # multipart/form-data.
+          body:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/audio.rbi

@@ -17,6 +17,10 @@ module OpenAI
       sig { returns(OpenAI::Resources::Audio::Speech) }
       attr_reader :speech
 
+      # Turn audio into text or text into audio.
+      sig { returns(OpenAI::Resources::Audio::Voices) }
+      attr_reader :voices
+
       # @api private
       sig { params(client: OpenAI::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/openai/resources/beta/agents/environments/files.rbi

@@ -10,6 +10,37 @@ module OpenAI
         class Environments
 
           class Files
+            # Beta file helpers.
+            sig {
+              params(files: T::Hash[String, T.any(String, Pathname)], request_options: OpenAI::RequestOptions::OrHash)
+                .returns(OpenAI::Helpers::Beta::Agents::PreparedFiles)
+            }
+            def prepare(files, request_options: {})
+            end
+
+            sig {
+              params(
+                directory: T.any(String, Pathname),
+                destination: String,
+                include: T::Array[String],
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Helpers::Beta::Agents::PreparedFiles)
+            }
+            def prepare_directory(directory, destination:, include:, request_options: {})
+            end
+
+            sig {
+              params(
+                environment_id: String,
+                file: T.any(String, Pathname),
+                path: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Helpers::Beta::Agents::PreparedFiles)
+            }
+            def upload(environment_id, file:, path:, request_options: {})
+            end
 
             # Copies inline bytes or a Files API file into a connected execution environment.
             # See

data/rbi/openai/resources/beta/agents/sessions/artifacts.rbi

@@ -10,6 +10,14 @@ module OpenAI
         class Sessions
 
           class Artifacts
+            # Beta result-scoped downloads.
+            sig {
+              params(result: OpenAI::Helpers::Beta::Agents::TurnResult).returns(
+                OpenAI::Helpers::Beta::Agents::ResultArtifacts
+              )
+            }
+            def for_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/rbi/openai/resources/beta/agents/sessions/events.rbi

@@ -11,11 +11,12 @@ module OpenAI
 
           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).
             sig {
               params(

data/rbi/openai/resources/beta/agents/sessions/traces.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+
+    class Beta
+
+      class Agents
+
+        class Sessions
+
+          class Traces
+
+            # Lists published root-turn traces as OTLP JSON, ordered by turn creation time and
+            # ID. Unpublished traces are skipped. Each page returns data available when read;
+            # it does not wait for late traces. Trace reads and the JSON response are limited
+            # to 16 MiB per request. If the limit is exceeded, request fewer traces.
+            sig {
+              params(
+                session_id: String,
+                after: String,
+                limit: Integer,
+                order: OpenAI::Beta::Agents::Sessions::TraceListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              )
+                .returns(OpenAI::Internal::CursorPage[OpenAI::Beta::Agents::Sessions::SessionTrace])
+            }
+            def list(
+              # The ID of the session.
+              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
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/resources/beta/agents/sessions.rbi

@@ -21,6 +21,9 @@ module OpenAI
           sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Events) }
           attr_reader :events
 
+          sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Traces) }
+          attr_reader :traces
+
           sig { returns(OpenAI::Resources::Beta::Agents::Sessions::Turns) }
           attr_reader :turns
 
@@ -88,13 +91,14 @@ module OpenAI
               ),
               agent: OpenAI::Beta::Agents::SessionCreateParams::Agent::OrHash,
               agent_id: String,
+              output_type: T.nilable(T.class_of(OpenAI::Helpers::StructuredOutput::BaseModel)),
               input: T.nilable(OpenAI::Beta::Agents::SessionCreateParams::Input::Variants),
               metadata: T.nilable(T::Hash[Symbol, String]),
               vault_ids: T.nilable(T::Array[String]),
               stream: T.noreturn,
               request_options: OpenAI::RequestOptions::OrHash
             )
-              .returns(OpenAI::Internal::Stream[OpenAI::Beta::AgentSessionEvent::Variants])
+              .returns(OpenAI::Helpers::Beta::Agents::CreationStream)
           }
           def create_streaming(
             # An inline execution environment or a reference to an environment template.
@@ -105,6 +109,7 @@ module OpenAI
             # The ID of a saved reusable agent. Omit `agent` to use its configuration
             # unchanged.
             agent_id: nil,
+            output_type: nil,
             # Initial input to submit when the session is created. A string is shorthand for a
             # single user message. Required when `environment.type` is `none`, or when
             # `stream` is `true` for an environment that is not `self_hosted`; optional for