openai 0.22.1 → 0.23.0

data/rbi/openai/models/realtime/response_done_event.rbi

@@ -32,6 +32,13 @@ module OpenAI
         # Returned when a Response is done streaming. Always emitted, no matter the final
         # state. The Response object included in the `response.done` event will include
         # all output Items in the Response but will omit the raw audio data.
+        #
+        # Clients should check the `status` field of the Response to determine if it was
+        # successful (`completed`) or if there was another outcome: `cancelled`, `failed`,
+        # or `incomplete`.
+        #
+        # A response will contain all output items that were generated during the
+        # response, excluding any audio content.
         sig do
           params(
             event_id: String,

data/rbi/openai/models/realtime/session_created_event.rbi

@@ -16,12 +16,16 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :event_id
 
-        # Realtime session object.
-        sig { returns(OpenAI::Realtime::RealtimeSession) }
-        attr_reader :session
-
-        sig { params(session: OpenAI::Realtime::RealtimeSession::OrHash).void }
-        attr_writer :session
+        # The session configuration.
+        sig do
+          returns(
+            T.any(
+              OpenAI::Realtime::RealtimeSessionCreateRequest,
+              OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest
+            )
+          )
+        end
+        attr_accessor :session
 
         # The event type, must be `session.created`.
         sig { returns(Symbol) }
@@ -33,14 +37,18 @@ module OpenAI
         sig do
           params(
             event_id: String,
-            session: OpenAI::Realtime::RealtimeSession::OrHash,
+            session:
+              T.any(
+                OpenAI::Realtime::RealtimeSessionCreateRequest::OrHash,
+                OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest::OrHash
+              ),
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
           # The unique ID of the server event.
           event_id:,
-          # Realtime session object.
+          # The session configuration.
           session:,
           # The event type, must be `session.created`.
           type: :"session.created"
@@ -51,13 +59,38 @@ module OpenAI
           override.returns(
             {
               event_id: String,
-              session: OpenAI::Realtime::RealtimeSession,
+              session:
+                T.any(
+                  OpenAI::Realtime::RealtimeSessionCreateRequest,
+                  OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest
+                ),
               type: Symbol
             }
           )
         end
         def to_hash
         end
+
+        # The session configuration.
+        module Session
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Realtime::RealtimeSessionCreateRequest,
+                OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Realtime::SessionCreatedEvent::Session::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
       end
     end
   end

data/rbi/openai/models/realtime/session_update_event.rbi

@@ -12,48 +12,60 @@ module OpenAI
             )
           end
 
-        # Realtime session object configuration.
-        sig { returns(OpenAI::Realtime::RealtimeSessionCreateRequest) }
-        attr_reader :session
-
+        # Update the Realtime session. Choose either a realtime session or a transcription
+        # session.
         sig do
-          params(
-            session: OpenAI::Realtime::RealtimeSessionCreateRequest::OrHash
-          ).void
+          returns(
+            T.any(
+              OpenAI::Realtime::RealtimeSessionCreateRequest,
+              OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest
+            )
+          )
         end
-        attr_writer :session
+        attr_accessor :session
 
         # The event type, must be `session.update`.
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # Optional client-generated ID used to identify this event.
+        # Optional client-generated ID used to identify this event. This is an arbitrary
+        # string that a client may assign. It will be passed back if there is an error
+        # with the event, but the corresponding `session.updated` event will not include
+        # it.
         sig { returns(T.nilable(String)) }
         attr_reader :event_id
 
         sig { params(event_id: String).void }
         attr_writer :event_id
 
-        # Send this event to update the session’s default configuration. The client may
-        # send this event at any time to update any field, except for `voice`. However,
-        # note that once a session has been initialized with a particular `model`, it
-        # can’t be changed to another model using `session.update`.
+        # Send this event to update the session’s configuration. The client may send this
+        # event at any time to update any field except for `voice` and `model`. `voice`
+        # can be updated only if there have been no other audio outputs yet.
         #
         # When the server receives a `session.update`, it will respond with a
         # `session.updated` event showing the full, effective configuration. Only the
-        # fields that are present are updated. To clear a field like `instructions`, pass
-        # an empty string.
+        # fields that are present in the `session.update` are updated. To clear a field
+        # like `instructions`, pass an empty string. To clear a field like `tools`, pass
+        # an empty array. To clear a field like `turn_detection`, pass `null`.
         sig do
           params(
-            session: OpenAI::Realtime::RealtimeSessionCreateRequest::OrHash,
+            session:
+              T.any(
+                OpenAI::Realtime::RealtimeSessionCreateRequest::OrHash,
+                OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest::OrHash
+              ),
             event_id: String,
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
-          # Realtime session object configuration.
+          # Update the Realtime session. Choose either a realtime session or a transcription
+          # session.
           session:,
-          # Optional client-generated ID used to identify this event.
+          # Optional client-generated ID used to identify this event. This is an arbitrary
+          # string that a client may assign. It will be passed back if there is an error
+          # with the event, but the corresponding `session.updated` event will not include
+          # it.
           event_id: nil,
           # The event type, must be `session.update`.
           type: :"session.update"
@@ -63,7 +75,11 @@ module OpenAI
         sig do
           override.returns(
             {
-              session: OpenAI::Realtime::RealtimeSessionCreateRequest,
+              session:
+                T.any(
+                  OpenAI::Realtime::RealtimeSessionCreateRequest,
+                  OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest
+                ),
               type: Symbol,
               event_id: String
             }
@@ -71,6 +87,28 @@ module OpenAI
         end
         def to_hash
         end
+
+        # Update the Realtime session. Choose either a realtime session or a transcription
+        # session.
+        module Session
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Realtime::RealtimeSessionCreateRequest,
+                OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Realtime::SessionUpdateEvent::Session::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
       end
     end
   end

data/rbi/openai/models/realtime/session_updated_event.rbi

@@ -16,12 +16,16 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :event_id
 
-        # Realtime session object.
-        sig { returns(OpenAI::Realtime::RealtimeSession) }
-        attr_reader :session
-
-        sig { params(session: OpenAI::Realtime::RealtimeSession::OrHash).void }
-        attr_writer :session
+        # The session configuration.
+        sig do
+          returns(
+            T.any(
+              OpenAI::Realtime::RealtimeSessionCreateRequest,
+              OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest
+            )
+          )
+        end
+        attr_accessor :session
 
         # The event type, must be `session.updated`.
         sig { returns(Symbol) }
@@ -32,14 +36,18 @@ module OpenAI
         sig do
           params(
             event_id: String,
-            session: OpenAI::Realtime::RealtimeSession::OrHash,
+            session:
+              T.any(
+                OpenAI::Realtime::RealtimeSessionCreateRequest::OrHash,
+                OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest::OrHash
+              ),
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
           # The unique ID of the server event.
           event_id:,
-          # Realtime session object.
+          # The session configuration.
           session:,
           # The event type, must be `session.updated`.
           type: :"session.updated"
@@ -50,13 +58,38 @@ module OpenAI
           override.returns(
             {
               event_id: String,
-              session: OpenAI::Realtime::RealtimeSession,
+              session:
+                T.any(
+                  OpenAI::Realtime::RealtimeSessionCreateRequest,
+                  OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest
+                ),
               type: Symbol
             }
           )
         end
         def to_hash
         end
+
+        # The session configuration.
+        module Session
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Realtime::RealtimeSessionCreateRequest,
+                OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Realtime::SessionUpdatedEvent::Session::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
       end
     end
   end