openai 0.98.0 → 0.99.0

data/lib/openai/models/webhooks/agent_session_created_webhook_event.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class AgentSessionCreatedWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp, in seconds, when the event was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute data
+        #
+        #   @return [OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data }
+
+        # @!attribute object
+        #   The object type. Always `event`.
+        #
+        #   @return [Symbol, :event]
+        required :object, const: :event
+
+        # @!attribute type
+        #   The event type. Always `agent.session.created`.
+        #
+        #   @return [Symbol, :"agent.session.created"]
+        required :type, const: :"agent.session.created"
+
+        # @!method initialize(id:, created_at:, data:, object: :event, type: :"agent.session.created")
+        #   Sent when an agent session is created.
+        #
+        #   @param id [String]
+        #     The unique ID of the event.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp, in seconds, when the event was created.
+        #
+        #   @param data [OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent::Data]
+        #
+        #   @param object [Symbol, :event]
+        #     The object type. Always `event`.
+        #
+        #   @param type [Symbol, :"agent.session.created"]
+        #     The event type. Always `agent.session.created`.
+
+        # @see OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the session.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute environment_type
+          #   The environment type: `none`, `openai_hosted`, or `self_hosted`.
+          #
+          #   @return [String]
+          required :environment_type, String
+
+          # @!attribute connect
+          #
+          #   @return [OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect, nil]
+          optional :connect, -> { OpenAI::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect }
+
+          # @!attribute environment_id
+          #   The ID of the environment, when one exists.
+          #
+          #   @return [String, nil]
+          optional :environment_id, String
+
+          # @!method initialize(id:, environment_type:, connect: nil, environment_id: nil)
+          #   @param id [String]
+          #     The ID of the session.
+          #
+          #   @param environment_type [String]
+          #     The environment type: `none`, `openai_hosted`, or `self_hosted`.
+          #
+          #   @param connect [OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent::Data::Connect]
+          #
+          #   @param environment_id [String]
+          #     The ID of the environment, when one exists.
+
+          # @see OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent::Data#connect
+          class Connect < OpenAI::Internal::Type::BaseModel
+            # @!attribute remote_url
+            #   The URL used to connect the self-hosted environment.
+            #
+            #   @return [String]
+            required :remote_url, String
+
+            # @!method initialize(remote_url:)
+            #   @param remote_url [String]
+            #     The URL used to connect the self-hosted environment.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/agent_session_failed_webhook_event.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class AgentSessionFailedWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp, in seconds, when the event was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute data
+        #
+        #   @return [OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::AgentSessionFailedWebhookEvent::Data }
+
+        # @!attribute object
+        #   The object type. Always `event`.
+        #
+        #   @return [Symbol, :event]
+        required :object, const: :event
+
+        # @!attribute type
+        #   The event type. Always `agent.session.failed`.
+        #
+        #   @return [Symbol, :"agent.session.failed"]
+        required :type, const: :"agent.session.failed"
+
+        # @!method initialize(id:, created_at:, data:, object: :event, type: :"agent.session.failed")
+        #   Sent when an agent session fails.
+        #
+        #   @param id [String]
+        #     The unique ID of the event.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp, in seconds, when the event was created.
+        #
+        #   @param data [OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent::Data]
+        #
+        #   @param object [Symbol, :event]
+        #     The object type. Always `event`.
+        #
+        #   @param type [Symbol, :"agent.session.failed"]
+        #     The event type. Always `agent.session.failed`.
+
+        # @see OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the session.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute environment_type
+          #   The environment type: `none`, `openai_hosted`, or `self_hosted`.
+          #
+          #   @return [String]
+          required :environment_type, String
+
+          # @!attribute environment_id
+          #   The ID of the environment, when one exists.
+          #
+          #   @return [String, nil]
+          optional :environment_id, String
+
+          # @!method initialize(id:, environment_type:, environment_id: nil)
+          #   @param id [String]
+          #     The ID of the session.
+          #
+          #   @param environment_type [String]
+          #     The environment type: `none`, `openai_hosted`, or `self_hosted`.
+          #
+          #   @param environment_id [String]
+          #     The ID of the environment, when one exists.
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/agent_session_idle_webhook_event.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class AgentSessionIdleWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp, in seconds, when the event was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute data
+        #
+        #   @return [OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::AgentSessionIdleWebhookEvent::Data }
+
+        # @!attribute object
+        #   The object type. Always `event`.
+        #
+        #   @return [Symbol, :event]
+        required :object, const: :event
+
+        # @!attribute type
+        #   The event type. Always `agent.session.idle`.
+        #
+        #   @return [Symbol, :"agent.session.idle"]
+        required :type, const: :"agent.session.idle"
+
+        # @!method initialize(id:, created_at:, data:, object: :event, type: :"agent.session.idle")
+        #   Sent when an agent session becomes idle.
+        #
+        #   @param id [String]
+        #     The unique ID of the event.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp, in seconds, when the event was created.
+        #
+        #   @param data [OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent::Data]
+        #
+        #   @param object [Symbol, :event]
+        #     The object type. Always `event`.
+        #
+        #   @param type [Symbol, :"agent.session.idle"]
+        #     The event type. Always `agent.session.idle`.
+
+        # @see OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the session.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute environment_type
+          #   The environment type: `none`, `openai_hosted`, or `self_hosted`.
+          #
+          #   @return [String]
+          required :environment_type, String
+
+          # @!attribute environment_id
+          #   The ID of the environment, when one exists.
+          #
+          #   @return [String, nil]
+          optional :environment_id, String
+
+          # @!method initialize(id:, environment_type:, environment_id: nil)
+          #   @param id [String]
+          #     The ID of the session.
+          #
+          #   @param environment_type [String]
+          #     The environment type: `none`, `openai_hosted`, or `self_hosted`.
+          #
+          #   @param environment_id [String]
+          #     The ID of the environment, when one exists.
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/agent_session_in_progress_webhook_event.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Webhooks
+      class AgentSessionInProgressWebhookEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The Unix timestamp, in seconds, when the event was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute data
+        #
+        #   @return [OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent::Data]
+        required :data, -> { OpenAI::Webhooks::AgentSessionInProgressWebhookEvent::Data }
+
+        # @!attribute object
+        #   The object type. Always `event`.
+        #
+        #   @return [Symbol, :event]
+        required :object, const: :event
+
+        # @!attribute type
+        #   The event type. Always `agent.session.in_progress`.
+        #
+        #   @return [Symbol, :"agent.session.in_progress"]
+        required :type, const: :"agent.session.in_progress"
+
+        # @!method initialize(id:, created_at:, data:, object: :event, type: :"agent.session.in_progress")
+        #   Sent when an agent session enters the in-progress state.
+        #
+        #   @param id [String]
+        #     The unique ID of the event.
+        #
+        #   @param created_at [Integer]
+        #     The Unix timestamp, in seconds, when the event was created.
+        #
+        #   @param data [OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent::Data]
+        #
+        #   @param object [Symbol, :event]
+        #     The object type. Always `event`.
+        #
+        #   @param type [Symbol, :"agent.session.in_progress"]
+        #     The event type. Always `agent.session.in_progress`.
+
+        # @see OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent#data
+        class Data < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the session.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute environment_type
+          #   The environment type: `none`, `openai_hosted`, or `self_hosted`.
+          #
+          #   @return [String]
+          required :environment_type, String
+
+          # @!attribute environment_id
+          #   The ID of the environment, when one exists.
+          #
+          #   @return [String, nil]
+          optional :environment_id, String
+
+          # @!method initialize(id:, environment_type:, environment_id: nil)
+          #   @param id [String]
+          #     The ID of the session.
+          #
+          #   @param environment_type [String]
+          #     The environment type: `none`, `openai_hosted`, or `self_hosted`.
+          #
+          #   @param environment_id [String]
+          #     The ID of the environment, when one exists.
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/webhooks/unwrap_webhook_event.rb

