openai 0.22.1 → 0.23.0

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

@@ -12,127 +12,11 @@ module OpenAI
         Variants =
           T.type_alias do
             T.any(
-              OpenAI::Realtime::RealtimeToolsConfigUnion::Function,
+              OpenAI::Realtime::Models,
               OpenAI::Realtime::RealtimeToolsConfigUnion::Mcp
             )
           end
 
-        class Function < OpenAI::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Realtime::RealtimeToolsConfigUnion::Function,
-                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 do
-            returns(
-              T.nilable(
-                OpenAI::Realtime::RealtimeToolsConfigUnion::Function::Type::OrSymbol
-              )
-            )
-          end
-          attr_reader :type
-
-          sig do
-            params(
-              type:
-                OpenAI::Realtime::RealtimeToolsConfigUnion::Function::Type::OrSymbol
-            ).void
-          end
-          attr_writer :type
-
-          sig do
-            params(
-              description: String,
-              name: String,
-              parameters: T.anything,
-              type:
-                OpenAI::Realtime::RealtimeToolsConfigUnion::Function::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::RealtimeToolsConfigUnion::Function::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 do
-                T.all(
-                  Symbol,
-                  OpenAI::Realtime::RealtimeToolsConfigUnion::Function::Type
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            FUNCTION =
-              T.let(
-                :function,
-                OpenAI::Realtime::RealtimeToolsConfigUnion::Function::Type::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  OpenAI::Realtime::RealtimeToolsConfigUnion::Function::Type::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-
         class Mcp < OpenAI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

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

@@ -3,8 +3,9 @@
 module OpenAI
   module Models
     module Realtime
-      # Configuration options for tracing. Set to null to disable tracing. Once tracing
-      # is enabled for a session, the configuration cannot be modified.
+      # Realtime API can write session traces to the
+      # [Traces Dashboard](/logs?api=traces). Set to null to disable tracing. Once
+      # tracing is enabled for a session, the configuration cannot be modified.
       #
       # `auto` will create a trace for the session with default values for the workflow
       # name, group id, and metadata.
@@ -29,15 +30,15 @@ module OpenAI
             end
 
           # The group id to attach to this trace to enable filtering and grouping in the
-          # traces dashboard.
+          # Traces Dashboard.
           sig { returns(T.nilable(String)) }
           attr_reader :group_id
 
           sig { params(group_id: String).void }
           attr_writer :group_id
 
-          # The arbitrary metadata to attach to this trace to enable filtering in the traces
-          # dashboard.
+          # The arbitrary metadata to attach to this trace to enable filtering in the Traces
+          # Dashboard.
           sig { returns(T.nilable(T.anything)) }
           attr_reader :metadata
 
@@ -45,7 +46,7 @@ module OpenAI
           attr_writer :metadata
 
           # The name of the workflow to attach to this trace. This is used to name the trace
-          # in the traces dashboard.
+          # in the Traces Dashboard.
           sig { returns(T.nilable(String)) }
           attr_reader :workflow_name
 
@@ -62,13 +63,13 @@ module OpenAI
           end
           def self.new(
             # The group id to attach to this trace to enable filtering and grouping in the
-            # traces dashboard.
+            # Traces Dashboard.
             group_id: nil,
-            # The arbitrary metadata to attach to this trace to enable filtering in the traces
-            # dashboard.
+            # The arbitrary metadata to attach to this trace to enable filtering in the Traces
+            # Dashboard.
             metadata: nil,
             # The name of the workflow to attach to this trace. This is used to name the trace
-            # in the traces dashboard.
+            # in the Traces Dashboard.
             workflow_name: nil
           )
           end

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

@@ -0,0 +1,50 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeTranscriptionSessionAudio < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeTranscriptionSessionAudio,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(OpenAI::Realtime::RealtimeTranscriptionSessionAudioInput)
+          )
+        end
+        attr_reader :input
+
+        sig do
+          params(
+            input:
+              OpenAI::Realtime::RealtimeTranscriptionSessionAudioInput::OrHash
+          ).void
+        end
+        attr_writer :input
+
+        # Configuration for input and output audio.
+        sig do
+          params(
+            input:
+              OpenAI::Realtime::RealtimeTranscriptionSessionAudioInput::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(input: nil)
+        end
+
+        sig do
+          override.returns(
+            { input: OpenAI::Realtime::RealtimeTranscriptionSessionAudioInput }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,226 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeTranscriptionSessionAudioInput < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Realtime::RealtimeTranscriptionSessionAudioInput,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The PCM audio format. Only a 24kHz sample rate is supported.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                OpenAI::Realtime::RealtimeAudioFormats::AudioPCM,
+                OpenAI::Realtime::RealtimeAudioFormats::AudioPCMU,
+                OpenAI::Realtime::RealtimeAudioFormats::AudioPCMA
+              )
+            )
+          )
+        end
+        attr_reader :format_
+
+        sig do
+          params(
+            format_:
+              T.any(
+                OpenAI::Realtime::RealtimeAudioFormats::AudioPCM::OrHash,
+                OpenAI::Realtime::RealtimeAudioFormats::AudioPCMU::OrHash,
+                OpenAI::Realtime::RealtimeAudioFormats::AudioPCMA::OrHash
+              )
+          ).void
+        end
+        attr_writer :format_
+
+        # Configuration for input audio noise reduction. This can be set to `null` to turn
+        # off. Noise reduction filters audio added to the input audio buffer before it is
+        # sent to VAD and the model. Filtering the audio can improve VAD and turn
+        # detection accuracy (reducing false positives) and model performance by improving
+        # perception of the input audio.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Realtime::RealtimeTranscriptionSessionAudioInput::NoiseReduction
+            )
+          )
+        end
+        attr_reader :noise_reduction
+
+        sig do
+          params(
+            noise_reduction:
+              OpenAI::Realtime::RealtimeTranscriptionSessionAudioInput::NoiseReduction::OrHash
+          ).void
+        end
+        attr_writer :noise_reduction
+
+        # Configuration for input audio transcription, defaults to off and can be set to
+        # `null` to turn off once on. Input audio transcription is not native to the
+        # model, since the model consumes audio directly. Transcription runs
+        # asynchronously through
+        # [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription)
+        # and should be treated as guidance of input audio content rather than precisely
+        # what the model heard. The client can optionally set the language and prompt for
+        # transcription, these offer additional guidance to the transcription service.
+        sig { returns(T.nilable(OpenAI::Realtime::AudioTranscription)) }
+        attr_reader :transcription
+
+        sig do
+          params(
+            transcription: OpenAI::Realtime::AudioTranscription::OrHash
+          ).void
+        end
+        attr_writer :transcription
+
+        # Configuration for turn detection, ether Server VAD or Semantic VAD. This can be
+        # set to `null` to turn off, in which case the client must manually trigger model
+        # response. Server VAD means that the model will detect the start and end of
+        # speech based on audio volume and respond at the end of user speech. Semantic VAD
+        # is more advanced and uses a turn detection model (in conjunction with VAD) to
+        # semantically estimate whether the user has finished speaking, then dynamically
+        # sets a timeout based on this probability. For example, if user audio trails off
+        # with "uhhm", the model will score a low probability of turn end and wait longer
+        # for the user to continue speaking. This can be useful for more natural
+        # conversations, but may have a higher latency.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Realtime::RealtimeTranscriptionSessionAudioInputTurnDetection
+            )
+          )
+        end
+        attr_reader :turn_detection
+
+        sig do
+          params(
+            turn_detection:
+              OpenAI::Realtime::RealtimeTranscriptionSessionAudioInputTurnDetection::OrHash
+          ).void
+        end
+        attr_writer :turn_detection
+
+        sig do
+          params(
+            format_:
+              T.any(
+                OpenAI::Realtime::RealtimeAudioFormats::AudioPCM::OrHash,
+                OpenAI::Realtime::RealtimeAudioFormats::AudioPCMU::OrHash,
+                OpenAI::Realtime::RealtimeAudioFormats::AudioPCMA::OrHash
+              ),
+            noise_reduction:
+              OpenAI::Realtime::RealtimeTranscriptionSessionAudioInput::NoiseReduction::OrHash,
+            transcription: OpenAI::Realtime::AudioTranscription::OrHash,
+            turn_detection:
+              OpenAI::Realtime::RealtimeTranscriptionSessionAudioInputTurnDetection::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The PCM audio format. Only a 24kHz sample rate is supported.
+          format_: nil,
+          # Configuration for input audio noise reduction. This can be set to `null` to turn
+          # off. Noise reduction filters audio added to the input audio buffer before it is
+          # sent to VAD and the model. Filtering the audio can improve VAD and turn
+          # detection accuracy (reducing false positives) and model performance by improving
+          # perception of the input audio.
+          noise_reduction: nil,
+          # Configuration for input audio transcription, defaults to off and can be set to
+          # `null` to turn off once on. Input audio transcription is not native to the
+          # model, since the model consumes audio directly. Transcription runs
+          # asynchronously through
+          # [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription)
+          # and should be treated as guidance of input audio content rather than precisely
+          # what the model heard. The client can optionally set the language and prompt for
+          # transcription, these offer additional guidance to the transcription service.
+          transcription: nil,
+          # Configuration for turn detection, ether Server VAD or Semantic VAD. This can be
+          # set to `null` to turn off, in which case the client must manually trigger model
+          # response. Server VAD means that the model will detect the start and end of
+          # speech based on audio volume and respond at the end of user speech. Semantic VAD
+          # is more advanced and uses a turn detection model (in conjunction with VAD) to
+          # semantically estimate whether the user has finished speaking, then dynamically
+          # sets a timeout based on this probability. For example, if user audio trails off
+          # with "uhhm", the model will score a low probability of turn end and wait longer
+          # for the user to continue speaking. This can be useful for more natural
+          # conversations, but may have a higher latency.
+          turn_detection: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              format_:
+                T.any(
+                  OpenAI::Realtime::RealtimeAudioFormats::AudioPCM,
+                  OpenAI::Realtime::RealtimeAudioFormats::AudioPCMU,
+                  OpenAI::Realtime::RealtimeAudioFormats::AudioPCMA
+                ),
+              noise_reduction:
+                OpenAI::Realtime::RealtimeTranscriptionSessionAudioInput::NoiseReduction,
+              transcription: OpenAI::Realtime::AudioTranscription,
+              turn_detection:
+                OpenAI::Realtime::RealtimeTranscriptionSessionAudioInputTurnDetection
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class NoiseReduction < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Realtime::RealtimeTranscriptionSessionAudioInput::NoiseReduction,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # 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.
+          sig do
+            returns(T.nilable(OpenAI::Realtime::NoiseReductionType::OrSymbol))
+          end
+          attr_reader :type
+
+          sig do
+            params(type: OpenAI::Realtime::NoiseReductionType::OrSymbol).void
+          end
+          attr_writer :type
+
+          # Configuration for input audio noise reduction. This can be set to `null` to turn
+          # off. Noise reduction filters audio added to the input audio buffer before it is
+          # sent to VAD and the model. Filtering the audio can improve VAD and turn
+          # detection accuracy (reducing false positives) and model performance by improving
+          # perception of the input audio.
+          sig do
+            params(
+              type: OpenAI::Realtime::NoiseReductionType::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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.
+            type: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { type: OpenAI::Realtime::NoiseReductionType::OrSymbol }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end