telnyx 5.167.0 → 5.169.0

data/rbi/telnyx/models/ai/transcription_settings.rbi

@@ -47,14 +47,17 @@ module Telnyx
         # - `deepgram/nova-3` is multilingual with automatic language detection.
         # - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
         # - `azure/fast` is a multilingual Azure transcription model.
-        # - `assemblyai/universal-streaming` is a multilingual streaming model with
-        #   configurable turn detection.
+        # - `assemblyai/universal-3-5-pro` is a multilingual streaming model with
+        #   configurable turn detection. The legacy alias `assemblyai/universal-streaming`
+        #   is still accepted and resolves to the same model.
         # - `xai/grok-stt` is a multilingual Grok STT model.
         # - `soniox/stt-rt-v4` and `soniox/stt-rt-v5` are multilingual streaming models
         #   with automatic language detection, configurable endpointing, term biasing
         #   (`context`), and `language_hints`.
         # - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
         #   language detection.
+        # - `omi-health/omi-med-stt-v1` is an English-only medical transcription model
+        #   (Parakeet-based).
         # - `humain/realtime` is a streaming model with native Arabic and Arabic/English
         #   code-switching support.
         # - `reson8/turns` is a turn-based streaming model covering 10 European languages
@@ -124,14 +127,17 @@ module Telnyx
           # - `deepgram/nova-3` is multilingual with automatic language detection.
           # - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
           # - `azure/fast` is a multilingual Azure transcription model.
-          # - `assemblyai/universal-streaming` is a multilingual streaming model with
-          #   configurable turn detection.
+          # - `assemblyai/universal-3-5-pro` is a multilingual streaming model with
+          #   configurable turn detection. The legacy alias `assemblyai/universal-streaming`
+          #   is still accepted and resolves to the same model.
           # - `xai/grok-stt` is a multilingual Grok STT model.
           # - `soniox/stt-rt-v4` and `soniox/stt-rt-v5` are multilingual streaming models
           #   with automatic language detection, configurable endpointing, term biasing
           #   (`context`), and `language_hints`.
           # - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
           #   language detection.
+          # - `omi-health/omi-med-stt-v1` is an English-only medical transcription model
+          #   (Parakeet-based).
           # - `humain/realtime` is a streaming model with native Arabic and Arabic/English
           #   code-switching support.
           # - `reson8/turns` is a turn-based streaming model covering 10 European languages
@@ -166,14 +172,17 @@ module Telnyx
         # - `deepgram/nova-3` is multilingual with automatic language detection.
         # - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
         # - `azure/fast` is a multilingual Azure transcription model.
-        # - `assemblyai/universal-streaming` is a multilingual streaming model with
-        #   configurable turn detection.
+        # - `assemblyai/universal-3-5-pro` is a multilingual streaming model with
+        #   configurable turn detection. The legacy alias `assemblyai/universal-streaming`
+        #   is still accepted and resolves to the same model.
         # - `xai/grok-stt` is a multilingual Grok STT model.
         # - `soniox/stt-rt-v4` and `soniox/stt-rt-v5` are multilingual streaming models
         #   with automatic language detection, configurable endpointing, term biasing
         #   (`context`), and `language_hints`.
         # - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
         #   language detection.
+        # - `omi-health/omi-med-stt-v1` is an English-only medical transcription model
+        #   (Parakeet-based).
         # - `humain/realtime` is a streaming model with native Arabic and Arabic/English
         #   code-switching support.
         # - `reson8/turns` is a turn-based streaming model covering 10 European languages
@@ -208,6 +217,11 @@ module Telnyx
               :"azure/fast",
               Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
             )
+          ASSEMBLYAI_UNIVERSAL_3_5_PRO =
+            T.let(
+              :"assemblyai/universal-3-5-pro",
+              Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
+            )
           ASSEMBLYAI_UNIVERSAL_STREAMING =
             T.let(
               :"assemblyai/universal-streaming",
@@ -233,6 +247,11 @@ module Telnyx
               :"nvidia/parakeet-v3",
               Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
             )