@@ -3,12 +3,28 @@
 module OpenAI
   module Models
     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
 
         discriminator :type
 
+        # Sent when an agent session requires an action. Retrieve the session for action details.
+        variant :"agent.session.action_required", -> { OpenAI::Webhooks::AgentSessionActionRequiredWebhookEvent }
+
+        # Sent when an agent session is created.
+        variant :"agent.session.created", -> { OpenAI::Webhooks::AgentSessionCreatedWebhookEvent }
+
+        # Sent when an agent session fails.
+        variant :"agent.session.failed", -> { OpenAI::Webhooks::AgentSessionFailedWebhookEvent }
+
+        # Sent when an agent session becomes idle.
+        variant :"agent.session.idle", -> { OpenAI::Webhooks::AgentSessionIdleWebhookEvent }
+
+        # Sent when an agent session enters the in-progress state.
+        variant :"agent.session.in_progress", -> { OpenAI::Webhooks::AgentSessionInProgressWebhookEvent }
+
         # Sent when a batch API request has been cancelled.
         variant :"batch.cancelled", -> { OpenAI::Webhooks::BatchCancelledWebhookEvent }
 
@@ -81,7 +97,7 @@ module OpenAI
         variant :"safety.warning_issued", -> { OpenAI::Webhooks::SafetyWarningIssuedWebhookEvent }
 
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyDeactivationIssuedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyWarningIssuedWebhookEvent)]
+        #   @return [Array(OpenAI::Models::Webhooks::AgentSessionActionRequiredWebhookEvent, OpenAI::Models::Webhooks::AgentSessionCreatedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionFailedWebhookEvent, OpenAI::Models::Webhooks::AgentSessionIdleWebhookEvent, OpenAI::Models::Webhooks::AgentSessionInProgressWebhookEvent, OpenAI::Models::Webhooks::BatchCancelledWebhookEvent, OpenAI::Models::Webhooks::BatchCompletedWebhookEvent, OpenAI::Models::Webhooks::BatchExpiredWebhookEvent, OpenAI::Models::Webhooks::BatchFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunCanceledWebhookEvent, OpenAI::Models::Webhooks::EvalRunFailedWebhookEvent, OpenAI::Models::Webhooks::EvalRunSucceededWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobCancelledWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobFailedWebhookEvent, OpenAI::Models::Webhooks::FineTuningJobSucceededWebhookEvent, OpenAI::Models::Webhooks::LiveCallIncomingWebhookEvent, OpenAI::Models::Webhooks::LiveTransportIncomingWebhookEvent, OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent, OpenAI::Models::Webhooks::ResponseCancelledWebhookEvent, OpenAI::Models::Webhooks::ResponseCompletedWebhookEvent, OpenAI::Models::Webhooks::ResponseFailedWebhookEvent, OpenAI::Models::Webhooks::ResponseIncompleteWebhookEvent, OpenAI::Models::Webhooks::SafetyAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyDeactivationIssuedWebhookEvent, OpenAI::Models::Webhooks::SafetyOrgAlertCreatedWebhookEvent, OpenAI::Models::Webhooks::SafetyWarningIssuedWebhookEvent)]
       end
     end
   end

