telnyx 5.154.0 → 5.156.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 +6 -13
- data/README.md +1 -1
- data/lib/telnyx/client.rb +1 -0
- data/lib/telnyx/internal/type/union.rb +4 -4
- data/lib/telnyx/models/ai/assistant_create_params.rb +2 -2
- data/lib/telnyx/models/ai/assistant_tool.rb +94 -1
- data/lib/telnyx/models/ai/assistant_update_params.rb +2 -2
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +2 -2
- data/lib/telnyx/models/ai/inference_embedding.rb +6 -6
- data/lib/telnyx/models/ai/tool_create_params.rb +7 -1
- data/lib/telnyx/models/ai/tool_update_params.rb +7 -1
- data/lib/telnyx/models/ai/transcription_settings.rb +5 -0
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +3 -0
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +6 -0
- data/lib/telnyx/models/calls/action_speak_params.rb +6 -0
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +3 -0
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +3 -0
- data/lib/telnyx/models/calls/telnyx_voice_settings.rb +2 -1
- data/lib/telnyx/models/calls/transcription_config.rb +5 -0
- data/lib/telnyx/models/conferences/action_speak_params.rb +6 -0
- data/lib/telnyx/models/conversation_relay_embedded_config.rb +3 -0
- data/lib/telnyx/models/models_response.rb +0 -1
- data/lib/telnyx/models/phone_number_delete_response.rb +12 -1
- data/lib/telnyx/models/phone_number_detailed.rb +12 -1
- data/lib/telnyx/models/phone_number_slim_list_response.rb +12 -1
- data/lib/telnyx/models/speech_to_text_list_providers_params.rb +1 -0
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +2 -0
- data/lib/telnyx/models/text_to_speech_generate_speech_params.rb +13 -8
- data/lib/telnyx/models/text_to_speech_retrieve_speech_params.rb +4 -4
- data/lib/telnyx/models.rb +0 -6
- data/lib/telnyx/resources/ai/assistants/versions.rb +1 -1
- data/lib/telnyx/resources/ai/assistants.rb +2 -2
- data/lib/telnyx/resources/ai/chat.rb +0 -81
- data/lib/telnyx/resources/ai/tools.rb +5 -2
- data/lib/telnyx/resources/ai.rb +0 -57
- data/lib/telnyx/resources/messages.rb +1 -32
- data/lib/telnyx/resources/speech_to_text.rb +1 -1
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +0 -7
- data/rbi/telnyx/client.rbi +1 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +4 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +221 -0
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +4 -0
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +4 -0
- data/rbi/telnyx/models/ai/inference_embedding.rbi +6 -0
- data/rbi/telnyx/models/ai/tool_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/tool_update_params.rbi +9 -0
- data/rbi/telnyx/models/ai/transcription_settings.rbi +11 -0
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +6 -0
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +12 -0
- data/rbi/telnyx/models/calls/action_speak_params.rbi +12 -0
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +6 -0
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +6 -0
- data/rbi/telnyx/models/calls/telnyx_voice_settings.rbi +4 -2
- data/rbi/telnyx/models/calls/transcription_config.rbi +11 -0
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +12 -0
- data/rbi/telnyx/models/conversation_relay_embedded_config.rbi +6 -0
- data/rbi/telnyx/models/phone_number_delete_response.rbi +14 -0
- data/rbi/telnyx/models/phone_number_detailed.rbi +14 -0
- data/rbi/telnyx/models/phone_number_slim_list_response.rbi +14 -0
- data/rbi/telnyx/models/speech_to_text_list_providers_params.rbi +5 -0
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +10 -0
- data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi +21 -13
- data/rbi/telnyx/models/text_to_speech_retrieve_speech_params.rbi +8 -8
- data/rbi/telnyx/models.rbi +0 -7
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +1 -0
- data/rbi/telnyx/resources/ai/assistants.rbi +2 -0
- data/rbi/telnyx/resources/ai/chat.rbi +0 -129
- data/rbi/telnyx/resources/ai/tools.rbi +4 -0
- data/rbi/telnyx/resources/ai.rbi +0 -33
- data/rbi/telnyx/resources/calls/actions.rbi +21 -0
- data/rbi/telnyx/resources/conferences/actions.rbi +6 -0
- data/rbi/telnyx/resources/messages.rbi +1 -28
- data/rbi/telnyx/resources/speech_to_text.rbi +1 -1
- data/rbi/telnyx/resources/text_to_speech.rbi +11 -9
- data/sig/telnyx/models/ai/assistant_tool.rbs +95 -0
- data/sig/telnyx/models/ai/tool_create_params.rbs +7 -0
- data/sig/telnyx/models/ai/tool_update_params.rbs +7 -0
- data/sig/telnyx/models/ai/transcription_settings.rbs +2 -0
- data/sig/telnyx/models/calls/transcription_config.rbs +2 -0
- data/sig/telnyx/models/phone_number_delete_response.rbs +5 -0
- data/sig/telnyx/models/phone_number_detailed.rbs +5 -0
- data/sig/telnyx/models/phone_number_slim_list_response.rbs +5 -0
- data/sig/telnyx/models/speech_to_text_list_providers_params.rbs +2 -0
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +11 -1
- data/sig/telnyx/models.rbs +0 -6
- data/sig/telnyx/resources/ai/chat.rbs +0 -30
- data/sig/telnyx/resources/ai/tools.rbs +2 -0
- data/sig/telnyx/resources/ai.rbs +0 -9
- data/sig/telnyx/resources/messages.rbs +0 -10
- metadata +16 -23
- data/lib/telnyx/models/ai/chat_create_completion_params.rb +0 -16
- data/lib/telnyx/models/ai/chat_create_completion_response.rb +0 -10
- data/lib/telnyx/models/ai_create_response_deprecated_params.rb +0 -20
- data/lib/telnyx/models/ai_create_response_deprecated_response.rb +0 -8
- data/lib/telnyx/models/ai_retrieve_models_params.rb +0 -14
- data/lib/telnyx/models/message_send_whatsapp_params.rb +0 -71
- data/lib/telnyx/models/message_send_whatsapp_response.rb +0 -178
- data/rbi/telnyx/models/ai/chat_create_completion_params.rbi +0 -32
- data/rbi/telnyx/models/ai/chat_create_completion_response.rbi +0 -13
- data/rbi/telnyx/models/ai_create_response_deprecated_params.rbi +0 -41
- data/rbi/telnyx/models/ai_create_response_deprecated_response.rbi +0 -11
- data/rbi/telnyx/models/ai_retrieve_models_params.rbi +0 -27
- data/rbi/telnyx/models/message_send_whatsapp_params.rbi +0 -124
- data/rbi/telnyx/models/message_send_whatsapp_response.rbi +0 -379
- data/sig/telnyx/models/ai/chat_create_completion_params.rbs +0 -17
- data/sig/telnyx/models/ai/chat_create_completion_response.rbs +0 -9
- data/sig/telnyx/models/ai_create_response_deprecated_params.rbs +0 -24
- data/sig/telnyx/models/ai_create_response_deprecated_response.rbs +0 -7
- data/sig/telnyx/models/ai_retrieve_models_params.rbs +0 -15
- data/sig/telnyx/models/message_send_whatsapp_params.rbs +0 -69
- data/sig/telnyx/models/message_send_whatsapp_response.rbs +0 -191
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 90d7decc9cec24949a0d9beb4809b4c21521a283afc48f53ce0bc401d7db77d0
|
|
4
|
+
data.tar.gz: b0dd0d0bb56c06a18079fcc8e9aa77bc65dc2c0e2ec8da2c674686c3f197f90a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6cbcb63aa2277c0750355a893354d1025f689192b7e2be70267d5e7d96249cb3a16dafd3fa54adecbcfe4940987725b671d37e4ac80d1e014e8e7d7406886727
|
|
7
|
+
data.tar.gz: d6432420d78f51ef8dd197756c310071bca69ae741d449645f5701819f6ac92b0ff3dd2a29747d19b5d3f40228577d8c3097096e4cb1546e5b949442f7b69e51
|
data/CHANGELOG.md
CHANGED
|
@@ -1,27 +1,20 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
## [5.
|
|
3
|
+
## [5.156.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.155.0...v5.156.0) (2026-07-09)
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
### Bug Fixes
|
|
7
7
|
|
|
8
|
-
* **release:**
|
|
8
|
+
* **release:** ghost guard also verifies the GitHub Release exists ([#317](https://github.com/team-telnyx/telnyx-ruby/issues/317)) ([1a26287](https://github.com/team-telnyx/telnyx-ruby/commit/1a26287d09ca746144898eb875f64f72447b54b6))
|
|
9
|
+
* **release:** scan next's commits in release-pr (stop depending on master hotfixes) ([#315](https://github.com/team-telnyx/telnyx-ruby/issues/315)) ([67446aa](https://github.com/team-telnyx/telnyx-ruby/commit/67446aa023de85bdbd6143ec50b9f12d447fb0e7))
|
|
9
10
|
|
|
10
|
-
##
|
|
11
|
+
## 5.155.0 (2026-07-03)
|
|
11
12
|
|
|
12
|
-
|
|
13
|
-
### Bug Fixes
|
|
14
|
-
|
|
15
|
-
* use git reset --hard for tree replacement, force-push, and fix PR URL regex in release-please.yml ([#303](https://github.com/team-telnyx/telnyx-ruby/issues/303)) ([7da92a6](https://github.com/team-telnyx/telnyx-ruby/commit/7da92a649c21dd2f589008c48ae3622649a62a32))
|
|
16
|
-
|
|
17
|
-
## 5.152.0 (2026-07-02)
|
|
18
|
-
|
|
19
|
-
Full Changelog: [v5.151.0...v5.152.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.151.0...v5.152.0)
|
|
13
|
+
Full Changelog: [v5.154.0...v5.155.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.154.0...v5.155.0)
|
|
20
14
|
|
|
21
15
|
### Chores
|
|
22
16
|
|
|
23
|
-
* promote from staging
|
|
24
|
-
* sync repo ([a3e7b10](https://github.com/team-telnyx/telnyx-ruby/commit/a3e7b1046dc79c12fc799c6463d72200e812cbf8))
|
|
17
|
+
* promote from staging c6f14c5 ([a69dbbf](https://github.com/team-telnyx/telnyx-ruby/commit/a69dbbf9c0a47a118b79ef0e478a3d6e51a470e0))
|
|
25
18
|
|
|
26
19
|
## [5.147.0](https://github.com/team-telnyx/telnyx-ruby-staging/compare/v5.146.0...v5.147.0) (2026-06-18)
|
|
27
20
|
|
data/README.md
CHANGED
data/lib/telnyx/client.rb
CHANGED
|
@@ -10,10 +10,10 @@ module Telnyx
|
|
|
10
10
|
# case assistant_tool
|
|
11
11
|
# when Telnyx::AI::InferenceEmbeddingWebhookToolParams
|
|
12
12
|
# puts(assistant_tool.type)
|
|
13
|
+
# when Telnyx::AI::AssistantTool::ClientSideTool
|
|
14
|
+
# puts(assistant_tool.client_side_tool)
|
|
13
15
|
# when Telnyx::AI::RetrievalTool
|
|
14
16
|
# puts(assistant_tool.retrieval)
|
|
15
|
-
# when Telnyx::AI::AssistantTool::Handoff
|
|
16
|
-
# puts(assistant_tool.handoff)
|
|
17
17
|
# else
|
|
18
18
|
# puts(assistant_tool)
|
|
19
19
|
# end
|
|
@@ -22,10 +22,10 @@ module Telnyx
|
|
|
22
22
|
# case assistant_tool
|
|
23
23
|
# in {type: :webhook, webhook: webhook}
|
|
24
24
|
# puts(webhook)
|
|
25
|
+
# in {type: :client_side_tool, client_side_tool: client_side_tool}
|
|
26
|
+
# puts(client_side_tool)
|
|
25
27
|
# in {type: :retrieval, retrieval: retrieval}
|
|
26
28
|
# puts(retrieval)
|
|
27
|
-
# in {type: :handoff, handoff: handoff}
|
|
28
|
-
# puts(handoff)
|
|
29
29
|
# else
|
|
30
30
|
# puts(assistant_tool)
|
|
31
31
|
# end
|
|
@@ -192,7 +192,7 @@ module Telnyx
|
|
|
192
192
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
193
193
|
# endpoints.
|
|
194
194
|
#
|
|
195
|
-
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
195
|
+
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
196
196
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
197
197
|
|
|
198
198
|
# @!attribute transcription
|
|
@@ -263,7 +263,7 @@ module Telnyx
|
|
|
263
263
|
#
|
|
264
264
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
265
265
|
#
|
|
266
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
266
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
267
267
|
#
|
|
268
268
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
269
269
|
#
|
|
@@ -13,6 +13,8 @@ module Telnyx
|
|
|
13
13
|
|
|
14
14
|
variant :webhook, -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams }
|
|
15
15
|
|
|
16
|
+
variant :client_side_tool, -> { Telnyx::AI::AssistantTool::ClientSideTool }
|
|
17
|
+
|
|
16
18
|
variant :retrieval, -> { Telnyx::AI::RetrievalTool }
|
|
17
19
|
|
|
18
20
|
# The handoff tool allows the assistant to hand off control of the conversation to another AI assistant. By default, this will happen transparently to the end user.
|
|
@@ -33,6 +35,97 @@ module Telnyx
|
|
|
33
35
|
|
|
34
36
|
variant :skip_turn, -> { Telnyx::AI::AssistantTool::SkipTurn }
|
|
35
37
|
|
|
38
|
+
class ClientSideTool < Telnyx::Internal::Type::BaseModel
|
|
39
|
+
# @!attribute client_side_tool
|
|
40
|
+
#
|
|
41
|
+
# @return [Telnyx::Models::AI::AssistantTool::ClientSideTool::ClientSideTool]
|
|
42
|
+
required :client_side_tool, -> { Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool }
|
|
43
|
+
|
|
44
|
+
# @!attribute type
|
|
45
|
+
#
|
|
46
|
+
# @return [Symbol, :client_side_tool]
|
|
47
|
+
required :type, const: :client_side_tool
|
|
48
|
+
|
|
49
|
+
# @!method initialize(client_side_tool:, type: :client_side_tool)
|
|
50
|
+
# @param client_side_tool [Telnyx::Models::AI::AssistantTool::ClientSideTool::ClientSideTool]
|
|
51
|
+
# @param type [Symbol, :client_side_tool]
|
|
52
|
+
|
|
53
|
+
# @see Telnyx::Models::AI::AssistantTool::ClientSideTool#client_side_tool
|
|
54
|
+
class ClientSideTool < Telnyx::Internal::Type::BaseModel
|
|
55
|
+
# @!attribute description
|
|
56
|
+
# The description of the tool.
|
|
57
|
+
#
|
|
58
|
+
# @return [String]
|
|
59
|
+
required :description, String
|
|
60
|
+
|
|
61
|
+
# @!attribute name
|
|
62
|
+
# The name of the tool.
|
|
63
|
+
#
|
|
64
|
+
# @return [String]
|
|
65
|
+
required :name, String
|
|
66
|
+
|
|
67
|
+
# @!attribute parameters
|
|
68
|
+
# The parameters the tool accepts, described as a JSON Schema object. See the
|
|
69
|
+
# [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
|
|
70
|
+
# documentation about the format
|
|
71
|
+
#
|
|
72
|
+
# @return [Telnyx::Models::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters]
|
|
73
|
+
required :parameters, -> { Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters }
|
|
74
|
+
|
|
75
|
+
# @!method initialize(description:, name:, parameters:)
|
|
76
|
+
# Some parameter documentations has been truncated, see
|
|
77
|
+
# {Telnyx::Models::AI::AssistantTool::ClientSideTool::ClientSideTool} for more
|
|
78
|
+
# details.
|
|
79
|
+
#
|
|
80
|
+
# @param description [String] The description of the tool.
|
|
81
|
+
#
|
|
82
|
+
# @param name [String] The name of the tool.
|
|
83
|
+
#
|
|
84
|
+
# @param parameters [Telnyx::Models::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters] The parameters the tool accepts, described as a JSON Schema object. See the [JSO
|
|
85
|
+
|
|
86
|
+
# @see Telnyx::Models::AI::AssistantTool::ClientSideTool::ClientSideTool#parameters
|
|
87
|
+
class Parameters < Telnyx::Internal::Type::BaseModel
|
|
88
|
+
# @!attribute properties
|
|
89
|
+
# The properties of the parameters.
|
|
90
|
+
#
|
|
91
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
92
|
+
optional :properties, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
93
|
+
|
|
94
|
+
# @!attribute required
|
|
95
|
+
# The required properties of the parameters.
|
|
96
|
+
#
|
|
97
|
+
# @return [Array<String>, nil]
|
|
98
|
+
optional :required, Telnyx::Internal::Type::ArrayOf[String]
|
|
99
|
+
|
|
100
|
+
# @!attribute type
|
|
101
|
+
#
|
|
102
|
+
# @return [Symbol, Telnyx::Models::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::Type, nil]
|
|
103
|
+
optional :type, enum: -> { Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::Type }
|
|
104
|
+
|
|
105
|
+
# @!method initialize(properties: nil, required: nil, type: nil)
|
|
106
|
+
# The parameters the tool accepts, described as a JSON Schema object. See the
|
|
107
|
+
# [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
|
|
108
|
+
# documentation about the format
|
|
109
|
+
#
|
|
110
|
+
# @param properties [Hash{Symbol=>Object}] The properties of the parameters.
|
|
111
|
+
#
|
|
112
|
+
# @param required [Array<String>] The required properties of the parameters.
|
|
113
|
+
#
|
|
114
|
+
# @param type [Symbol, Telnyx::Models::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::Type]
|
|
115
|
+
|
|
116
|
+
# @see Telnyx::Models::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters#type
|
|
117
|
+
module Type
|
|
118
|
+
extend Telnyx::Internal::Type::Enum
|
|
119
|
+
|
|
120
|
+
OBJECT = :object
|
|
121
|
+
|
|
122
|
+
# @!method self.values
|
|
123
|
+
# @return [Array<Symbol>]
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
end
|
|
127
|
+
end
|
|
128
|
+
|
|
36
129
|
class Handoff < Telnyx::Internal::Type::BaseModel
|
|
37
130
|
# @!attribute handoff
|
|
38
131
|
#
|
|
@@ -953,7 +1046,7 @@ module Telnyx
|
|
|
953
1046
|
end
|
|
954
1047
|
|
|
955
1048
|
# @!method self.variants
|
|
956
|
-
# @return [Array(Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn)]
|
|
1049
|
+
# @return [Array(Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn)]
|
|
957
1050
|
end
|
|
958
1051
|
end
|
|
959
1052
|
end
|
|
@@ -204,7 +204,7 @@ module Telnyx
|
|
|
204
204
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
205
205
|
# endpoints.
|
|
206
206
|
#
|
|
207
|
-
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
207
|
+
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
208
208
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
209
209
|
|
|
210
210
|
# @!attribute transcription
|
|
@@ -285,7 +285,7 @@ module Telnyx
|
|
|
285
285
|
#
|
|
286
286
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
287
287
|
#
|
|
288
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
288
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
289
289
|
#
|
|
290
290
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
291
291
|
#
|
|
@@ -189,7 +189,7 @@ module Telnyx
|
|
|
189
189
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
190
190
|
# endpoints.
|
|
191
191
|
#
|
|
192
|
-
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
192
|
+
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
193
193
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
194
194
|
|
|
195
195
|
# @!attribute transcription
|
|
@@ -266,7 +266,7 @@ module Telnyx
|
|
|
266
266
|
#
|
|
267
267
|
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
268
268
|
#
|
|
269
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
269
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
270
270
|
#
|
|
271
271
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
272
272
|
#
|
|
@@ -199,7 +199,7 @@ module Telnyx
|
|
|
199
199
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
200
200
|
# endpoints.
|
|
201
201
|
#
|
|
202
|
-
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
202
|
+
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
203
203
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
204
204
|
|
|
205
205
|
# @!attribute transcription
|
|
@@ -295,7 +295,7 @@ module Telnyx
|
|
|
295
295
|
#
|
|
296
296
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
297
297
|
#
|
|
298
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
298
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
299
299
|
#
|
|
300
300
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
301
301
|
#
|
|
@@ -430,7 +430,7 @@ module Telnyx
|
|
|
430
430
|
# follow-up fetch per shared tool. Ignored on input — set `shared_tool_ids` to
|
|
431
431
|
# configure a node's tools.
|
|
432
432
|
#
|
|
433
|
-
# @return [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>>, nil]
|
|
433
|
+
# @return [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>>, nil]
|
|
434
434
|
optional :tools,
|
|
435
435
|
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool]] }
|
|
436
436
|
|
|
@@ -486,7 +486,7 @@ module Telnyx
|
|
|
486
486
|
#
|
|
487
487
|
# @param shared_tool_ids [Array<String>] IDs of shared (org-level) tools available at this node. Knowledge bases are atta
|
|
488
488
|
#
|
|
489
|
-
# @param tools [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>>] Full tool definitions for this node, resolved from `shared_tool_ids` server-side
|
|
489
|
+
# @param tools [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>>] Full tool definitions for this node, resolved from `shared_tool_ids` server-side
|
|
490
490
|
#
|
|
491
491
|
# @param tools_mode [Symbol, Telnyx::Models::AI::InferenceEmbedding::ConversationFlow::Node::Prompt::ToolsMode] How `shared_tool_ids` combine with the assistant-level tool set. `replace` (defa
|
|
492
492
|
#
|
|
@@ -576,7 +576,7 @@ module Telnyx
|
|
|
576
576
|
# responses so clients can render the node without a follow-up fetch. Ignored on
|
|
577
577
|
# input — set `shared_tool_id`.
|
|
578
578
|
#
|
|
579
|
-
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
579
|
+
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
580
580
|
optional :tool, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
581
581
|
|
|
582
582
|
# @!attribute type
|
|
@@ -600,7 +600,7 @@ module Telnyx
|
|
|
600
600
|
#
|
|
601
601
|
# @param position [Telnyx::Models::AI::NodePosition] Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
|
|
602
602
|
#
|
|
603
|
-
# @param tool [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Full tool definition resolved from `shared_tool_id` server-side. Populated on re
|
|
603
|
+
# @param tool [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Full tool definition resolved from `shared_tool_id` server-side. Populated on re
|
|
604
604
|
#
|
|
605
605
|
# @param type [Symbol, Telnyx::Models::AI::InferenceEmbedding::ConversationFlow::Node::Tool::Type] Node kind discriminator. Always `tool` for a tool node.
|
|
606
606
|
|
|
@@ -18,6 +18,11 @@ module Telnyx
|
|
|
18
18
|
# @return [String]
|
|
19
19
|
required :type, String
|
|
20
20
|
|
|
21
|
+
# @!attribute client_side_tool
|
|
22
|
+
#
|
|
23
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
24
|
+
optional :client_side_tool, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
25
|
+
|
|
21
26
|
# @!attribute function
|
|
22
27
|
#
|
|
23
28
|
# @return [Hash{Symbol=>Object}, nil]
|
|
@@ -48,9 +53,10 @@ module Telnyx
|
|
|
48
53
|
# @return [Hash{Symbol=>Object}, nil]
|
|
49
54
|
optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
50
55
|
|
|
51
|
-
# @!method initialize(display_name:, type:, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
|
|
56
|
+
# @!method initialize(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
|
|
52
57
|
# @param display_name [String]
|
|
53
58
|
# @param type [String]
|
|
59
|
+
# @param client_side_tool [Hash{Symbol=>Object}]
|
|
54
60
|
# @param function [Hash{Symbol=>Object}]
|
|
55
61
|
# @param handoff [Hash{Symbol=>Object}]
|
|
56
62
|
# @param invite [Hash{Symbol=>Object}]
|
|
@@ -13,6 +13,11 @@ module Telnyx
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :tool_id, String
|
|
15
15
|
|
|
16
|
+
# @!attribute client_side_tool
|
|
17
|
+
#
|
|
18
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
19
|
+
optional :client_side_tool, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
20
|
+
|
|
16
21
|
# @!attribute display_name
|
|
17
22
|
#
|
|
18
23
|
# @return [String, nil]
|
|
@@ -53,8 +58,9 @@ module Telnyx
|
|
|
53
58
|
# @return [Hash{Symbol=>Object}, nil]
|
|
54
59
|
optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
55
60
|
|
|
56
|
-
# @!method initialize(tool_id:, display_name: nil, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
|
|
61
|
+
# @!method initialize(tool_id:, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
|
|
57
62
|
# @param tool_id [String]
|
|
63
|
+
# @param client_side_tool [Hash{Symbol=>Object}]
|
|
58
64
|
# @param display_name [String]
|
|
59
65
|
# @param function [Hash{Symbol=>Object}]
|
|
60
66
|
# @param handoff [Hash{Symbol=>Object}]
|
|
@@ -36,6 +36,8 @@ module Telnyx
|
|
|
36
36
|
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
37
37
|
# - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
|
|
38
38
|
# detection and configurable endpointing.
|
|
39
|
+
# - `parakeet/tdt-0.6b-v3` is a multilingual transcription model with automatic
|
|
40
|
+
# language detection.
|
|
39
41
|
#
|
|
40
42
|
# @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model, nil]
|
|
41
43
|
optional :model, enum: -> { Telnyx::AI::TranscriptionSettings::Model }
|
|
@@ -78,6 +80,8 @@ module Telnyx
|
|
|
78
80
|
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
79
81
|
# - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
|
|
80
82
|
# detection and configurable endpointing.
|
|
83
|
+
# - `parakeet/tdt-0.6b-v3` is a multilingual transcription model with automatic
|
|
84
|
+
# language detection.
|
|
81
85
|
#
|
|
82
86
|
# @see Telnyx::Models::AI::TranscriptionSettings#model
|
|
83
87
|
module Model
|
|
@@ -90,6 +94,7 @@ module Telnyx
|
|
|
90
94
|
ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
|
|
91
95
|
XAI_GROK_STT = :"xai/grok-stt"
|
|
92
96
|
SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
|
|
97
|
+
PARAKEET_TDT_0_6B_V3 = :"parakeet/tdt-0.6b-v3"
|
|
93
98
|
DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
|
|
94
99
|
OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
|
|
95
100
|
|
|
@@ -136,6 +136,9 @@ module Telnyx
|
|
|
136
136
|
# - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
|
|
137
137
|
# `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
138
138
|
# `Max`, `TTS2`.
|
|
139
|
+
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
140
|
+
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
141
|
+
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
139
142
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
140
143
|
# `ara`, `rex`, `sal`, `leo`.
|
|
141
144
|
#
|
|
@@ -47,6 +47,9 @@ module Telnyx
|
|
|
47
47
|
# [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
|
|
48
48
|
# - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
|
|
49
49
|
# Use `voice_settings` to configure voice_speed and other synthesis parameters.
|
|
50
|
+
# `Bayan` provides Arabic (multiple dialects) and English voices (e.g.,
|
|
51
|
+
# `Telnyx.Bayan.Ahmed`, `Telnyx.Bayan.Amanda`). `Sukhan` provides Urdu voices
|
|
52
|
+
# (e.g., `Telnyx.Sukhan.urdu-professor`); `voice_speed` is not supported.
|
|
50
53
|
# - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
|
|
51
54
|
# `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
|
|
52
55
|
# `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
|
|
@@ -61,6 +64,9 @@ module Telnyx
|
|
|
61
64
|
# `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
62
65
|
# `Max`, `TTS2`. Use `voice_settings` to configure `delivery_mode` (`STABLE`,
|
|
63
66
|
# `BALANCED`, `CREATIVE`), supported by `TTS2` only.
|
|
67
|
+
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
68
|
+
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
69
|
+
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
64
70
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
65
71
|
# `ara`, `rex`, `sal`, `leo`.
|
|
66
72
|
#
|
|
@@ -47,6 +47,9 @@ module Telnyx
|
|
|
47
47
|
# [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
|
|
48
48
|
# - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
|
|
49
49
|
# Use `voice_settings` to configure voice_speed and other synthesis parameters.
|
|
50
|
+
# `Bayan` provides Arabic (multiple dialects) and English voices (e.g.,
|
|
51
|
+
# `Telnyx.Bayan.Ahmed`, `Telnyx.Bayan.Amanda`). `Sukhan` provides Urdu voices
|
|
52
|
+
# (e.g., `Telnyx.Sukhan.urdu-professor`); `voice_speed` is not supported.
|
|
50
53
|
# - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
|
|
51
54
|
# `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
|
|
52
55
|
# `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
|
|
@@ -61,6 +64,9 @@ module Telnyx
|
|
|
61
64
|
# `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
62
65
|
# `Max`, `TTS2`. Use `voice_settings` to configure `delivery_mode` (`STABLE`,
|
|
63
66
|
# `BALANCED`, `CREATIVE`), supported by `TTS2` only.
|
|
67
|
+
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
68
|
+
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
69
|
+
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
64
70
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
65
71
|
# `ara`, `rex`, `sal`, `leo`.
|
|
66
72
|
#
|
|
@@ -105,6 +105,9 @@ module Telnyx
|
|
|
105
105
|
# - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
|
|
106
106
|
# `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
107
107
|
# `Max`, `TTS2`.
|
|
108
|
+
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
109
|
+
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
110
|
+
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
108
111
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
109
112
|
# `ara`, `rex`, `sal`, `leo`.
|
|
110
113
|
#
|
|
@@ -194,6 +194,9 @@ module Telnyx
|
|
|
194
194
|
# - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
|
|
195
195
|
# `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
196
196
|
# `Max`, `TTS2`.
|
|
197
|
+
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
198
|
+
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
199
|
+
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
197
200
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
198
201
|
# `ara`, `rex`, `sal`, `leo`.
|
|
199
202
|
#
|
|
@@ -12,7 +12,8 @@ module Telnyx
|
|
|
12
12
|
|
|
13
13
|
# @!attribute voice_speed
|
|
14
14
|
# The voice speed to be used for the voice. The voice speed must be between 0.1
|
|
15
|
-
# and 2.0. Default value is 1.0.
|
|
15
|
+
# and 2.0. Default value is 1.0. Not supported for `Telnyx.Bayan.*` or
|
|
16
|
+
# `Telnyx.Sukhan.*` voices.
|
|
16
17
|
#
|
|
17
18
|
# @return [Float, nil]
|
|
18
19
|
optional :voice_speed, Float
|
|
@@ -29,6 +29,8 @@ module Telnyx
|
|
|
29
29
|
# - `xai/grok-stt` for live streaming transcription.
|
|
30
30
|
# - `soniox/stt-rt-v4` for live streaming multilingual transcription with
|
|
31
31
|
# automatic language detection.
|
|
32
|
+
# - `parakeet/tdt-0.6b-v3` for multilingual transcription with automatic language
|
|
33
|
+
# detection.
|
|
32
34
|
# - `azure/fast` and `azure/realtime`; Azure models require `region`, and
|
|
33
35
|
# unsupported regions require `api_key_ref`.
|
|
34
36
|
# - `google/latest_long` for non-streaming multilingual transcription.
|
|
@@ -64,6 +66,8 @@ module Telnyx
|
|
|
64
66
|
# - `xai/grok-stt` for live streaming transcription.
|
|
65
67
|
# - `soniox/stt-rt-v4` for live streaming multilingual transcription with
|
|
66
68
|
# automatic language detection.
|
|
69
|
+
# - `parakeet/tdt-0.6b-v3` for multilingual transcription with automatic language
|
|
70
|
+
# detection.
|
|
67
71
|
# - `azure/fast` and `azure/realtime`; Azure models require `region`, and
|
|
68
72
|
# unsupported regions require `api_key_ref`.
|
|
69
73
|
# - `google/latest_long` for non-streaming multilingual transcription.
|
|
@@ -85,6 +89,7 @@ module Telnyx
|
|
|
85
89
|
ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
|
|
86
90
|
XAI_GROK_STT = :"xai/grok-stt"
|
|
87
91
|
SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
|
|
92
|
+
PARAKEET_TDT_0_6B_V3 = :"parakeet/tdt-0.6b-v3"
|
|
88
93
|
AZURE_FAST = :"azure/fast"
|
|
89
94
|
AZURE_REALTIME = :"azure/realtime"
|
|
90
95
|
GOOGLE_LATEST_LONG = :"google/latest_long"
|
|
@@ -47,6 +47,9 @@ module Telnyx
|
|
|
47
47
|
# [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
|
|
48
48
|
# - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
|
|
49
49
|
# Use `voice_settings` to configure voice_speed and other synthesis parameters.
|
|
50
|
+
# `Bayan` provides Arabic (multiple dialects) and English voices (e.g.,
|
|
51
|
+
# `Telnyx.Bayan.Ahmed`, `Telnyx.Bayan.Amanda`). `Sukhan` provides Urdu voices
|
|
52
|
+
# (e.g., `Telnyx.Sukhan.urdu-professor`); `voice_speed` is not supported.
|
|
50
53
|
# - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
|
|
51
54
|
# `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
|
|
52
55
|
# `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
|
|
@@ -61,6 +64,9 @@ module Telnyx
|
|
|
61
64
|
# `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
62
65
|
# `Max`, `TTS2`. Use `voice_settings` to configure `delivery_mode` (`STABLE`,
|
|
63
66
|
# `BALANCED`, `CREATIVE`), supported by `TTS2` only.
|
|
67
|
+
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
68
|
+
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
69
|
+
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
64
70
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
65
71
|
# `ara`, `rex`, `sal`, `leo`.
|
|
66
72
|
#
|
|
@@ -128,6 +128,9 @@ module Telnyx
|
|
|
128
128
|
# - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
|
|
129
129
|
# `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
130
130
|
# `Max`, `TTS2`.
|
|
131
|
+
# - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
132
|
+
# `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
133
|
+
# `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
131
134
|
# - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
132
135
|
# `ara`, `rex`, `sal`, `leo`.
|
|
133
136
|
#
|
|
@@ -66,6 +66,15 @@ module Telnyx
|
|
|
66
66
|
# @return [String, nil]
|
|
67
67
|
optional :id, String
|
|
68
68
|
|
|
69
|
+
# @!attribute activated_at
|
|
70
|
+
# ISO 8601 formatted date indicating when the phone number was first activated
|
|
71
|
+
# (transitioned from purchase-pending or port-pending to active). Will be null for
|
|
72
|
+
# numbers that have not yet been activated, or for legacy numbers activated before
|
|
73
|
+
# this field was tracked.
|
|
74
|
+
#
|
|
75
|
+
# @return [Time, nil]
|
|
76
|
+
optional :activated_at, Time, nil?: true
|
|
77
|
+
|
|
69
78
|
# @!attribute call_forwarding_enabled
|
|
70
79
|
# Indicates if call forwarding will be enabled for this number if forwards_to and
|
|
71
80
|
# forwarding_type are filled in. Defaults to true for backwards compatibility with
|
|
@@ -175,12 +184,14 @@ module Telnyx
|
|
|
175
184
|
optional :updated_at, String
|
|
176
185
|
end
|
|
177
186
|
|
|
178
|
-
# @!method initialize(id: nil, billing_group_id: nil, call_forwarding_enabled: nil, call_recording_enabled: nil, caller_id_name_enabled: nil, cnam_listing_enabled: nil, connection_id: nil, connection_name: nil, created_at: nil, customer_reference: nil, deletion_lock_enabled: nil, emergency_address_id: nil, emergency_enabled: nil, external_pin: nil, hd_voice_enabled: nil, messaging_profile_id: nil, messaging_profile_name: nil, phone_number: nil, phone_number_type: nil, purchased_at: nil, record_type: nil, status: nil, t38_fax_gateway_enabled: nil, tags: nil, updated_at: nil)
|
|
187
|
+
# @!method initialize(id: nil, activated_at: nil, billing_group_id: nil, call_forwarding_enabled: nil, call_recording_enabled: nil, caller_id_name_enabled: nil, cnam_listing_enabled: nil, connection_id: nil, connection_name: nil, created_at: nil, customer_reference: nil, deletion_lock_enabled: nil, emergency_address_id: nil, emergency_enabled: nil, external_pin: nil, hd_voice_enabled: nil, messaging_profile_id: nil, messaging_profile_name: nil, phone_number: nil, phone_number_type: nil, purchased_at: nil, record_type: nil, status: nil, t38_fax_gateway_enabled: nil, tags: nil, updated_at: nil)
|
|
179
188
|
# Some parameter documentations has been truncated, see
|
|
180
189
|
# {Telnyx::Models::PhoneNumberDeleteResponse::Data} for more details.
|
|
181
190
|
#
|
|
182
191
|
# @param id [String] Identifies the resource.
|
|
183
192
|
#
|
|
193
|
+
# @param activated_at [Time, nil] ISO 8601 formatted date indicating when the phone number was first activated (tr
|
|
194
|
+
#
|
|
184
195
|
# @param billing_group_id [String] Identifies the billing group associated with the phone number.
|
|
185
196
|
#
|
|
186
197
|
# @param call_forwarding_enabled [Boolean] Indicates if call forwarding will be enabled for this number if forwards_to and
|