telnyx 5.111.0 → 5.112.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/assistant_create_params.rb +178 -9
- data/lib/telnyx/models/ai/assistant_tool.rb +14 -14
- data/lib/telnyx/models/ai/assistant_update_params.rb +178 -9
- data/lib/telnyx/models/ai/assistants/canary_deploy.rb +123 -3
- data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +125 -3
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +179 -9
- data/lib/telnyx/models/ai/inference_embedding.rb +177 -9
- data/lib/telnyx/models/ai/openai_list_models_response.rb +210 -3
- data/lib/telnyx/models/ai/transfer_tool.rb +9 -7
- data/lib/telnyx/models/ai_retrieve_models_response.rb +210 -3
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +23 -4
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +23 -4
- data/lib/telnyx/models/calls/action_speak_params.rb +23 -4
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +23 -4
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +491 -0
- data/lib/telnyx/models/calls/action_start_conversation_relay_response.rb +37 -0
- data/lib/telnyx/models/calls/action_stop_conversation_relay_params.rb +44 -0
- data/lib/telnyx/models/calls/action_stop_conversation_relay_response.rb +18 -0
- data/lib/telnyx/models/calls/transcription_start_request.rb +167 -5
- data/lib/telnyx/models/conferences/action_speak_params.rb +23 -4
- data/lib/telnyx/models/network_list_interfaces_response.rb +2 -112
- data/lib/telnyx/models/public_internet_gateway_create_response.rb +8 -3
- data/lib/telnyx/models/public_internet_gateway_delete_response.rb +8 -3
- data/lib/telnyx/models/public_internet_gateway_list_response.rb +10 -0
- data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb +8 -3
- data/lib/telnyx/models/text_to_speech_generate_params.rb +6 -6
- data/lib/telnyx/models/uac_connection_create_params.rb +255 -9
- data/lib/telnyx/models/uac_connection_create_response.rb +878 -3
- data/lib/telnyx/models/uac_connection_delete_response.rb +878 -3
- data/lib/telnyx/models/uac_connection_list_response.rb +876 -0
- data/lib/telnyx/models/uac_connection_retrieve_response.rb +879 -3
- data/lib/telnyx/models/uac_connection_update_params.rb +255 -9
- data/lib/telnyx/models/uac_connection_update_response.rb +878 -3
- data/lib/telnyx/models/virtual_cross_connect_create_response.rb +8 -3
- data/lib/telnyx/models/virtual_cross_connect_delete_response.rb +8 -3
- data/lib/telnyx/models/virtual_cross_connect_list_response.rb +10 -0
- data/lib/telnyx/models/virtual_cross_connect_retrieve_response.rb +8 -3
- data/lib/telnyx/models/virtual_cross_connect_update_response.rb +8 -3
- data/lib/telnyx/models/wireguard_interface_create_response.rb +8 -3
- data/lib/telnyx/models/wireguard_interface_delete_response.rb +8 -3
- data/lib/telnyx/models/wireguard_interface_list_response.rb +10 -0
- data/lib/telnyx/models/wireguard_interface_retrieve_response.rb +8 -3
- data/lib/telnyx/models.rb +0 -20
- data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
- data/lib/telnyx/resources/ai/assistants.rb +6 -6
- data/lib/telnyx/resources/calls/actions.rb +101 -5
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
- data/lib/telnyx/resources/uac_connections.rb +8 -8
- data/lib/telnyx/resources/virtual_cross_connects.rb +2 -2
- data/lib/telnyx/resources/wireguard_interfaces.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +8 -22
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +352 -12
- data/rbi/telnyx/models/ai/assistant_tool.rbi +10 -10
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +352 -12
- data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +290 -4
- data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +301 -3
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +366 -12
- data/rbi/telnyx/models/ai/inference_embedding.rbi +351 -12
- data/rbi/telnyx/models/ai/openai_list_models_response.rbi +315 -3
- data/rbi/telnyx/models/ai/transfer_tool.rbi +5 -5
- data/rbi/telnyx/models/ai_retrieve_models_response.rbi +310 -3
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_speak_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +1075 -0
- data/rbi/telnyx/models/calls/action_start_conversation_relay_response.rbi +95 -0
- data/rbi/telnyx/models/calls/action_stop_conversation_relay_params.rbi +72 -0
- data/rbi/telnyx/models/calls/action_stop_conversation_relay_response.rbi +39 -0
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +480 -10
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +41 -5
- data/rbi/telnyx/models/network_list_interfaces_response.rbi +4 -181
- data/rbi/telnyx/models/public_internet_gateway_create_response.rbi +38 -6
- data/rbi/telnyx/models/public_internet_gateway_delete_response.rbi +38 -6
- data/rbi/telnyx/models/public_internet_gateway_list_response.rbi +23 -0
- data/rbi/telnyx/models/public_internet_gateway_retrieve_response.rbi +38 -6
- data/rbi/telnyx/models/text_to_speech_generate_params.rbi +6 -6
- data/rbi/telnyx/models/uac_connection_create_params.rbi +516 -12
- data/rbi/telnyx/models/uac_connection_create_response.rbi +1756 -4
- data/rbi/telnyx/models/uac_connection_delete_response.rbi +1756 -4
- data/rbi/telnyx/models/uac_connection_list_response.rbi +1727 -0
- data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +1756 -4
- data/rbi/telnyx/models/uac_connection_update_params.rbi +516 -12
- data/rbi/telnyx/models/uac_connection_update_response.rbi +1756 -4
- data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi +36 -6
- data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi +36 -6
- data/rbi/telnyx/models/virtual_cross_connect_list_response.rbi +23 -0
- data/rbi/telnyx/models/virtual_cross_connect_retrieve_response.rbi +38 -6
- data/rbi/telnyx/models/virtual_cross_connect_update_response.rbi +36 -6
- data/rbi/telnyx/models/wireguard_interface_create_response.rbi +36 -6
- data/rbi/telnyx/models/wireguard_interface_delete_response.rbi +36 -6
- data/rbi/telnyx/models/wireguard_interface_list_response.rbi +23 -0
- data/rbi/telnyx/models/wireguard_interface_retrieve_response.rbi +36 -6
- data/rbi/telnyx/models.rbi +0 -20
- data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +4 -2
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +9 -3
- data/rbi/telnyx/resources/ai/assistants.rbi +10 -6
- data/rbi/telnyx/resources/calls/actions.rbi +152 -6
- data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
- data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
- data/rbi/telnyx/resources/uac_connections.rbi +13 -7
- data/rbi/telnyx/resources/virtual_cross_connects.rbi +1 -1
- data/rbi/telnyx/resources/wireguard_interfaces.rbi +1 -1
- data/sig/telnyx/models/ai/assistant_create_params.rbs +149 -18
- data/sig/telnyx/models/ai/assistant_tool.rbs +8 -8
- data/sig/telnyx/models/ai/assistant_update_params.rbs +149 -18
- data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +113 -6
- data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +109 -4
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +152 -18
- data/sig/telnyx/models/ai/inference_embedding.rbs +149 -18
- data/sig/telnyx/models/ai/openai_list_models_response.rbs +149 -4
- data/sig/telnyx/models/ai/transfer_tool.rbs +4 -4
- data/sig/telnyx/models/ai_retrieve_models_response.rbs +149 -4
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_speak_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +416 -0
- data/sig/telnyx/models/calls/action_start_conversation_relay_response.rbs +45 -0
- data/sig/telnyx/models/calls/action_stop_conversation_relay_params.rbs +38 -0
- data/sig/telnyx/models/calls/action_stop_conversation_relay_response.rbs +20 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +184 -2
- data/sig/telnyx/models/conferences/action_speak_params.rbs +15 -1
- data/sig/telnyx/models/network_list_interfaces_response.rbs +4 -106
- data/sig/telnyx/models/public_internet_gateway_create_response.rbs +18 -6
- data/sig/telnyx/models/public_internet_gateway_delete_response.rbs +18 -6
- data/sig/telnyx/models/public_internet_gateway_list_response.rbs +11 -0
- data/sig/telnyx/models/public_internet_gateway_retrieve_response.rbs +18 -6
- data/sig/telnyx/models/text_to_speech_generate_params.rbs +6 -6
- data/sig/telnyx/models/uac_connection_create_params.rbs +211 -17
- data/sig/telnyx/models/uac_connection_create_response.rbs +731 -5
- data/sig/telnyx/models/uac_connection_delete_response.rbs +731 -5
- data/sig/telnyx/models/uac_connection_list_response.rbs +722 -0
- data/sig/telnyx/models/uac_connection_retrieve_response.rbs +731 -5
- data/sig/telnyx/models/uac_connection_update_params.rbs +211 -17
- data/sig/telnyx/models/uac_connection_update_response.rbs +731 -5
- data/sig/telnyx/models/virtual_cross_connect_create_response.rbs +18 -6
- data/sig/telnyx/models/virtual_cross_connect_delete_response.rbs +18 -6
- data/sig/telnyx/models/virtual_cross_connect_list_response.rbs +11 -0
- data/sig/telnyx/models/virtual_cross_connect_retrieve_response.rbs +18 -6
- data/sig/telnyx/models/virtual_cross_connect_update_response.rbs +18 -6
- data/sig/telnyx/models/wireguard_interface_create_response.rbs +18 -6
- data/sig/telnyx/models/wireguard_interface_delete_response.rbs +18 -6
- data/sig/telnyx/models/wireguard_interface_list_response.rbs +11 -0
- data/sig/telnyx/models/wireguard_interface_retrieve_response.rbs +18 -6
- data/sig/telnyx/models.rbs +0 -20
- data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
- data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
- data/sig/telnyx/resources/ai/assistants.rbs +6 -6
- data/sig/telnyx/resources/calls/actions.rbs +29 -0
- data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
- data/sig/telnyx/resources/uac_connections.rbs +7 -7
- data/sig/telnyx/resources/virtual_cross_connects.rbs +1 -1
- data/sig/telnyx/resources/wireguard_interfaces.rbs +1 -1
- metadata +26 -68
- data/lib/telnyx/models/ai/assistant_integration.rb +0 -38
- data/lib/telnyx/models/ai/assistant_mcp_server.rb +0 -35
- data/lib/telnyx/models/ai/assistants/clause.rb +0 -54
- data/lib/telnyx/models/ai/assistants/rollout_slot.rb +0 -27
- data/lib/telnyx/models/ai/assistants/rule_input.rb +0 -40
- data/lib/telnyx/models/ai/assistants/rule_output.rb +0 -40
- data/lib/telnyx/models/ai/assistants/serve.rb +0 -33
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +0 -47
- data/lib/telnyx/models/ai/start_speaking_plan.rb +0 -37
- data/lib/telnyx/models/ai/transcription_endpointing_plan.rb +0 -39
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +0 -64
- data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +0 -108
- data/lib/telnyx/models/model_metadata.rb +0 -212
- data/lib/telnyx/models/public_internet_gateway_read.rb +0 -83
- data/lib/telnyx/models/uac_connection.rb +0 -412
- data/lib/telnyx/models/uac_external_settings.rb +0 -101
- data/lib/telnyx/models/uac_inbound.rb +0 -210
- data/lib/telnyx/models/uac_internal_settings.rb +0 -25
- data/lib/telnyx/models/uac_outbound.rb +0 -131
- data/lib/telnyx/models/virtual_cross_connect_combined.rb +0 -212
- data/lib/telnyx/models/wireguard_interface_read.rb +0 -136
- data/lib/telnyx/models/xai_voice_settings.rb +0 -36
- data/rbi/telnyx/models/ai/assistant_integration.rbi +0 -60
- data/rbi/telnyx/models/ai/assistant_mcp_server.rbi +0 -51
- data/rbi/telnyx/models/ai/assistants/clause.rbi +0 -91
- data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi +0 -36
- data/rbi/telnyx/models/ai/assistants/rule_input.rbi +0 -73
- data/rbi/telnyx/models/ai/assistants/rule_output.rbi +0 -73
- data/rbi/telnyx/models/ai/assistants/serve.rbi +0 -61
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +0 -83
- data/rbi/telnyx/models/ai/start_speaking_plan.rbi +0 -70
- data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi +0 -71
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +0 -155
- data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +0 -329
- data/rbi/telnyx/models/model_metadata.rbi +0 -272
- data/rbi/telnyx/models/public_internet_gateway_read.rbi +0 -128
- data/rbi/telnyx/models/uac_connection.rbi +0 -684
- data/rbi/telnyx/models/uac_external_settings.rbi +0 -146
- data/rbi/telnyx/models/uac_inbound.rbi +0 -410
- data/rbi/telnyx/models/uac_internal_settings.rbi +0 -39
- data/rbi/telnyx/models/uac_outbound.rbi +0 -224
- data/rbi/telnyx/models/virtual_cross_connect_combined.rbi +0 -345
- data/rbi/telnyx/models/wireguard_interface_read.rbi +0 -213
- data/rbi/telnyx/models/xai_voice_settings.rbi +0 -64
- data/sig/telnyx/models/ai/assistant_integration.rbs +0 -26
- data/sig/telnyx/models/ai/assistant_mcp_server.rbs +0 -19
- data/sig/telnyx/models/ai/assistants/clause.rbs +0 -46
- data/sig/telnyx/models/ai/assistants/rollout_slot.rbs +0 -19
- data/sig/telnyx/models/ai/assistants/rule_input.rbs +0 -33
- data/sig/telnyx/models/ai/assistants/rule_output.rbs +0 -33
- data/sig/telnyx/models/ai/assistants/serve.rbs +0 -35
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +0 -40
- data/sig/telnyx/models/ai/start_speaking_plan.rbs +0 -33
- data/sig/telnyx/models/ai/transcription_endpointing_plan.rbs +0 -38
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +0 -62
- data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +0 -130
- data/sig/telnyx/models/model_metadata.rbs +0 -142
- data/sig/telnyx/models/public_internet_gateway_read.rbs +0 -80
- data/sig/telnyx/models/uac_connection.rbs +0 -338
- data/sig/telnyx/models/uac_external_settings.rbs +0 -73
- data/sig/telnyx/models/uac_inbound.rbs +0 -190
- data/sig/telnyx/models/uac_internal_settings.rbs +0 -15
- data/sig/telnyx/models/uac_outbound.rbs +0 -113
- data/sig/telnyx/models/virtual_cross_connect_combined.rbs +0 -190
- data/sig/telnyx/models/wireguard_interface_read.rbs +0 -127
- data/sig/telnyx/models/xai_voice_settings.rbs +0 -34
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
module Assistants
|
|
7
|
-
class RuleInput < Telnyx::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute serve
|
|
9
|
-
# What a rule serves when matched.
|
|
10
|
-
#
|
|
11
|
-
# Exactly one of:
|
|
12
|
-
#
|
|
13
|
-
# - `version_id` — serve a specific version
|
|
14
|
-
# - `rollout` — weighted random across versions; weights must sum to less than
|
|
15
|
-
# 100, with the leftover routing to the main version
|
|
16
|
-
#
|
|
17
|
-
# @return [Telnyx::Models::AI::Assistants::Serve]
|
|
18
|
-
required :serve, -> { Telnyx::AI::Assistants::Serve }
|
|
19
|
-
|
|
20
|
-
# @!attribute match
|
|
21
|
-
#
|
|
22
|
-
# @return [Array<Telnyx::Models::AI::Assistants::Clause>, nil]
|
|
23
|
-
optional :match, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::Clause] }
|
|
24
|
-
|
|
25
|
-
# @!method initialize(serve:, match: nil)
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Telnyx::Models::AI::Assistants::RuleInput} for more details.
|
|
28
|
-
#
|
|
29
|
-
# A targeting rule: `match` clauses (AND) gate `serve`.
|
|
30
|
-
#
|
|
31
|
-
# An empty `match` is a catch-all (always fires).
|
|
32
|
-
#
|
|
33
|
-
# @param serve [Telnyx::Models::AI::Assistants::Serve] What a rule serves when matched.
|
|
34
|
-
#
|
|
35
|
-
# @param match [Array<Telnyx::Models::AI::Assistants::Clause>]
|
|
36
|
-
end
|
|
37
|
-
end
|
|
38
|
-
end
|
|
39
|
-
end
|
|
40
|
-
end
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
module Assistants
|
|
7
|
-
class RuleOutput < Telnyx::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute serve
|
|
9
|
-
# What a rule serves when matched.
|
|
10
|
-
#
|
|
11
|
-
# Exactly one of:
|
|
12
|
-
#
|
|
13
|
-
# - `version_id` — serve a specific version
|
|
14
|
-
# - `rollout` — weighted random across versions; weights must sum to less than
|
|
15
|
-
# 100, with the leftover routing to the main version
|
|
16
|
-
#
|
|
17
|
-
# @return [Telnyx::Models::AI::Assistants::Serve]
|
|
18
|
-
required :serve, -> { Telnyx::AI::Assistants::Serve }
|
|
19
|
-
|
|
20
|
-
# @!attribute match
|
|
21
|
-
#
|
|
22
|
-
# @return [Array<Telnyx::Models::AI::Assistants::Clause>, nil]
|
|
23
|
-
optional :match, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::Clause] }
|
|
24
|
-
|
|
25
|
-
# @!method initialize(serve:, match: nil)
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Telnyx::Models::AI::Assistants::RuleOutput} for more details.
|
|
28
|
-
#
|
|
29
|
-
# A targeting rule: `match` clauses (AND) gate `serve`.
|
|
30
|
-
#
|
|
31
|
-
# An empty `match` is a catch-all (always fires).
|
|
32
|
-
#
|
|
33
|
-
# @param serve [Telnyx::Models::AI::Assistants::Serve] What a rule serves when matched.
|
|
34
|
-
#
|
|
35
|
-
# @param match [Array<Telnyx::Models::AI::Assistants::Clause>]
|
|
36
|
-
end
|
|
37
|
-
end
|
|
38
|
-
end
|
|
39
|
-
end
|
|
40
|
-
end
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
module Assistants
|
|
7
|
-
class Serve < Telnyx::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute rollout
|
|
9
|
-
#
|
|
10
|
-
# @return [Array<Telnyx::Models::AI::Assistants::RolloutSlot>, nil]
|
|
11
|
-
optional :rollout, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::RolloutSlot] }
|
|
12
|
-
|
|
13
|
-
# @!attribute version_id
|
|
14
|
-
#
|
|
15
|
-
# @return [String, nil]
|
|
16
|
-
optional :version_id, String
|
|
17
|
-
|
|
18
|
-
# @!method initialize(rollout: nil, version_id: nil)
|
|
19
|
-
# What a rule serves when matched.
|
|
20
|
-
#
|
|
21
|
-
# Exactly one of:
|
|
22
|
-
#
|
|
23
|
-
# - `version_id` — serve a specific version
|
|
24
|
-
# - `rollout` — weighted random across versions; weights must sum to less than
|
|
25
|
-
# 100, with the leftover routing to the main version
|
|
26
|
-
#
|
|
27
|
-
# @param rollout [Array<Telnyx::Models::AI::Assistants::RolloutSlot>]
|
|
28
|
-
# @param version_id [String]
|
|
29
|
-
end
|
|
30
|
-
end
|
|
31
|
-
end
|
|
32
|
-
end
|
|
33
|
-
end
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
class InferenceEmbeddingInterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute disable_greeting_interruption
|
|
8
|
-
# When true, disables user interruptions while the assistant greeting is playing.
|
|
9
|
-
#
|
|
10
|
-
# @return [Boolean, nil]
|
|
11
|
-
optional :disable_greeting_interruption, Telnyx::Internal::Type::Boolean
|
|
12
|
-
|
|
13
|
-
# @!attribute enable
|
|
14
|
-
# Whether users can interrupt the assistant while it is speaking.
|
|
15
|
-
#
|
|
16
|
-
# @return [Boolean, nil]
|
|
17
|
-
optional :enable, Telnyx::Internal::Type::Boolean
|
|
18
|
-
|
|
19
|
-
# @!attribute start_speaking_plan
|
|
20
|
-
# Controls when the assistant starts speaking after the user stops. These
|
|
21
|
-
# thresholds primarily apply to non turn-taking transcription models. For
|
|
22
|
-
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
23
|
-
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
24
|
-
#
|
|
25
|
-
# @return [Telnyx::Models::AI::StartSpeakingPlan, nil]
|
|
26
|
-
optional :start_speaking_plan, -> { Telnyx::AI::StartSpeakingPlan }
|
|
27
|
-
|
|
28
|
-
# @!method initialize(disable_greeting_interruption: nil, enable: nil, start_speaking_plan: nil)
|
|
29
|
-
# Some parameter documentations has been truncated, see
|
|
30
|
-
# {Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings} for more details.
|
|
31
|
-
#
|
|
32
|
-
# Settings for interruptions and how the assistant decides the user has finished
|
|
33
|
-
# speaking. These timings are most relevant when using non turn-taking
|
|
34
|
-
# transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
35
|
-
# behavior is controlled by the transcription end-of-turn settings under
|
|
36
|
-
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
37
|
-
# `eager_eot_threshold`).
|
|
38
|
-
#
|
|
39
|
-
# @param disable_greeting_interruption [Boolean] When true, disables user interruptions while the assistant greeting is playing.
|
|
40
|
-
#
|
|
41
|
-
# @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
|
|
42
|
-
#
|
|
43
|
-
# @param start_speaking_plan [Telnyx::Models::AI::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
|
|
44
|
-
end
|
|
45
|
-
end
|
|
46
|
-
end
|
|
47
|
-
end
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute transcription_endpointing_plan
|
|
8
|
-
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
9
|
-
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
10
|
-
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
11
|
-
# `eager_eot_threshold`.
|
|
12
|
-
#
|
|
13
|
-
# @return [Telnyx::Models::AI::TranscriptionEndpointingPlan, nil]
|
|
14
|
-
optional :transcription_endpointing_plan, -> { Telnyx::AI::TranscriptionEndpointingPlan }
|
|
15
|
-
|
|
16
|
-
# @!attribute wait_seconds
|
|
17
|
-
# Minimum seconds to wait before the assistant starts speaking.
|
|
18
|
-
#
|
|
19
|
-
# @return [Float, nil]
|
|
20
|
-
optional :wait_seconds, Float
|
|
21
|
-
|
|
22
|
-
# @!method initialize(transcription_endpointing_plan: nil, wait_seconds: nil)
|
|
23
|
-
# Some parameter documentations has been truncated, see
|
|
24
|
-
# {Telnyx::Models::AI::StartSpeakingPlan} for more details.
|
|
25
|
-
#
|
|
26
|
-
# Controls when the assistant starts speaking after the user stops. These
|
|
27
|
-
# thresholds primarily apply to non turn-taking transcription models. For
|
|
28
|
-
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
29
|
-
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
30
|
-
#
|
|
31
|
-
# @param transcription_endpointing_plan [Telnyx::Models::AI::TranscriptionEndpointingPlan] Endpointing thresholds used to decide when the user has finished speaking. Appli
|
|
32
|
-
#
|
|
33
|
-
# @param wait_seconds [Float] Minimum seconds to wait before the assistant starts speaking.
|
|
34
|
-
end
|
|
35
|
-
end
|
|
36
|
-
end
|
|
37
|
-
end
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute on_no_punctuation_seconds
|
|
8
|
-
# Seconds to wait after the transcript ends without punctuation.
|
|
9
|
-
#
|
|
10
|
-
# @return [Float, nil]
|
|
11
|
-
optional :on_no_punctuation_seconds, Float
|
|
12
|
-
|
|
13
|
-
# @!attribute on_number_seconds
|
|
14
|
-
# Seconds to wait after the transcript ends with a number.
|
|
15
|
-
#
|
|
16
|
-
# @return [Float, nil]
|
|
17
|
-
optional :on_number_seconds, Float
|
|
18
|
-
|
|
19
|
-
# @!attribute on_punctuation_seconds
|
|
20
|
-
# Seconds to wait after the transcript ends with punctuation.
|
|
21
|
-
#
|
|
22
|
-
# @return [Float, nil]
|
|
23
|
-
optional :on_punctuation_seconds, Float
|
|
24
|
-
|
|
25
|
-
# @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
|
|
26
|
-
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
27
|
-
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
28
|
-
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
29
|
-
# `eager_eot_threshold`.
|
|
30
|
-
#
|
|
31
|
-
# @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
|
|
32
|
-
#
|
|
33
|
-
# @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
|
|
34
|
-
#
|
|
35
|
-
# @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
|
|
36
|
-
end
|
|
37
|
-
end
|
|
38
|
-
end
|
|
39
|
-
end
|
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module Calls
|
|
6
|
-
class TranscriptionEngineAssemblyaiConfig < Telnyx::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute interim_results
|
|
8
|
-
# Whether to send also interim results. If set to false, only final results will
|
|
9
|
-
# be sent.
|
|
10
|
-
#
|
|
11
|
-
# @return [Boolean, nil]
|
|
12
|
-
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
13
|
-
|
|
14
|
-
# @!attribute transcription_engine
|
|
15
|
-
# Engine identifier for AssemblyAI transcription service
|
|
16
|
-
#
|
|
17
|
-
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionEngine, nil]
|
|
18
|
-
optional :transcription_engine,
|
|
19
|
-
enum: -> { Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionEngine }
|
|
20
|
-
|
|
21
|
-
# @!attribute transcription_model
|
|
22
|
-
# The model to use for transcription.
|
|
23
|
-
#
|
|
24
|
-
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionModel, nil]
|
|
25
|
-
optional :transcription_model,
|
|
26
|
-
enum: -> { Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionModel }
|
|
27
|
-
|
|
28
|
-
# @!method initialize(interim_results: nil, transcription_engine: nil, transcription_model: nil)
|
|
29
|
-
# Some parameter documentations has been truncated, see
|
|
30
|
-
# {Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig} for more details.
|
|
31
|
-
#
|
|
32
|
-
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
33
|
-
#
|
|
34
|
-
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionEngine] Engine identifier for AssemblyAI transcription service
|
|
35
|
-
#
|
|
36
|
-
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionModel] The model to use for transcription.
|
|
37
|
-
|
|
38
|
-
# Engine identifier for AssemblyAI transcription service
|
|
39
|
-
#
|
|
40
|
-
# @see Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig#transcription_engine
|
|
41
|
-
module TranscriptionEngine
|
|
42
|
-
extend Telnyx::Internal::Type::Enum
|
|
43
|
-
|
|
44
|
-
ASSEMBLY_AI = :AssemblyAI
|
|
45
|
-
|
|
46
|
-
# @!method self.values
|
|
47
|
-
# @return [Array<Symbol>]
|
|
48
|
-
end
|
|
49
|
-
|
|
50
|
-
# The model to use for transcription.
|
|
51
|
-
#
|
|
52
|
-
# @see Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig#transcription_model
|
|
53
|
-
module TranscriptionModel
|
|
54
|
-
extend Telnyx::Internal::Type::Enum
|
|
55
|
-
|
|
56
|
-
ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
|
|
57
|
-
|
|
58
|
-
# @!method self.values
|
|
59
|
-
# @return [Array<Symbol>]
|
|
60
|
-
end
|
|
61
|
-
end
|
|
62
|
-
end
|
|
63
|
-
end
|
|
64
|
-
end
|
|
@@ -1,108 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module Calls
|
|
6
|
-
class TranscriptionEngineXaiConfig < Telnyx::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute interim_results
|
|
8
|
-
# Whether to send also interim results. If set to false, only final results will
|
|
9
|
-
# be sent.
|
|
10
|
-
#
|
|
11
|
-
# @return [Boolean, nil]
|
|
12
|
-
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
13
|
-
|
|
14
|
-
# @!attribute language
|
|
15
|
-
# Language to use for speech recognition
|
|
16
|
-
#
|
|
17
|
-
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::Language, nil]
|
|
18
|
-
optional :language, enum: -> { Telnyx::Calls::TranscriptionEngineXaiConfig::Language }
|
|
19
|
-
|
|
20
|
-
# @!attribute transcription_engine
|
|
21
|
-
# Engine identifier for xAI transcription service
|
|
22
|
-
#
|
|
23
|
-
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::TranscriptionEngine, nil]
|
|
24
|
-
optional :transcription_engine,
|
|
25
|
-
enum: -> { Telnyx::Calls::TranscriptionEngineXaiConfig::TranscriptionEngine }
|
|
26
|
-
|
|
27
|
-
# @!attribute transcription_model
|
|
28
|
-
# The model to use for transcription.
|
|
29
|
-
#
|
|
30
|
-
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::TranscriptionModel, nil]
|
|
31
|
-
optional :transcription_model,
|
|
32
|
-
enum: -> { Telnyx::Calls::TranscriptionEngineXaiConfig::TranscriptionModel }
|
|
33
|
-
|
|
34
|
-
# @!method initialize(interim_results: nil, language: nil, transcription_engine: nil, transcription_model: nil)
|
|
35
|
-
# Some parameter documentations has been truncated, see
|
|
36
|
-
# {Telnyx::Models::Calls::TranscriptionEngineXaiConfig} for more details.
|
|
37
|
-
#
|
|
38
|
-
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
39
|
-
#
|
|
40
|
-
# @param language [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::Language] Language to use for speech recognition
|
|
41
|
-
#
|
|
42
|
-
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::TranscriptionEngine] Engine identifier for xAI transcription service
|
|
43
|
-
#
|
|
44
|
-
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionEngineXaiConfig::TranscriptionModel] The model to use for transcription.
|
|
45
|
-
|
|
46
|
-
# Language to use for speech recognition
|
|
47
|
-
#
|
|
48
|
-
# @see Telnyx::Models::Calls::TranscriptionEngineXaiConfig#language
|
|
49
|
-
module Language
|
|
50
|
-
extend Telnyx::Internal::Type::Enum
|
|
51
|
-
|
|
52
|
-
AR = :ar
|
|
53
|
-
CS = :cs
|
|
54
|
-
DA = :da
|
|
55
|
-
DE = :de
|
|
56
|
-
EN = :en
|
|
57
|
-
ES = :es
|
|
58
|
-
FA = :fa
|
|
59
|
-
FIL = :fil
|
|
60
|
-
FR = :fr
|
|
61
|
-
HI = :hi
|
|
62
|
-
ID = :id
|
|
63
|
-
IT = :it
|
|
64
|
-
JA = :ja
|
|
65
|
-
KO = :ko
|
|
66
|
-
MK = :mk
|
|
67
|
-
MS = :ms
|
|
68
|
-
NL = :nl
|
|
69
|
-
PL = :pl
|
|
70
|
-
PT = :pt
|
|
71
|
-
RO = :ro
|
|
72
|
-
RU = :ru
|
|
73
|
-
SV = :sv
|
|
74
|
-
TH = :th
|
|
75
|
-
TR = :tr
|
|
76
|
-
VI = :vi
|
|
77
|
-
|
|
78
|
-
# @!method self.values
|
|
79
|
-
# @return [Array<Symbol>]
|
|
80
|
-
end
|
|
81
|
-
|
|
82
|
-
# Engine identifier for xAI transcription service
|
|
83
|
-
#
|
|
84
|
-
# @see Telnyx::Models::Calls::TranscriptionEngineXaiConfig#transcription_engine
|
|
85
|
-
module TranscriptionEngine
|
|
86
|
-
extend Telnyx::Internal::Type::Enum
|
|
87
|
-
|
|
88
|
-
X_AI = :xAI
|
|
89
|
-
|
|
90
|
-
# @!method self.values
|
|
91
|
-
# @return [Array<Symbol>]
|
|
92
|
-
end
|
|
93
|
-
|
|
94
|
-
# The model to use for transcription.
|
|
95
|
-
#
|
|
96
|
-
# @see Telnyx::Models::Calls::TranscriptionEngineXaiConfig#transcription_model
|
|
97
|
-
module TranscriptionModel
|
|
98
|
-
extend Telnyx::Internal::Type::Enum
|
|
99
|
-
|
|
100
|
-
XAI_GROK_STT = :"xai/grok-stt"
|
|
101
|
-
|
|
102
|
-
# @!method self.values
|
|
103
|
-
# @return [Array<Symbol>]
|
|
104
|
-
end
|
|
105
|
-
end
|
|
106
|
-
end
|
|
107
|
-
end
|
|
108
|
-
end
|
|
@@ -1,212 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
class ModelMetadata < Telnyx::Internal::Type::BaseModel
|
|
6
|
-
# @!attribute id
|
|
7
|
-
# Model identifier. For open-source models, follows the
|
|
8
|
-
# `{organization}/{model_name}` convention from Hugging Face (e.g.
|
|
9
|
-
# `moonshotai/Kimi-K2.6`).
|
|
10
|
-
#
|
|
11
|
-
# @return [String]
|
|
12
|
-
required :id, String
|
|
13
|
-
|
|
14
|
-
# @!attribute context_length
|
|
15
|
-
# Maximum total tokens (prompt + completion) supported by the model in a single
|
|
16
|
-
# request.
|
|
17
|
-
#
|
|
18
|
-
# @return [Integer]
|
|
19
|
-
required :context_length, Integer
|
|
20
|
-
|
|
21
|
-
# @!attribute created
|
|
22
|
-
# Timestamp at which the model was registered on Telnyx Inference (ISO 8601).
|
|
23
|
-
#
|
|
24
|
-
# @return [Time]
|
|
25
|
-
required :created, Time
|
|
26
|
-
|
|
27
|
-
# @!attribute languages
|
|
28
|
-
# ISO language codes the model supports (e.g. `en`, `es`).
|
|
29
|
-
#
|
|
30
|
-
# @return [Array<String>]
|
|
31
|
-
required :languages, Telnyx::Internal::Type::ArrayOf[String]
|
|
32
|
-
|
|
33
|
-
# @!attribute license
|
|
34
|
-
# License the model is distributed under, e.g. `Apache 2.0`, `MIT`,
|
|
35
|
-
# `Llama 3 Community License`.
|
|
36
|
-
#
|
|
37
|
-
# @return [String]
|
|
38
|
-
required :license, String
|
|
39
|
-
|
|
40
|
-
# @!attribute organization
|
|
41
|
-
# Organization that originally published the model, matching the prefix of `id`
|
|
42
|
-
# for open-source models.
|
|
43
|
-
#
|
|
44
|
-
# @return [String]
|
|
45
|
-
required :organization, String
|
|
46
|
-
|
|
47
|
-
# @!attribute owned_by
|
|
48
|
-
# Owner of the model. `Telnyx` for Telnyx-hosted open-source models, the upstream
|
|
49
|
-
# provider name for proxied models, or the Telnyx organization id for fine-tuned
|
|
50
|
-
# models.
|
|
51
|
-
#
|
|
52
|
-
# @return [String]
|
|
53
|
-
required :owned_by, String
|
|
54
|
-
|
|
55
|
-
# @!attribute parameters
|
|
56
|
-
# Total parameter count of the model.
|
|
57
|
-
#
|
|
58
|
-
# @return [Integer]
|
|
59
|
-
required :parameters, Integer
|
|
60
|
-
|
|
61
|
-
# @!attribute tier
|
|
62
|
-
# Billing tier the model belongs to. Used together with `pricing` to determine
|
|
63
|
-
# cost per 1M tokens.
|
|
64
|
-
#
|
|
65
|
-
# @return [Symbol, Telnyx::Models::ModelMetadata::Tier]
|
|
66
|
-
required :tier, enum: -> { Telnyx::ModelMetadata::Tier }
|
|
67
|
-
|
|
68
|
-
# @!attribute base_model
|
|
69
|
-
# Base model the fine-tuned model was trained from. Only set for fine-tuned
|
|
70
|
-
# models.
|
|
71
|
-
#
|
|
72
|
-
# @return [String, nil]
|
|
73
|
-
optional :base_model, String, nil?: true
|
|
74
|
-
|
|
75
|
-
# @!attribute description
|
|
76
|
-
# Short, human-readable summary of what the model is best suited for.
|
|
77
|
-
#
|
|
78
|
-
# @return [String, nil]
|
|
79
|
-
optional :description, String, nil?: true
|
|
80
|
-
|
|
81
|
-
# @!attribute is_fine_tunable
|
|
82
|
-
# Whether the model can be used as a base for a fine-tuning job via
|
|
83
|
-
# `POST /v2/ai/fine_tuning/jobs`.
|
|
84
|
-
#
|
|
85
|
-
# @return [Boolean, nil]
|
|
86
|
-
optional :is_fine_tunable, Telnyx::Internal::Type::Boolean
|
|
87
|
-
|
|
88
|
-
# @!attribute is_vision_supported
|
|
89
|
-
# Whether the model accepts image inputs in chat completions (multimodal vision
|
|
90
|
-
# support).
|
|
91
|
-
#
|
|
92
|
-
# @return [Boolean, nil]
|
|
93
|
-
optional :is_vision_supported, Telnyx::Internal::Type::Boolean
|
|
94
|
-
|
|
95
|
-
# @!attribute max_completion_tokens
|
|
96
|
-
# Maximum number of completion (output) tokens the model will generate per
|
|
97
|
-
# request. `null` if unconstrained beyond `context_length`.
|
|
98
|
-
#
|
|
99
|
-
# @return [Integer, nil]
|
|
100
|
-
optional :max_completion_tokens, Integer, nil?: true
|
|
101
|
-
|
|
102
|
-
# @!attribute object
|
|
103
|
-
# Object type. Always `model`.
|
|
104
|
-
#
|
|
105
|
-
# @return [String, nil]
|
|
106
|
-
optional :object, String
|
|
107
|
-
|
|
108
|
-
# @!attribute parameters_str
|
|
109
|
-
# Human-readable parameter count, e.g. `1.0T`, `753.9B`, `8B`.
|
|
110
|
-
#
|
|
111
|
-
# @return [String, nil]
|
|
112
|
-
optional :parameters_str, String, nil?: true
|
|
113
|
-
|
|
114
|
-
# @!attribute pricing
|
|
115
|
-
# Mapping of token kind to price, as strings to preserve precision. Typical keys
|
|
116
|
-
# are `prompt`, `cached_prompt`, and `completion`. When pricing is available the
|
|
117
|
-
# block also includes `currency` (ISO 4217 code matching the account's configured
|
|
118
|
-
# billing currency) and `unit` (the denomination the prices are quoted in,
|
|
119
|
-
# currently always `1M_tokens` for token-priced models).
|
|
120
|
-
#
|
|
121
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
122
|
-
optional :pricing, Telnyx::Internal::Type::HashOf[String]
|
|
123
|
-
|
|
124
|
-
# @!attribute recommended_for_assistants
|
|
125
|
-
# Whether Telnyx currently recommends this model as the LLM powering a Telnyx AI
|
|
126
|
-
# Assistant.
|
|
127
|
-
#
|
|
128
|
-
# @return [Boolean, nil]
|
|
129
|
-
optional :recommended_for_assistants, Telnyx::Internal::Type::Boolean
|
|
130
|
-
|
|
131
|
-
# @!attribute regions
|
|
132
|
-
# Public region names where the model is currently deployed (e.g. `us-central-1`,
|
|
133
|
-
# `eu-central-1`).
|
|
134
|
-
#
|
|
135
|
-
# @return [Array<String>, nil]
|
|
136
|
-
optional :regions, Telnyx::Internal::Type::ArrayOf[String]
|
|
137
|
-
|
|
138
|
-
# @!attribute task
|
|
139
|
-
# Primary task the model is intended for, e.g. `text-generation`,
|
|
140
|
-
# `audio-text-to-text`, `feature-extraction` (embeddings).
|
|
141
|
-
#
|
|
142
|
-
# @return [String, nil]
|
|
143
|
-
optional :task, String
|
|
144
|
-
|
|
145
|
-
# @!method initialize(id:, context_length:, created:, languages:, license:, organization:, owned_by:, parameters:, tier:, base_model: nil, description: nil, is_fine_tunable: nil, is_vision_supported: nil, max_completion_tokens: nil, object: nil, parameters_str: nil, pricing: nil, recommended_for_assistants: nil, regions: nil, task: nil)
|
|
146
|
-
# Some parameter documentations has been truncated, see
|
|
147
|
-
# {Telnyx::Models::ModelMetadata} for more details.
|
|
148
|
-
#
|
|
149
|
-
# Metadata for a model available on Telnyx Inference. Returned by
|
|
150
|
-
# `GET /v2/ai/openai/models` (and the deprecated `GET /v2/ai/models`). Open-source
|
|
151
|
-
# models live under their Hugging Face organization (e.g. `moonshotai/Kimi-K2.6`,
|
|
152
|
-
# `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M2.7`); fine-tuned models are owned by
|
|
153
|
-
# the Telnyx organization that trained them.
|
|
154
|
-
#
|
|
155
|
-
# @param id [String] Model identifier. For open-source models, follows the `{organization}/{model_nam
|
|
156
|
-
#
|
|
157
|
-
# @param context_length [Integer] Maximum total tokens (prompt + completion) supported by the model in a single re
|
|
158
|
-
#
|
|
159
|
-
# @param created [Time] Timestamp at which the model was registered on Telnyx Inference (ISO 8601).
|
|
160
|
-
#
|
|
161
|
-
# @param languages [Array<String>] ISO language codes the model supports (e.g. `en`, `es`).
|
|
162
|
-
#
|
|
163
|
-
# @param license [String] License the model is distributed under, e.g. `Apache 2.0`, `MIT`, `Llama 3 Commu
|
|
164
|
-
#
|
|
165
|
-
# @param organization [String] Organization that originally published the model, matching the prefix of `id` fo
|
|
166
|
-
#
|
|
167
|
-
# @param owned_by [String] Owner of the model. `Telnyx` for Telnyx-hosted open-source models, the upstream
|
|
168
|
-
#
|
|
169
|
-
# @param parameters [Integer] Total parameter count of the model.
|
|
170
|
-
#
|
|
171
|
-
# @param tier [Symbol, Telnyx::Models::ModelMetadata::Tier] Billing tier the model belongs to. Used together with `pricing` to determine cos
|
|
172
|
-
#
|
|
173
|
-
# @param base_model [String, nil] Base model the fine-tuned model was trained from. Only set for fine-tuned models
|
|
174
|
-
#
|
|
175
|
-
# @param description [String, nil] Short, human-readable summary of what the model is best suited for.
|
|
176
|
-
#
|
|
177
|
-
# @param is_fine_tunable [Boolean] Whether the model can be used as a base for a fine-tuning job via `POST /v2/ai/f
|
|
178
|
-
#
|
|
179
|
-
# @param is_vision_supported [Boolean] Whether the model accepts image inputs in chat completions (multimodal vision su
|
|
180
|
-
#
|
|
181
|
-
# @param max_completion_tokens [Integer, nil] Maximum number of completion (output) tokens the model will generate per request
|
|
182
|
-
#
|
|
183
|
-
# @param object [String] Object type. Always `model`.
|
|
184
|
-
#
|
|
185
|
-
# @param parameters_str [String, nil] Human-readable parameter count, e.g. `1.0T`, `753.9B`, `8B`.
|
|
186
|
-
#
|
|
187
|
-
# @param pricing [Hash{Symbol=>String}] Mapping of token kind to price, as strings to preserve precision. Typical keys a
|
|
188
|
-
#
|
|
189
|
-
# @param recommended_for_assistants [Boolean] Whether Telnyx currently recommends this model as the LLM powering a Telnyx AI A
|
|
190
|
-
#
|
|
191
|
-
# @param regions [Array<String>] Public region names where the model is currently deployed (e.g. `us-central-1`,
|
|
192
|
-
#
|
|
193
|
-
# @param task [String] Primary task the model is intended for, e.g. `text-generation`, `audio-text-to-t
|
|
194
|
-
|
|
195
|
-
# Billing tier the model belongs to. Used together with `pricing` to determine
|
|
196
|
-
# cost per 1M tokens.
|
|
197
|
-
#
|
|
198
|
-
# @see Telnyx::Models::ModelMetadata#tier
|
|
199
|
-
module Tier
|
|
200
|
-
extend Telnyx::Internal::Type::Enum
|
|
201
|
-
|
|
202
|
-
SMALL = :small
|
|
203
|
-
MEDIUM = :medium
|
|
204
|
-
LARGE = :large
|
|
205
|
-
UNLISTED = :unlisted
|
|
206
|
-
|
|
207
|
-
# @!method self.values
|
|
208
|
-
# @return [Array<Symbol>]
|
|
209
|
-
end
|
|
210
|
-
end
|
|
211
|
-
end
|
|
212
|
-
end
|