data/lib/openai/models/webhooks/webhook_create_params.rb

@@ -62,6 +62,11 @@ module OpenAI
           REALTIME_CALL_INCOMING = :"realtime.call.incoming"
           VIDEO_COMPLETED = :"video.completed"
           VIDEO_FAILED = :"video.failed"
+          AGENT_SESSION_CREATED = :"agent.session.created"
+          AGENT_SESSION_ACTION_REQUIRED = :"agent.session.action_required"
+          AGENT_SESSION_IN_PROGRESS = :"agent.session.in_progress"
+          AGENT_SESSION_IDLE = :"agent.session.idle"
+          AGENT_SESSION_FAILED = :"agent.session.failed"
           SAFETY_ALERT_CREATED = :"safety.alert.created"
 
           # @!method self.values

data/lib/openai/models/webhooks/webhook_test_params.rb

@@ -48,6 +48,11 @@ module OpenAI
           REALTIME_CALL_INCOMING = :"realtime.call.incoming"
           VIDEO_COMPLETED = :"video.completed"
           VIDEO_FAILED = :"video.failed"
+          AGENT_SESSION_CREATED = :"agent.session.created"
+          AGENT_SESSION_ACTION_REQUIRED = :"agent.session.action_required"
+          AGENT_SESSION_IN_PROGRESS = :"agent.session.in_progress"
+          AGENT_SESSION_IDLE = :"agent.session.idle"
+          AGENT_SESSION_FAILED = :"agent.session.failed"
           SAFETY_ALERT_CREATED = :"safety.alert.created"
 
           # @!method self.values

data/lib/openai/models/webhooks/webhook_update_params.rb

@@ -69,6 +69,11 @@ module OpenAI
           REALTIME_CALL_INCOMING = :"realtime.call.incoming"
           VIDEO_COMPLETED = :"video.completed"
           VIDEO_FAILED = :"video.failed"
+          AGENT_SESSION_CREATED = :"agent.session.created"
+          AGENT_SESSION_ACTION_REQUIRED = :"agent.session.action_required"
+          AGENT_SESSION_IN_PROGRESS = :"agent.session.in_progress"
+          AGENT_SESSION_IDLE = :"agent.session.idle"
+          AGENT_SESSION_FAILED = :"agent.session.failed"
           SAFETY_ALERT_CREATED = :"safety.alert.created"
 
           # @!method self.values

data/lib/openai/resources/audio/speech.rb

@@ -26,6 +26,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.
         #
         # @param instructions [String]
         #   Control the voice of your generated audio with additional instructions. Does not

data/lib/openai/resources/audio/voices.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+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.
+        #
+        # @overload create(body:, request_options: {})
+        #
+        # @param body [OpenAI::Models::Audio::VoiceCreateParams::Body::AudioSample, OpenAI::Models::Audio::VoiceCreateParams::Body::Prompt]
+        #   Creates a voice from a consent recording and an audio sample. Requires
+        #   multipart/form-data.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Audio::Voice]
+        #
+        # @see OpenAI::Models::Audio::VoiceCreateParams
+        def create(params)
+          parsed, options = OpenAI::Audio::VoiceCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "audio/voices",
+            headers: {"content-type" => "multipart/form-data"},
+            body: parsed[:body],
+            model: OpenAI::Audio::Voice,
+            security: {bearer_auth: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [OpenAI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/audio.rb

@@ -15,6 +15,10 @@ module OpenAI
       # @return [OpenAI::Resources::Audio::Speech]
       attr_reader :speech
 
+      # Turn audio into text or text into audio.
+      # @return [OpenAI::Resources::Audio::Voices]
+      attr_reader :voices
+
       # @api private
       #
       # @param client [OpenAI::Client]
@@ -23,6 +27,7 @@ module OpenAI
         @transcriptions = OpenAI::Resources::Audio::Transcriptions.new(client: client)
         @translations = OpenAI::Resources::Audio::Translations.new(client: client)
         @speech = OpenAI::Resources::Audio::Speech.new(client: client)
+        @voices = OpenAI::Resources::Audio::Voices.new(client: client)
       end
     end
   end