+          OMI_HEALTH_OMI_MED_STT_V1 =
+            T.let(
+              :"omi-health/omi-med-stt-v1",
+              Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
+            )
           HUMAIN_REALTIME =
             T.let(
               :"humain/realtime",

data/rbi/telnyx/models/ai/transcription_settings_config.rbi

@@ -43,9 +43,9 @@ module Telnyx
         sig { params(enable_endpoint_detection: T::Boolean).void }
         attr_writer :enable_endpoint_detection
 
-        # Available only for assemblyai/universal-streaming. Confidence level required to
-        # trigger an end of turn. Higher values require more certainty before ending a
-        # turn.
+        # Available only for assemblyai/universal-3-5-pro (and its legacy alias
+        # assemblyai/universal-streaming). Confidence level required to trigger an end of
+        # turn. Higher values require more certainty before ending a turn.
         sig { returns(T.nilable(Float)) }
         attr_reader :end_of_turn_confidence_threshold
 
@@ -107,17 +107,18 @@ module Telnyx
         sig { params(max_endpoint_delay_ms: Integer).void }
         attr_writer :max_endpoint_delay_ms
 
-        # Available only for assemblyai/universal-streaming. Maximum duration of silence
-        # in milliseconds before forcing an end of turn.
+        # Available only for assemblyai/universal-3-5-pro (and its legacy alias
+        # assemblyai/universal-streaming). Maximum duration of silence in milliseconds
+        # before forcing an end of turn.
         sig { returns(T.nilable(Integer)) }
         attr_reader :max_turn_silence
 
         sig { params(max_turn_silence: Integer).void }
         attr_writer :max_turn_silence
 
-        # Available only for assemblyai/universal-streaming. Minimum duration of silence
-        # in milliseconds before a turn can end. Must be less than or equal to
-        # max_turn_silence.
+        # Available only for assemblyai/universal-3-5-pro (and its legacy alias
+        # assemblyai/universal-streaming). Minimum duration of silence in milliseconds
+        # before a turn can end. Must be less than or equal to max_turn_silence.
         sig { returns(T.nilable(Integer)) }
         attr_reader :min_turn_silence
 
@@ -171,9 +172,9 @@ module Telnyx
           # emits end-of-utterance events at the cadence configured by
           # `max_endpoint_delay_ms`.
           enable_endpoint_detection: nil,
-          # Available only for assemblyai/universal-streaming. Confidence level required to
-          # trigger an end of turn. Higher values require more certainty before ending a
-          # turn.
+          # Available only for assemblyai/universal-3-5-pro (and its legacy alias
+          # assemblyai/universal-streaming). Confidence level required to trigger an end of
+          # turn. Higher values require more certainty before ending a turn.
           end_of_turn_confidence_threshold: nil,
           # Available only for deepgram/flux. Confidence required to trigger an end of turn.
           # Higher values = more reliable turn detection but slightly increased latency.
@@ -200,12 +201,13 @@ module Telnyx
           # milliseconds) before Soniox emits an end-of-utterance event. Only honored when
           # `enable_endpoint_detection` is true.
           max_endpoint_delay_ms: nil,
-          # Available only for assemblyai/universal-streaming. Maximum duration of silence
-          # in milliseconds before forcing an end of turn.
+          # Available only for assemblyai/universal-3-5-pro (and its legacy alias
+          # assemblyai/universal-streaming). Maximum duration of silence in milliseconds
+          # before forcing an end of turn.
           max_turn_silence: nil,
-          # Available only for assemblyai/universal-streaming. Minimum duration of silence
-          # in milliseconds before a turn can end. Must be less than or equal to
-          # max_turn_silence.
+          # Available only for assemblyai/universal-3-5-pro (and its legacy alias
+          # assemblyai/universal-streaming). Minimum duration of silence in milliseconds
+          # before a turn can end. Must be less than or equal to max_turn_silence.
           min_turn_silence: nil,
           numerals: nil,
           smart_format: nil

data/rbi/telnyx/models/ai/typesafe/v1_systemone_params.rbi

@@ -0,0 +1,504 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Typesafe
+        class V1SystemoneParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::Typesafe::V1SystemoneParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Between 1 and 64 named questions. Each key identifies the corresponding answer.
+          sig do
+            returns(
+              T::Hash[
+                Symbol,
+                T.any(
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice,
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul,
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score
+                )
+              ]
+            )
+          end
+          attr_accessor :questions
+
+          # Shared context evaluated by every question.
+          sig do
+            returns(Telnyx::AI::Typesafe::V1SystemoneParams::State::Variants)
+          end
+          attr_accessor :state
+
+          sig do
+            params(
+              questions:
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice::OrHash,
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::OrHash,
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score::OrHash
+                  )
+                ],
+              state: Telnyx::AI::Typesafe::V1SystemoneParams::State::Variants,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Between 1 and 64 named questions. Each key identifies the corresponding answer.
+            questions:,
+            # Shared context evaluated by every question.
+            state:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                questions:
+                  T::Hash[
+                    Symbol,
+                    T.any(
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice,
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul,
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score
+                    )
+                  ],
+                state: Telnyx::AI::Typesafe::V1SystemoneParams::State::Variants,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # A choice, yes/no, or ordered-score question.
+          module Question
+            extend Telnyx::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice,
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul,
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score
+                )
+              end
+
+            class Choice < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Between 2 and 64 option keys mapped to description strings or null. A null
+              # description uses the option key as its text.
+              sig { returns(T::Hash[Symbol, T.nilable(String)]) }
+              attr_accessor :criteria
+
+              # Required instructions describing what to decide about the shared state.
+              sig do
+                returns(
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice::Instructions::Variants
+                )
+              end
+              attr_accessor :instructions
+
+              # Question type.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Select one of the supplied options.
+              sig do
+                params(
+                  criteria: T::Hash[Symbol, T.nilable(String)],
+                  instructions:
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice::Instructions::Variants,
+                  type: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Between 2 and 64 option keys mapped to description strings or null. A null
+                # description uses the option key as its text.
+                criteria:,
+                # Required instructions describing what to decide about the shared state.
+                instructions:,
+                # Question type.
+                type: :choice
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    criteria: T::Hash[Symbol, T.nilable(String)],
+                    instructions:
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice::Instructions::Variants,
+                    type: Symbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # Required instructions describing what to decide about the shared state.
+              module Instructions
+                extend Telnyx::Internal::Type::Union
+
+                Variants =
+                  T.type_alias do
+                    T.any(
+                      String,
+                      T::Hash[Symbol, T.anything],
+                      T::Array[T.anything]
+                    )
+                  end
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice::Instructions::Variants
+                    ]
+                  )
+                end
+                def self.variants
+                end
+
+                UnionMember1Map =
+                  T.let(
+                    Telnyx::Internal::Type::HashOf[
+                      Telnyx::Internal::Type::Unknown
+                    ],
+                    Telnyx::Internal::Type::Converter
+                  )
+
+                UnionMember2Array =
+                  T.let(
+                    Telnyx::Internal::Type::ArrayOf[
+                      Telnyx::Internal::Type::Unknown
+                    ],
+                    Telnyx::Internal::Type::Converter
+                  )
+              end
+            end
+
+            class Noul < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Required instructions describing what to decide about the shared state.
+              sig do
+                returns(
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Instructions::Variants
+                )
+              end
+              attr_accessor :instructions
+
+              # Question type.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Optional descriptions for the positive and negative outcomes. Descriptions must
+              # be strings.
+              sig do
+                returns(
+                  T.nilable(
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria
+                  )
+                )
+              end
+              attr_reader :criteria
+
+              sig do
+                params(
+                  criteria:
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria::OrHash
+                ).void
+              end
+              attr_writer :criteria
+
+              # Evaluate a yes/no question. Omit criteria to use Yes and No descriptions.
+              sig do
+                params(
+                  instructions:
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Instructions::Variants,
+                  criteria:
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria::OrHash,
+                  type: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Required instructions describing what to decide about the shared state.
+                instructions:,
+                # Optional descriptions for the positive and negative outcomes. Descriptions must
+                # be strings.
+                criteria: nil,
+                # Question type.
+                type: :noul
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    instructions:
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Instructions::Variants,
+                    type: Symbol,
+                    criteria:
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # Required instructions describing what to decide about the shared state.
+              module Instructions
+                extend Telnyx::Internal::Type::Union
+
+                Variants =
+                  T.type_alias do
+                    T.any(
+                      String,
+                      T::Hash[Symbol, T.anything],
+                      T::Array[T.anything]
+                    )
+                  end
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Instructions::Variants
+                    ]
+                  )
+                end
+                def self.variants
+                end
+
+                UnionMember1Map =
+                  T.let(
+                    Telnyx::Internal::Type::HashOf[
+                      Telnyx::Internal::Type::Unknown
+                    ],
+                    Telnyx::Internal::Type::Converter
+                  )
+
+                UnionMember2Array =
+                  T.let(
+                    Telnyx::Internal::Type::ArrayOf[
+                      Telnyx::Internal::Type::Unknown
+                    ],
+                    Telnyx::Internal::Type::Converter
+                  )
+              end
+
+              class Criteria < Telnyx::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria,
+                      Telnyx::Internal::AnyHash
+                    )
+                  end
+
+                # Description of the negative outcome.
+                sig { returns(T.nilable(String)) }
+                attr_reader :false_
+
+                sig { params(false_: String).void }
+                attr_writer :false_
+
+                # Description of the positive outcome.
+                sig { returns(T.nilable(String)) }
+                attr_reader :true_
+
+                sig { params(true_: String).void }
+                attr_writer :true_
+
+                # Optional descriptions for the positive and negative outcomes. Descriptions must
+                # be strings.
+                sig do
+                  params(false_: String, true_: String).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  # Description of the negative outcome.
+                  false_: nil,
+                  # Description of the positive outcome.
+                  true_: nil
+                )
+                end
+
+                sig { override.returns({ false_: String, true_: String }) }
+                def to_hash
+                end
+              end
+            end
+
+            class Score < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Between 2 and 64 description strings in ascending score order. Indices start at
+              # zero.
+              sig { returns(T::Array[String]) }
+              attr_accessor :criteria
+
+              # Required instructions describing what to decide about the shared state.
+              sig do
+                returns(
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score::Instructions::Variants
+                )
+              end
+              attr_accessor :instructions
+
+              # Question type.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Rate the state against an ordered rubric.
+              sig do
+                params(
+                  criteria: T::Array[String],
+                  instructions:
+                    Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score::Instructions::Variants,
+                  type: Symbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Between 2 and 64 description strings in ascending score order. Indices start at
+                # zero.
+                criteria:,
+                # Required instructions describing what to decide about the shared state.
+                instructions:,
+                # Question type.
+                type: :score
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    criteria: T::Array[String],
+                    instructions:
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score::Instructions::Variants,
+                    type: Symbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # Required instructions describing what to decide about the shared state.
+              module Instructions
+                extend Telnyx::Internal::Type::Union
+
+                Variants =
+                  T.type_alias do
+                    T.any(
+                      String,
+                      T::Hash[Symbol, T.anything],
+                      T::Array[T.anything]
+                    )
+                  end
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score::Instructions::Variants
+                    ]
+                  )
+                end
+                def self.variants
+                end
+
+                UnionMember1Map =
+                  T.let(
+                    Telnyx::Internal::Type::HashOf[
+                      Telnyx::Internal::Type::Unknown
+                    ],
+                    Telnyx::Internal::Type::Converter
+                  )
+
+                UnionMember2Array =
+                  T.let(
+                    Telnyx::Internal::Type::ArrayOf[
+                      Telnyx::Internal::Type::Unknown
+                    ],
+                    Telnyx::Internal::Type::Converter
+                  )
+              end
+            end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::Typesafe::V1SystemoneParams::Question::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
+          # Shared context evaluated by every question.
+          module State
+            extend Telnyx::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(String, T::Hash[Symbol, T.anything], T::Array[T.anything])
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::Typesafe::V1SystemoneParams::State::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+
+            UnionMember1Map =
+              T.let(
+                Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
+                Telnyx::Internal::Type::Converter
+              )
+
+            UnionMember2Array =
+              T.let(
+                Telnyx::Internal::Type::ArrayOf[
+                  Telnyx::Internal::Type::Unknown
+                ],
+                Telnyx::Internal::Type::Converter
+              )
+          end
+        end
+      end
+    end
+  end
+end