openai 0.22.1 → 0.23.0

data/rbi/openai/models/realtime/conversation_item_input_audio_transcription_delta_event.rbi

@@ -16,7 +16,7 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :event_id
 
-        # The ID of the item.
+        # The ID of the item containing the audio that is being transcribed.
         sig { returns(String) }
         attr_accessor :item_id
 
@@ -38,14 +38,19 @@ module OpenAI
         sig { params(delta: String).void }
         attr_writer :delta
 
-        # The log probabilities of the transcription.
+        # The log probabilities of the transcription. These can be enabled by
+        # configurating the session with
+        # `"include": ["item.input_audio_transcription.logprobs"]`. Each entry in the
+        # array corresponds a log probability of which token would be selected for this
+        # chunk of transcription. This can help to identify if it was possible there were
+        # multiple valid options for a given chunk of transcription.
         sig do
           returns(T.nilable(T::Array[OpenAI::Realtime::LogProbProperties]))
         end
         attr_accessor :logprobs
 
         # Returned when the text value of an input audio transcription content part is
-        # updated.
+        # updated with incremental transcription results.
         sig do
           params(
             event_id: String,
@@ -60,13 +65,18 @@ module OpenAI
         def self.new(
           # The unique ID of the server event.
           event_id:,
-          # The ID of the item.
+          # The ID of the item containing the audio that is being transcribed.
           item_id:,
           # The index of the content part in the item's content array.
           content_index: nil,
           # The text delta.
           delta: nil,
-          # The log probabilities of the transcription.
+          # The log probabilities of the transcription. These can be enabled by
+          # configurating the session with
+          # `"include": ["item.input_audio_transcription.logprobs"]`. Each entry in the
+          # array corresponds a log probability of which token would be selected for this
+          # chunk of transcription. This can help to identify if it was possible there were
+          # multiple valid options for a given chunk of transcription.
           logprobs: nil,
           # The event type, must be `conversation.item.input_audio_transcription.delta`.
           type: :"conversation.item.input_audio_transcription.delta"

data/rbi/openai/models/realtime/conversation_item_truncate_event.rbi

@@ -18,7 +18,7 @@ module OpenAI
         sig { returns(Integer) }
         attr_accessor :audio_end_ms
 
-        # The index of the content part to truncate. Set this to 0.
+        # The index of the content part to truncate. Set this to `0`.
         sig { returns(Integer) }
         attr_accessor :content_index
 
@@ -63,7 +63,7 @@ module OpenAI
           # audio_end_ms is greater than the actual audio duration, the server will respond
           # with an error.
           audio_end_ms:,
-          # The index of the content part to truncate. Set this to 0.
+          # The index of the content part to truncate. Set this to `0`.
           content_index:,
           # The ID of the assistant message item to truncate. Only assistant message items
           # can be truncated.

data/rbi/openai/models/realtime/input_audio_buffer_append_event.rbi

@@ -29,14 +29,19 @@ module OpenAI
         attr_writer :event_id
 
         # Send this event to append audio bytes to the input audio buffer. The audio
-        # buffer is temporary storage you can write to and later commit. In Server VAD
-        # mode, the audio buffer is used to detect speech and the server will decide when
-        # to commit. When Server VAD is disabled, you must commit the audio buffer
-        # manually.
+        # buffer is temporary storage you can write to and later commit. A "commit" will
+        # create a new user message item in the conversation history from the buffer
+        # content and clear the buffer. Input audio transcription (if enabled) will be
+        # generated when the buffer is committed.
+        #
+        # If VAD is enabled the audio buffer is used to detect speech and the server will
+        # decide when to commit. When Server VAD is disabled, you must commit the audio
+        # buffer manually. Input audio noise reduction operates on writes to the audio
+        # buffer.
         #
         # The client may choose how much audio to place in each event up to a maximum of
         # 15 MiB, for example streaming smaller chunks from the client may allow the VAD
-        # to be more responsive. Unlike made other client events, the server will not send
+        # to be more responsive. Unlike most other client events, the server will not send
         # a confirmation response to this event.
         sig do
           params(audio: String, event_id: String, type: Symbol).returns(

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

@@ -0,0 +1,97 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class Models < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Realtime::Models, OpenAI::Internal::AnyHash)
+          end
+
+        # The description of the function, including guidance on when and how to call it,
+        # and guidance about what to tell the user when calling (if anything).
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        # The name of the function.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Parameters of the function in JSON Schema.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :parameters
+
+        sig { params(parameters: T.anything).void }
+        attr_writer :parameters
+
+        # The type of the tool, i.e. `function`.
+        sig { returns(T.nilable(OpenAI::Realtime::Models::Type::OrSymbol)) }
+        attr_reader :type
+
+        sig { params(type: OpenAI::Realtime::Models::Type::OrSymbol).void }
+        attr_writer :type
+
+        sig do
+          params(
+            description: String,
+            name: String,
+            parameters: T.anything,
+            type: OpenAI::Realtime::Models::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The description of the function, including guidance on when and how to call it,
+          # and guidance about what to tell the user when calling (if anything).
+          description: nil,
+          # The name of the function.
+          name: nil,
+          # Parameters of the function in JSON Schema.
+          parameters: nil,
+          # The type of the tool, i.e. `function`.
+          type: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              description: String,
+              name: String,
+              parameters: T.anything,
+              type: OpenAI::Realtime::Models::Type::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of the tool, i.e. `function`.
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, OpenAI::Realtime::Models::Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FUNCTION =
+            T.let(:function, OpenAI::Realtime::Models::Type::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Realtime::Models::Type::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/realtime/noise_reduction_type.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      # Type of noise reduction. `near_field` is for close-talking microphones such as
+      # headphones, `far_field` is for far-field microphones such as laptop or
+      # conference room microphones.
+      module NoiseReductionType
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, OpenAI::Realtime::NoiseReductionType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        NEAR_FIELD =
+          T.let(:near_field, OpenAI::Realtime::NoiseReductionType::TaggedSymbol)
+        FAR_FIELD =
+          T.let(:far_field, OpenAI::Realtime::NoiseReductionType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::Realtime::NoiseReductionType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end