telnyx 5.114.0 → 5.115.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/openai_create_response_params.rb +3 -3
- data/lib/telnyx/models/ai/transcription_settings.rb +8 -1
- data/lib/telnyx/models/ai/transcription_settings_config.rb +29 -1
- data/lib/telnyx/models/ai_create_response_params.rb +4 -4
- data/lib/telnyx/models/calls/transcription_config.rb +8 -1
- data/lib/telnyx/models/calls/transcription_start_request.rb +175 -4
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +0 -2
- data/lib/telnyx/resources/ai/openai.rb +1 -1
- data/lib/telnyx/resources/ai.rb +3 -3
- data/lib/telnyx/resources/calls/actions.rb +1 -1
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +0 -1
- data/rbi/telnyx/models/ai/openai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/ai/transcription_settings.rbi +17 -2
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +41 -0
- data/rbi/telnyx/models/ai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/calls/transcription_config.rbi +17 -2
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +438 -5
- data/rbi/telnyx/resources/ai/openai.rbi +1 -1
- data/rbi/telnyx/resources/ai.rbi +2 -2
- data/rbi/telnyx/resources/calls/actions.rbi +2 -1
- data/sig/telnyx/models/ai/openai_create_response_params.rbs +5 -5
- data/sig/telnyx/models/ai/transcription_settings.rbs +2 -0
- data/sig/telnyx/models/ai/transcription_settings_config.rbs +21 -0
- data/sig/telnyx/models/ai_create_response_params.rbs +4 -5
- data/sig/telnyx/models/calls/transcription_config.rbs +2 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +177 -1
- data/sig/telnyx/resources/ai/openai.rbs +1 -1
- data/sig/telnyx/resources/ai.rbs +1 -1
- metadata +1 -4
- data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +0 -100
- data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +0 -289
- data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +0 -114
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 95b30d805eaf55227aebaf741e61f3b03ce22221b73dde4d4e959bf2cfe82fa9
|
|
4
|
+
data.tar.gz: 90ce1a58fad7b1c3da968b81c70af00449ef6aa0cf63de14d208edf856ac3280
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8aed85872d4f0d48307019e45c0331ed390afab5fe0092c3cc3b1c1984540a47d6bdb35f3e67581995a83599ead8af3caab3fe38fafff93b96a2d95536aec8c7
|
|
7
|
+
data.tar.gz: 066c15df76c3224cc256fece9151a47ad9db681a4cec7b1bc7b5b8074663a2932d288f8929134c87540272861ba4a5d0b6429c0e3eb05df2504c9b7ba841d875
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.115.0 (2026-05-18)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.114.0...v5.115.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.114.0...v5.115.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* Telapps 101 soniox spec ([5b09c00](https://github.com/team-telnyx/telnyx-ruby/commit/5b09c000fbe70851549f0a7ed4783da22f91632f))
|
|
10
|
+
|
|
3
11
|
## 5.114.0 (2026-05-18)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v5.113.0...v5.114.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.113.0...v5.114.0)
|
data/README.md
CHANGED
|
@@ -20,8 +20,8 @@ module Telnyx
|
|
|
20
20
|
# @!attribute input
|
|
21
21
|
# The input items for this turn, using the OpenAI Responses API input format.
|
|
22
22
|
#
|
|
23
|
-
# @return [
|
|
24
|
-
optional :input, Telnyx::Internal::Type::
|
|
23
|
+
# @return [Object, nil]
|
|
24
|
+
optional :input, Telnyx::Internal::Type::Unknown
|
|
25
25
|
|
|
26
26
|
# @!attribute instructions
|
|
27
27
|
# Optional system/developer instructions for the model. When used with a persisted
|
|
@@ -51,7 +51,7 @@ module Telnyx
|
|
|
51
51
|
#
|
|
52
52
|
# @param conversation [String] Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided, Te
|
|
53
53
|
#
|
|
54
|
-
# @param input [
|
|
54
|
+
# @param input [Object] The input items for this turn, using the OpenAI Responses API input format.
|
|
55
55
|
#
|
|
56
56
|
# @param instructions [String] Optional system/developer instructions for the model. When used with a persisted
|
|
57
57
|
#
|
|
@@ -16,7 +16,9 @@ module Telnyx
|
|
|
16
16
|
# supported models will automatically detect the language. For `deepgram/flux`,
|
|
17
17
|
# supported values are: `auto` (Telnyx language detection controls the language
|
|
18
18
|
# hint), `multi` (no language hint), and language-specific hints `en`, `es`, `fr`,
|
|
19
|
-
# `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`.
|
|
19
|
+
# `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For `soniox/stt-rt-v4`, `auto`
|
|
20
|
+
# omits the language hint and lets Soniox auto-detect; ISO 639-1 codes (e.g. `en`,
|
|
21
|
+
# `es`) bias detection toward that language.
|
|
20
22
|
#
|
|
21
23
|
# @return [String, nil]
|
|
22
24
|
optional :language, String
|
|
@@ -32,6 +34,8 @@ module Telnyx
|
|
|
32
34
|
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
33
35
|
# configurable turn detection.
|
|
34
36
|
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
37
|
+
# - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
|
|
38
|
+
# detection and configurable endpointing.
|
|
35
39
|
#
|
|
36
40
|
# @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model, nil]
|
|
37
41
|
optional :model, enum: -> { Telnyx::AI::TranscriptionSettings::Model }
|
|
@@ -72,6 +76,8 @@ module Telnyx
|
|
|
72
76
|
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
73
77
|
# configurable turn detection.
|
|
74
78
|
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
79
|
+
# - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
|
|
80
|
+
# detection and configurable endpointing.
|
|
75
81
|
#
|
|
76
82
|
# @see Telnyx::Models::AI::TranscriptionSettings#model
|
|
77
83
|
module Model
|
|
@@ -83,6 +89,7 @@ module Telnyx
|
|
|
83
89
|
AZURE_FAST = :"azure/fast"
|
|
84
90
|
ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
|
|
85
91
|
XAI_GROK_STT = :"xai/grok-stt"
|
|
92
|
+
SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
|
|
86
93
|
DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
|
|
87
94
|
OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
|
|
88
95
|
|
|
@@ -12,6 +12,13 @@ module Telnyx
|
|
|
12
12
|
# @return [Float, nil]
|
|
13
13
|
optional :eager_eot_threshold, Float
|
|
14
14
|
|
|
15
|
+
# @!attribute enable_endpoint_detection
|
|
16
|
+
# Available only for soniox/stt-rt-v4. When true, Soniox emits end-of-utterance
|
|
17
|
+
# events at the cadence configured by `max_endpoint_delay_ms`.
|
|
18
|
+
#
|
|
19
|
+
# @return [Boolean, nil]
|
|
20
|
+
optional :enable_endpoint_detection, Telnyx::Internal::Type::Boolean
|
|
21
|
+
|
|
15
22
|
# @!attribute end_of_turn_confidence_threshold
|
|
16
23
|
# Available only for assemblyai/universal-streaming. Confidence level required to
|
|
17
24
|
# trigger an end of turn. Higher values require more certainty before ending a
|
|
@@ -34,6 +41,13 @@ module Telnyx
|
|
|
34
41
|
# @return [Integer, nil]
|
|
35
42
|
optional :eot_timeout_ms, Integer
|
|
36
43
|
|
|
44
|
+
# @!attribute interim_results
|
|
45
|
+
# Available only for soniox/stt-rt-v4. When true, Soniox streams interim
|
|
46
|
+
# (non-final) results in addition to finalized transcripts.
|
|
47
|
+
#
|
|
48
|
+
# @return [Boolean, nil]
|
|
49
|
+
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
50
|
+
|
|
37
51
|
# @!attribute keyterm
|
|
38
52
|
# Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of
|
|
39
53
|
# key terms to boost for recognition during transcription. Helps improve accuracy
|
|
@@ -46,6 +60,14 @@ module Telnyx
|
|
|
46
60
|
# @return [String, nil]
|
|
47
61
|
optional :keyterm, String
|
|
48
62
|
|
|
63
|
+
# @!attribute max_endpoint_delay_ms
|
|
64
|
+
# Available only for soniox/stt-rt-v4. Maximum silence (in milliseconds) before
|
|
65
|
+
# Soniox emits an end-of-utterance event. Only honored when
|
|
66
|
+
# `enable_endpoint_detection` is true.
|
|
67
|
+
#
|
|
68
|
+
# @return [Integer, nil]
|
|
69
|
+
optional :max_endpoint_delay_ms, Integer
|
|
70
|
+
|
|
49
71
|
# @!attribute max_turn_silence
|
|
50
72
|
# Available only for assemblyai/universal-streaming. Maximum duration of silence
|
|
51
73
|
# in milliseconds before forcing an end of turn.
|
|
@@ -71,20 +93,26 @@ module Telnyx
|
|
|
71
93
|
# @return [Boolean, nil]
|
|
72
94
|
optional :smart_format, Telnyx::Internal::Type::Boolean
|
|
73
95
|
|
|
74
|
-
# @!method initialize(eager_eot_threshold: nil, end_of_turn_confidence_threshold: nil, eot_threshold: nil, eot_timeout_ms: nil, keyterm: nil, max_turn_silence: nil, min_turn_silence: nil, numerals: nil, smart_format: nil)
|
|
96
|
+
# @!method initialize(eager_eot_threshold: nil, enable_endpoint_detection: nil, end_of_turn_confidence_threshold: nil, eot_threshold: nil, eot_timeout_ms: nil, interim_results: nil, keyterm: nil, max_endpoint_delay_ms: nil, max_turn_silence: nil, min_turn_silence: nil, numerals: nil, smart_format: nil)
|
|
75
97
|
# Some parameter documentations has been truncated, see
|
|
76
98
|
# {Telnyx::Models::AI::TranscriptionSettingsConfig} for more details.
|
|
77
99
|
#
|
|
78
100
|
# @param eager_eot_threshold [Float] Available only for deepgram/flux. Confidence threshold for eager end of turn det
|
|
79
101
|
#
|
|
102
|
+
# @param enable_endpoint_detection [Boolean] Available only for soniox/stt-rt-v4. When true, Soniox emits end-of-utterance ev
|
|
103
|
+
#
|
|
80
104
|
# @param end_of_turn_confidence_threshold [Float] Available only for assemblyai/universal-streaming. Confidence level required to
|
|
81
105
|
#
|
|
82
106
|
# @param eot_threshold [Float] Available only for deepgram/flux. Confidence required to trigger an end of turn.
|
|
83
107
|
#
|
|
84
108
|
# @param eot_timeout_ms [Integer] Available only for deepgram/flux. Maximum milliseconds of silence before forcing
|
|
85
109
|
#
|
|
110
|
+
# @param interim_results [Boolean] Available only for soniox/stt-rt-v4. When true, Soniox streams interim (non-fina
|
|
111
|
+
#
|
|
86
112
|
# @param keyterm [String] Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of
|
|
87
113
|
#
|
|
114
|
+
# @param max_endpoint_delay_ms [Integer] Available only for soniox/stt-rt-v4. Maximum silence (in milliseconds) before So
|
|
115
|
+
#
|
|
88
116
|
# @param max_turn_silence [Integer] Available only for assemblyai/universal-streaming. Maximum duration of silence i
|
|
89
117
|
#
|
|
90
118
|
# @param min_turn_silence [Integer] Available only for assemblyai/universal-streaming. Minimum duration of silence i
|
|
@@ -7,13 +7,13 @@ module Telnyx
|
|
|
7
7
|
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Telnyx::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute
|
|
10
|
+
# @!attribute body
|
|
11
11
|
#
|
|
12
12
|
# @return [Hash{Symbol=>Object}]
|
|
13
|
-
required :
|
|
13
|
+
required :body, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
14
14
|
|
|
15
|
-
# @!method initialize(
|
|
16
|
-
# @param
|
|
15
|
+
# @!method initialize(body:, request_options: {})
|
|
16
|
+
# @param body [Hash{Symbol=>Object}]
|
|
17
17
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
18
18
|
end
|
|
19
19
|
end
|
|
@@ -10,7 +10,9 @@ module Telnyx
|
|
|
10
10
|
# meaningful values depend on the selected transcription `model`. For
|
|
11
11
|
# `deepgram/flux`, supported values are: `auto` (Telnyx language detection
|
|
12
12
|
# controls the language hint), `multi` (no language hint), and language-specific
|
|
13
|
-
# hints `en`, `es`, `fr`, `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`.
|
|
13
|
+
# hints `en`, `es`, `fr`, `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For
|
|
14
|
+
# `soniox/stt-rt-v4`, `auto` omits the language hint and lets Soniox auto-detect;
|
|
15
|
+
# ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language.
|
|
14
16
|
#
|
|
15
17
|
# @return [String, nil]
|
|
16
18
|
optional :language, String
|
|
@@ -25,6 +27,8 @@ module Telnyx
|
|
|
25
27
|
# transcription.
|
|
26
28
|
# - `assemblyai/universal-streaming` for live streaming transcription.
|
|
27
29
|
# - `xai/grok-stt` for live streaming transcription.
|
|
30
|
+
# - `soniox/stt-rt-v4` for live streaming multilingual transcription with
|
|
31
|
+
# automatic language detection.
|
|
28
32
|
# - `azure/fast` and `azure/realtime`; Azure models require `region`, and
|
|
29
33
|
# unsupported regions require `api_key_ref`.
|
|
30
34
|
# - `google/latest_long` for non-streaming multilingual transcription.
|
|
@@ -58,6 +62,8 @@ module Telnyx
|
|
|
58
62
|
# transcription.
|
|
59
63
|
# - `assemblyai/universal-streaming` for live streaming transcription.
|
|
60
64
|
# - `xai/grok-stt` for live streaming transcription.
|
|
65
|
+
# - `soniox/stt-rt-v4` for live streaming multilingual transcription with
|
|
66
|
+
# automatic language detection.
|
|
61
67
|
# - `azure/fast` and `azure/realtime`; Azure models require `region`, and
|
|
62
68
|
# unsupported regions require `api_key_ref`.
|
|
63
69
|
# - `google/latest_long` for non-streaming multilingual transcription.
|
|
@@ -78,6 +84,7 @@ module Telnyx
|
|
|
78
84
|
SPEECHMATICS_ENHANCED = :"speechmatics/enhanced"
|
|
79
85
|
ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
|
|
80
86
|
XAI_GROK_STT = :"xai/grok-stt"
|
|
87
|
+
SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
|
|
81
88
|
AZURE_FAST = :"azure/fast"
|
|
82
89
|
AZURE_REALTIME = :"azure/realtime"
|
|
83
90
|
GOOGLE_LATEST_LONG = :"google/latest_long"
|
|
@@ -27,7 +27,7 @@ module Telnyx
|
|
|
27
27
|
|
|
28
28
|
# @!attribute transcription_engine_config
|
|
29
29
|
#
|
|
30
|
-
# @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::
|
|
30
|
+
# @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config, nil]
|
|
31
31
|
optional :transcription_engine_config,
|
|
32
32
|
union: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig }
|
|
33
33
|
|
|
@@ -49,7 +49,7 @@ module Telnyx
|
|
|
49
49
|
#
|
|
50
50
|
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
|
|
51
51
|
#
|
|
52
|
-
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::
|
|
52
|
+
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
53
53
|
#
|
|
54
54
|
# @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
|
|
55
55
|
|
|
@@ -67,6 +67,7 @@ module Telnyx
|
|
|
67
67
|
X_AI = :xAI
|
|
68
68
|
ASSEMBLY_AI = :AssemblyAI
|
|
69
69
|
SPEECHMATICS = :Speechmatics
|
|
70
|
+
SONIOX = :Soniox
|
|
70
71
|
A = :A
|
|
71
72
|
B = :B
|
|
72
73
|
|
|
@@ -90,7 +91,10 @@ module Telnyx
|
|
|
90
91
|
|
|
91
92
|
variant :AssemblyAI, -> { Telnyx::Calls::TranscriptionEngineAssemblyaiConfig }
|
|
92
93
|
|
|
93
|
-
variant :Speechmatics,
|
|
94
|
+
variant :Speechmatics,
|
|
95
|
+
-> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics }
|
|
96
|
+
|
|
97
|
+
variant :Soniox, -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox }
|
|
94
98
|
|
|
95
99
|
variant :A, -> { Telnyx::Calls::TranscriptionEngineAConfig }
|
|
96
100
|
|
|
@@ -100,8 +104,175 @@ module Telnyx
|
|
|
100
104
|
|
|
101
105
|
variant :"deepgram/nova-3", -> { Telnyx::Calls::DeepgramNova3Config }
|
|
102
106
|
|
|
107
|
+
class Speechmatics < Telnyx::Internal::Type::BaseModel
|
|
108
|
+
# @!attribute interim_results
|
|
109
|
+
# Whether to send also interim results. If set to false, only final results will
|
|
110
|
+
# be sent.
|
|
111
|
+
#
|
|
112
|
+
# @return [Boolean, nil]
|
|
113
|
+
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
114
|
+
|
|
115
|
+
# @!attribute language
|
|
116
|
+
# Language to use for speech recognition
|
|
117
|
+
#
|
|
118
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language, nil]
|
|
119
|
+
optional :language,
|
|
120
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language }
|
|
121
|
+
|
|
122
|
+
# @!attribute transcription_engine
|
|
123
|
+
# Engine identifier for Speechmatics transcription service
|
|
124
|
+
#
|
|
125
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine, nil]
|
|
126
|
+
optional :transcription_engine,
|
|
127
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine }
|
|
128
|
+
|
|
129
|
+
# @!attribute transcription_model
|
|
130
|
+
# The model to use for transcription.
|
|
131
|
+
#
|
|
132
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel, nil]
|
|
133
|
+
optional :transcription_model,
|
|
134
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel }
|
|
135
|
+
|
|
136
|
+
# @!method initialize(interim_results: nil, language: nil, transcription_engine: nil, transcription_model: nil)
|
|
137
|
+
# Some parameter documentations has been truncated, see
|
|
138
|
+
# {Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics}
|
|
139
|
+
# for more details.
|
|
140
|
+
#
|
|
141
|
+
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
142
|
+
#
|
|
143
|
+
# @param language [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language] Language to use for speech recognition
|
|
144
|
+
#
|
|
145
|
+
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine] Engine identifier for Speechmatics transcription service
|
|
146
|
+
#
|
|
147
|
+
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel] The model to use for transcription.
|
|
148
|
+
|
|
149
|
+
# Language to use for speech recognition
|
|
150
|
+
#
|
|
151
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics#language
|
|
152
|
+
module Language
|
|
153
|
+
extend Telnyx::Internal::Type::Enum
|
|
154
|
+
|
|
155
|
+
EN = :en
|
|
156
|
+
BA = :ba
|
|
157
|
+
EU = :eu
|
|
158
|
+
GL = :gl
|
|
159
|
+
GA = :ga
|
|
160
|
+
MT = :mt
|
|
161
|
+
MN = :mn
|
|
162
|
+
SW = :sw
|
|
163
|
+
UG = :ug
|
|
164
|
+
CY = :cy
|
|
165
|
+
AR_EN = :ar_en
|
|
166
|
+
CMN_EN = :cmn_en
|
|
167
|
+
EN_MS = :en_ms
|
|
168
|
+
EN_TA = :en_ta
|
|
169
|
+
TL = :tl
|
|
170
|
+
ES_BILINGUAL_EN = :"es-bilingual-en"
|
|
171
|
+
CMN_EN_MS_TA = :cmn_en_ms_ta
|
|
172
|
+
|
|
173
|
+
# @!method self.values
|
|
174
|
+
# @return [Array<Symbol>]
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Engine identifier for Speechmatics transcription service
|
|
178
|
+
#
|
|
179
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics#transcription_engine
|
|
180
|
+
module TranscriptionEngine
|
|
181
|
+
extend Telnyx::Internal::Type::Enum
|
|
182
|
+
|
|
183
|
+
SPEECHMATICS = :Speechmatics
|
|
184
|
+
|
|
185
|
+
# @!method self.values
|
|
186
|
+
# @return [Array<Symbol>]
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
# The model to use for transcription.
|
|
190
|
+
#
|
|
191
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics#transcription_model
|
|
192
|
+
module TranscriptionModel
|
|
193
|
+
extend Telnyx::Internal::Type::Enum
|
|
194
|
+
|
|
195
|
+
SPEECHMATICS_STANDARD = :"speechmatics/standard"
|
|
196
|
+
|
|
197
|
+
# @!method self.values
|
|
198
|
+
# @return [Array<Symbol>]
|
|
199
|
+
end
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
class Soniox < Telnyx::Internal::Type::BaseModel
|
|
203
|
+
# @!attribute transcription_engine
|
|
204
|
+
# Engine identifier for Soniox transcription service
|
|
205
|
+
#
|
|
206
|
+
# @return [Symbol, :Soniox]
|
|
207
|
+
required :transcription_engine, const: :Soniox
|
|
208
|
+
|
|
209
|
+
# @!attribute enable_endpoint_detection
|
|
210
|
+
# When true, Soniox emits end-of-utterance events at the cadence configured by
|
|
211
|
+
# `max_endpoint_delay_ms`.
|
|
212
|
+
#
|
|
213
|
+
# @return [Boolean, nil]
|
|
214
|
+
optional :enable_endpoint_detection, Telnyx::Internal::Type::Boolean
|
|
215
|
+
|
|
216
|
+
# @!attribute interim_results
|
|
217
|
+
# Whether to send also interim results. If set to false, only final results will
|
|
218
|
+
# be sent.
|
|
219
|
+
#
|
|
220
|
+
# @return [Boolean, nil]
|
|
221
|
+
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
222
|
+
|
|
223
|
+
# @!attribute language
|
|
224
|
+
# ISO 639-1 language hint (e.g. `en`, `es`), or `auto` to omit the hint and let
|
|
225
|
+
# Soniox auto-detect supported languages multilingually.
|
|
226
|
+
#
|
|
227
|
+
# @return [String, nil]
|
|
228
|
+
optional :language, String
|
|
229
|
+
|
|
230
|
+
# @!attribute max_endpoint_delay_ms
|
|
231
|
+
# Maximum silence (in milliseconds) before Soniox emits an end-of-utterance event.
|
|
232
|
+
# Only honored when `enable_endpoint_detection` is true. Range: 500-3000 ms.
|
|
233
|
+
#
|
|
234
|
+
# @return [Integer, nil]
|
|
235
|
+
optional :max_endpoint_delay_ms, Integer
|
|
236
|
+
|
|
237
|
+
# @!attribute transcription_model
|
|
238
|
+
# The model to use for transcription.
|
|
239
|
+
#
|
|
240
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel, nil]
|
|
241
|
+
optional :transcription_model,
|
|
242
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel }
|
|
243
|
+
|
|
244
|
+
# @!method initialize(enable_endpoint_detection: nil, interim_results: nil, language: nil, max_endpoint_delay_ms: nil, transcription_model: nil, transcription_engine: :Soniox)
|
|
245
|
+
# Some parameter documentations has been truncated, see
|
|
246
|
+
# {Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox}
|
|
247
|
+
# for more details.
|
|
248
|
+
#
|
|
249
|
+
# @param enable_endpoint_detection [Boolean] When true, Soniox emits end-of-utterance events at the cadence configured by `ma
|
|
250
|
+
#
|
|
251
|
+
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
252
|
+
#
|
|
253
|
+
# @param language [String] ISO 639-1 language hint (e.g. `en`, `es`), or `auto` to omit the hint and let So
|
|
254
|
+
#
|
|
255
|
+
# @param max_endpoint_delay_ms [Integer] Maximum silence (in milliseconds) before Soniox emits an end-of-utterance event.
|
|
256
|
+
#
|
|
257
|
+
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel] The model to use for transcription.
|
|
258
|
+
#
|
|
259
|
+
# @param transcription_engine [Symbol, :Soniox] Engine identifier for Soniox transcription service
|
|
260
|
+
|
|
261
|
+
# The model to use for transcription.
|
|
262
|
+
#
|
|
263
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox#transcription_model
|
|
264
|
+
module TranscriptionModel
|
|
265
|
+
extend Telnyx::Internal::Type::Enum
|
|
266
|
+
|
|
267
|
+
SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
|
|
268
|
+
|
|
269
|
+
# @!method self.values
|
|
270
|
+
# @return [Array<Symbol>]
|
|
271
|
+
end
|
|
272
|
+
end
|
|
273
|
+
|
|
103
274
|
# @!method self.variants
|
|
104
|
-
# @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::
|
|
275
|
+
# @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config)]
|
|
105
276
|
end
|
|
106
277
|
end
|
|
107
278
|
end
|
|
@@ -47,7 +47,7 @@ module Telnyx
|
|
|
47
47
|
#
|
|
48
48
|
# @param conversation [String] Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided, Te
|
|
49
49
|
#
|
|
50
|
-
# @param input [
|
|
50
|
+
# @param input [Object] The input items for this turn, using the OpenAI Responses API input format.
|
|
51
51
|
#
|
|
52
52
|
# @param instructions [String] Optional system/developer instructions for the model. When used with a persisted
|
|
53
53
|
#
|
data/lib/telnyx/resources/ai.rb
CHANGED
|
@@ -55,9 +55,9 @@ module Telnyx
|
|
|
55
55
|
# supported at the moment. Use the `conversation` parameter with a Telnyx
|
|
56
56
|
# Conversation ID to leverage persistent conversations.
|
|
57
57
|
#
|
|
58
|
-
# @overload create_response(
|
|
58
|
+
# @overload create_response(body:, request_options: {})
|
|
59
59
|
#
|
|
60
|
-
# @param
|
|
60
|
+
# @param body [Hash{Symbol=>Object}]
|
|
61
61
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
62
62
|
#
|
|
63
63
|
# @return [Hash{Symbol=>Object}]
|
|
@@ -68,7 +68,7 @@ module Telnyx
|
|
|
68
68
|
@client.request(
|
|
69
69
|
method: :post,
|
|
70
70
|
path: "ai/responses",
|
|
71
|
-
body: parsed[:
|
|
71
|
+
body: parsed[:body],
|
|
72
72
|
model: Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
|
|
73
73
|
options: options
|
|
74
74
|
)
|
|
@@ -1321,7 +1321,7 @@ module Telnyx
|
|
|
1321
1321
|
#
|
|
1322
1322
|
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
|
|
1323
1323
|
#
|
|
1324
|
-
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::
|
|
1324
|
+
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
1325
1325
|
#
|
|
1326
1326
|
# @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
|
|
1327
1327
|
#
|
data/lib/telnyx/version.rb
CHANGED
data/lib/telnyx.rb
CHANGED
|
@@ -665,7 +665,6 @@ require_relative "telnyx/models/calls/transcription_engine_azure_config"
|
|
|
665
665
|
require_relative "telnyx/models/calls/transcription_engine_b_config"
|
|
666
666
|
require_relative "telnyx/models/calls/transcription_engine_deepgram_config"
|
|
667
667
|
require_relative "telnyx/models/calls/transcription_engine_google_config"
|
|
668
|
-
require_relative "telnyx/models/calls/transcription_engine_speechmatics_config"
|
|
669
668
|
require_relative "telnyx/models/calls/transcription_engine_telnyx_config"
|
|
670
669
|
require_relative "telnyx/models/calls/transcription_engine_xai_config"
|
|
671
670
|
require_relative "telnyx/models/call_siprec_failed"
|
|
@@ -26,10 +26,10 @@ module Telnyx
|
|
|
26
26
|
attr_writer :conversation
|
|
27
27
|
|
|
28
28
|
# The input items for this turn, using the OpenAI Responses API input format.
|
|
29
|
-
sig { returns(T.nilable(T
|
|
29
|
+
sig { returns(T.nilable(T.anything)) }
|
|
30
30
|
attr_reader :input
|
|
31
31
|
|
|
32
|
-
sig { params(input: T
|
|
32
|
+
sig { params(input: T.anything).void }
|
|
33
33
|
attr_writer :input
|
|
34
34
|
|
|
35
35
|
# Optional system/developer instructions for the model. When used with a persisted
|
|
@@ -60,7 +60,7 @@ module Telnyx
|
|
|
60
60
|
sig do
|
|
61
61
|
params(
|
|
62
62
|
conversation: String,
|
|
63
|
-
input: T
|
|
63
|
+
input: T.anything,
|
|
64
64
|
instructions: String,
|
|
65
65
|
model: String,
|
|
66
66
|
stream: T::Boolean,
|
|
@@ -93,7 +93,7 @@ module Telnyx
|
|
|
93
93
|
override.returns(
|
|
94
94
|
{
|
|
95
95
|
conversation: String,
|
|
96
|
-
input: T
|
|
96
|
+
input: T.anything,
|
|
97
97
|
instructions: String,
|
|
98
98
|
model: String,
|
|
99
99
|
stream: T::Boolean,
|
|
@@ -21,7 +21,9 @@ module Telnyx
|
|
|
21
21
|
# supported models will automatically detect the language. For `deepgram/flux`,
|
|
22
22
|
# supported values are: `auto` (Telnyx language detection controls the language
|
|
23
23
|
# hint), `multi` (no language hint), and language-specific hints `en`, `es`, `fr`,
|
|
24
|
-
# `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`.
|
|
24
|
+
# `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For `soniox/stt-rt-v4`, `auto`
|
|
25
|
+
# omits the language hint and lets Soniox auto-detect; ISO 639-1 codes (e.g. `en`,
|
|
26
|
+
# `es`) bias detection toward that language.
|
|
25
27
|
sig { returns(T.nilable(String)) }
|
|
26
28
|
attr_reader :language
|
|
27
29
|
|
|
@@ -38,6 +40,8 @@ module Telnyx
|
|
|
38
40
|
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
39
41
|
# configurable turn detection.
|
|
40
42
|
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
43
|
+
# - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
|
|
44
|
+
# detection and configurable endpointing.
|
|
41
45
|
sig do
|
|
42
46
|
returns(T.nilable(Telnyx::AI::TranscriptionSettings::Model::OrSymbol))
|
|
43
47
|
end
|
|
@@ -81,7 +85,9 @@ module Telnyx
|
|
|
81
85
|
# supported models will automatically detect the language. For `deepgram/flux`,
|
|
82
86
|
# supported values are: `auto` (Telnyx language detection controls the language
|
|
83
87
|
# hint), `multi` (no language hint), and language-specific hints `en`, `es`, `fr`,
|
|
84
|
-
# `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`.
|
|
88
|
+
# `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For `soniox/stt-rt-v4`, `auto`
|
|
89
|
+
# omits the language hint and lets Soniox auto-detect; ISO 639-1 codes (e.g. `en`,
|
|
90
|
+
# `es`) bias detection toward that language.
|
|
85
91
|
language: nil,
|
|
86
92
|
# The speech to text model to be used by the voice assistant. All Deepgram models
|
|
87
93
|
# are run on-premise.
|
|
@@ -93,6 +99,8 @@ module Telnyx
|
|
|
93
99
|
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
94
100
|
# configurable turn detection.
|
|
95
101
|
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
102
|
+
# - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
|
|
103
|
+
# detection and configurable endpointing.
|
|
96
104
|
model: nil,
|
|
97
105
|
# Region on third party cloud providers (currently Azure) if using one of their
|
|
98
106
|
# models. Some regions require `api_key_ref`.
|
|
@@ -125,6 +133,8 @@ module Telnyx
|
|
|
125
133
|
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
126
134
|
# configurable turn detection.
|
|
127
135
|
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
136
|
+
# - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
|
|
137
|
+
# detection and configurable endpointing.
|
|
128
138
|
module Model
|
|
129
139
|
extend Telnyx::Internal::Type::Enum
|
|
130
140
|
|
|
@@ -164,6 +174,11 @@ module Telnyx
|
|
|
164
174
|
:"xai/grok-stt",
|
|
165
175
|
Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
|
|
166
176
|
)
|
|
177
|
+
SONIOX_STT_RT_V4 =
|
|
178
|
+
T.let(
|
|
179
|
+
:"soniox/stt-rt-v4",
|
|
180
|
+
Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
|
|
181
|
+
)
|
|
167
182
|
DISTIL_WHISPER_DISTIL_LARGE_V2 =
|
|
168
183
|
T.let(
|
|
169
184
|
:"distil-whisper/distil-large-v2",
|