telnyx 5.112.0 → 5.113.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 +17 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +9 -178
- data/lib/telnyx/models/ai/assistant_integration.rb +38 -0
- data/lib/telnyx/models/ai/assistant_mcp_server.rb +35 -0
- data/lib/telnyx/models/ai/assistant_tool.rb +14 -14
- data/lib/telnyx/models/ai/assistant_update_params.rb +9 -178
- data/lib/telnyx/models/ai/assistants/canary_deploy.rb +3 -123
- data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +3 -125
- data/lib/telnyx/models/ai/assistants/clause.rb +54 -0
- data/lib/telnyx/models/ai/assistants/rollout_slot.rb +27 -0
- data/lib/telnyx/models/ai/assistants/rule_input.rb +40 -0
- data/lib/telnyx/models/ai/assistants/rule_output.rb +40 -0
- data/lib/telnyx/models/ai/assistants/serve.rb +33 -0
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +9 -179
- data/lib/telnyx/models/ai/inference_embedding.rb +9 -177
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +47 -0
- data/lib/telnyx/models/ai/openai_create_response_params.rb +3 -3
- data/lib/telnyx/models/ai/openai_list_models_response.rb +3 -210
- data/lib/telnyx/models/ai/start_speaking_plan.rb +37 -0
- data/lib/telnyx/models/ai/transcription_endpointing_plan.rb +39 -0
- data/lib/telnyx/models/ai/transfer_tool.rb +7 -9
- data/lib/telnyx/models/ai_create_response_params.rb +4 -4
- data/lib/telnyx/models/ai_retrieve_models_response.rb +3 -210
- data/lib/telnyx/models/call_conversation_ended.rb +13 -1
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +4 -23
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +4 -23
- data/lib/telnyx/models/calls/action_speak_params.rb +4 -23
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +4 -23
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +169 -118
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +64 -0
- data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +100 -0
- data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +108 -0
- data/lib/telnyx/models/calls/transcription_start_request.rb +8 -167
- data/lib/telnyx/models/conferences/action_speak_params.rb +4 -23
- data/lib/telnyx/models/fax.rb +7 -5
- data/lib/telnyx/models/fax_create_params.rb +7 -5
- data/lib/telnyx/models/fax_delivered.rb +3 -2
- data/lib/telnyx/models/fax_failed.rb +3 -2
- data/lib/telnyx/models/fax_media_processed.rb +3 -2
- data/lib/telnyx/models/fax_queued.rb +3 -2
- data/lib/telnyx/models/fax_sending_started.rb +3 -2
- data/lib/telnyx/models/model_metadata.rb +212 -0
- data/lib/telnyx/models/network_list_interfaces_response.rb +112 -2
- data/lib/telnyx/models/public_internet_gateway_create_response.rb +3 -8
- data/lib/telnyx/models/public_internet_gateway_delete_response.rb +3 -8
- data/lib/telnyx/models/public_internet_gateway_read.rb +83 -0
- data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb +3 -8
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +62 -12
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +18 -4
- data/lib/telnyx/models/text_to_speech_generate_params.rb +6 -6
- data/lib/telnyx/models/uac_connection.rb +412 -0
- data/lib/telnyx/models/uac_connection_create_params.rb +9 -255
- data/lib/telnyx/models/uac_connection_create_response.rb +3 -878
- data/lib/telnyx/models/uac_connection_delete_response.rb +3 -878
- data/lib/telnyx/models/uac_connection_retrieve_response.rb +3 -879
- data/lib/telnyx/models/uac_connection_update_params.rb +9 -255
- data/lib/telnyx/models/uac_connection_update_response.rb +3 -878
- data/lib/telnyx/models/uac_external_settings.rb +101 -0
- data/lib/telnyx/models/uac_inbound.rb +210 -0
- data/lib/telnyx/models/uac_internal_settings.rb +25 -0
- data/lib/telnyx/models/uac_outbound.rb +131 -0
- data/lib/telnyx/models/virtual_cross_connect_combined.rb +212 -0
- data/lib/telnyx/models/virtual_cross_connect_create_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_delete_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_retrieve_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_update_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_create_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_delete_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_read.rb +136 -0
- data/lib/telnyx/models/wireguard_interface_retrieve_response.rb +3 -8
- data/lib/telnyx/models/xai_voice_settings.rb +36 -0
- data/lib/telnyx/models.rb +20 -0
- 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/ai/openai.rb +1 -1
- data/lib/telnyx/resources/ai.rb +3 -3
- data/lib/telnyx/resources/calls/actions.rb +15 -17
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/faxes.rb +13 -1
- data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
- data/lib/telnyx/resources/texml.rb +4 -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 +23 -4
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -352
- data/rbi/telnyx/models/ai/assistant_integration.rbi +60 -0
- data/rbi/telnyx/models/ai/assistant_mcp_server.rbi +51 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +10 -10
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -352
- data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +4 -290
- data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +3 -301
- data/rbi/telnyx/models/ai/assistants/clause.rbi +91 -0
- data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi +36 -0
- data/rbi/telnyx/models/ai/assistants/rule_input.rbi +73 -0
- data/rbi/telnyx/models/ai/assistants/rule_output.rbi +73 -0
- data/rbi/telnyx/models/ai/assistants/serve.rbi +61 -0
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -366
- data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -351
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +83 -0
- data/rbi/telnyx/models/ai/openai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/ai/openai_list_models_response.rbi +3 -315
- data/rbi/telnyx/models/ai/start_speaking_plan.rbi +70 -0
- data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi +71 -0
- data/rbi/telnyx/models/ai/transfer_tool.rbi +5 -5
- data/rbi/telnyx/models/ai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/ai_retrieve_models_response.rbi +3 -310
- data/rbi/telnyx/models/call_conversation_ended.rbi +10 -0
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_speak_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +371 -254
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +155 -0
- data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +289 -0
- data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +329 -0
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +20 -480
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +5 -41
- data/rbi/telnyx/models/fax.rbi +12 -8
- data/rbi/telnyx/models/fax_create_params.rbi +12 -8
- data/rbi/telnyx/models/fax_delivered.rbi +6 -4
- data/rbi/telnyx/models/fax_failed.rbi +6 -4
- data/rbi/telnyx/models/fax_media_processed.rbi +6 -4
- data/rbi/telnyx/models/fax_queued.rbi +6 -4
- data/rbi/telnyx/models/fax_sending_started.rbi +6 -4
- data/rbi/telnyx/models/model_metadata.rbi +272 -0
- data/rbi/telnyx/models/network_list_interfaces_response.rbi +181 -4
- data/rbi/telnyx/models/public_internet_gateway_create_response.rbi +6 -38
- data/rbi/telnyx/models/public_internet_gateway_delete_response.rbi +6 -38
- data/rbi/telnyx/models/public_internet_gateway_read.rbi +128 -0
- data/rbi/telnyx/models/public_internet_gateway_retrieve_response.rbi +6 -38
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +81 -9
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +27 -3
- data/rbi/telnyx/models/text_to_speech_generate_params.rbi +6 -6
- data/rbi/telnyx/models/uac_connection.rbi +684 -0
- data/rbi/telnyx/models/uac_connection_create_params.rbi +12 -516
- data/rbi/telnyx/models/uac_connection_create_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_delete_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_update_params.rbi +12 -516
- data/rbi/telnyx/models/uac_connection_update_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_external_settings.rbi +146 -0
- data/rbi/telnyx/models/uac_inbound.rbi +410 -0
- data/rbi/telnyx/models/uac_internal_settings.rbi +39 -0
- data/rbi/telnyx/models/uac_outbound.rbi +224 -0
- data/rbi/telnyx/models/virtual_cross_connect_combined.rbi +345 -0
- data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi +6 -36
- data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi +6 -36
- data/rbi/telnyx/models/virtual_cross_connect_retrieve_response.rbi +6 -38
- data/rbi/telnyx/models/virtual_cross_connect_update_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_create_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_delete_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_read.rbi +213 -0
- data/rbi/telnyx/models/wireguard_interface_retrieve_response.rbi +6 -36
- data/rbi/telnyx/models/xai_voice_settings.rbi +64 -0
- data/rbi/telnyx/models.rbi +20 -0
- data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +2 -4
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -9
- data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
- data/rbi/telnyx/resources/ai/openai.rbi +1 -1
- data/rbi/telnyx/resources/ai.rbi +2 -2
- data/rbi/telnyx/resources/calls/actions.rbi +24 -24
- data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
- data/rbi/telnyx/resources/faxes.rbi +18 -4
- data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
- data/rbi/telnyx/resources/texml.rbi +7 -1
- data/rbi/telnyx/resources/uac_connections.rbi +7 -13
- 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 +18 -149
- data/sig/telnyx/models/ai/assistant_integration.rbs +26 -0
- data/sig/telnyx/models/ai/assistant_mcp_server.rbs +19 -0
- data/sig/telnyx/models/ai/assistant_tool.rbs +8 -8
- data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -149
- data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +6 -113
- data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +4 -109
- data/sig/telnyx/models/ai/assistants/clause.rbs +46 -0
- data/sig/telnyx/models/ai/assistants/rollout_slot.rbs +19 -0
- data/sig/telnyx/models/ai/assistants/rule_input.rbs +33 -0
- data/sig/telnyx/models/ai/assistants/rule_output.rbs +33 -0
- data/sig/telnyx/models/ai/assistants/serve.rbs +35 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -152
- data/sig/telnyx/models/ai/inference_embedding.rbs +18 -149
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +40 -0
- data/sig/telnyx/models/ai/openai_create_response_params.rbs +5 -5
- data/sig/telnyx/models/ai/openai_list_models_response.rbs +4 -149
- data/sig/telnyx/models/ai/start_speaking_plan.rbs +33 -0
- data/sig/telnyx/models/ai/transcription_endpointing_plan.rbs +38 -0
- data/sig/telnyx/models/ai/transfer_tool.rbs +4 -4
- data/sig/telnyx/models/ai_create_response_params.rbs +5 -4
- data/sig/telnyx/models/ai_retrieve_models_response.rbs +4 -149
- data/sig/telnyx/models/call_conversation_ended.rbs +5 -0
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_speak_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +141 -102
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +62 -0
- data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +114 -0
- data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +130 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +13 -185
- data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -15
- data/sig/telnyx/models/model_metadata.rbs +142 -0
- data/sig/telnyx/models/network_list_interfaces_response.rbs +106 -4
- data/sig/telnyx/models/public_internet_gateway_create_response.rbs +6 -18
- data/sig/telnyx/models/public_internet_gateway_delete_response.rbs +6 -18
- data/sig/telnyx/models/public_internet_gateway_read.rbs +80 -0
- data/sig/telnyx/models/public_internet_gateway_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +27 -3
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +9 -1
- data/sig/telnyx/models/text_to_speech_generate_params.rbs +6 -6
- data/sig/telnyx/models/uac_connection.rbs +338 -0
- data/sig/telnyx/models/uac_connection_create_params.rbs +17 -211
- data/sig/telnyx/models/uac_connection_create_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_delete_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_retrieve_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_update_params.rbs +17 -211
- data/sig/telnyx/models/uac_connection_update_response.rbs +5 -731
- data/sig/telnyx/models/uac_external_settings.rbs +73 -0
- data/sig/telnyx/models/uac_inbound.rbs +190 -0
- data/sig/telnyx/models/uac_internal_settings.rbs +15 -0
- data/sig/telnyx/models/uac_outbound.rbs +113 -0
- data/sig/telnyx/models/virtual_cross_connect_combined.rbs +190 -0
- data/sig/telnyx/models/virtual_cross_connect_create_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_delete_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_update_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_create_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_delete_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_read.rbs +127 -0
- data/sig/telnyx/models/wireguard_interface_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/xai_voice_settings.rbs +34 -0
- data/sig/telnyx/models.rbs +20 -0
- 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/ai/openai.rbs +1 -1
- data/sig/telnyx/resources/ai.rbs +1 -1
- data/sig/telnyx/resources/calls/actions.rbs +2 -4
- data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
- data/sig/telnyx/resources/texml.rbs +1 -0
- 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 +71 -14
- data/lib/telnyx/models/public_internet_gateway_list_response.rb +0 -10
- data/lib/telnyx/models/uac_connection_list_response.rb +0 -876
- data/lib/telnyx/models/virtual_cross_connect_list_response.rb +0 -10
- data/lib/telnyx/models/wireguard_interface_list_response.rb +0 -10
- data/rbi/telnyx/models/public_internet_gateway_list_response.rbi +0 -23
- data/rbi/telnyx/models/uac_connection_list_response.rbi +0 -1727
- data/rbi/telnyx/models/virtual_cross_connect_list_response.rbi +0 -23
- data/rbi/telnyx/models/wireguard_interface_list_response.rbi +0 -23
- data/sig/telnyx/models/public_internet_gateway_list_response.rbs +0 -11
- data/sig/telnyx/models/uac_connection_list_response.rbs +0 -722
- data/sig/telnyx/models/virtual_cross_connect_list_response.rbs +0 -11
- data/sig/telnyx/models/wireguard_interface_list_response.rbs +0 -11
|
@@ -7,8 +7,8 @@ module Telnyx
|
|
|
7
7
|
class OpenAIListModelsResponse < Telnyx::Internal::Type::BaseModel
|
|
8
8
|
# @!attribute data
|
|
9
9
|
#
|
|
10
|
-
# @return [Array<Telnyx::Models::
|
|
11
|
-
required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::
|
|
10
|
+
# @return [Array<Telnyx::Models::ModelMetadata>]
|
|
11
|
+
required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::ModelMetadata] }
|
|
12
12
|
|
|
13
13
|
# @!attribute object
|
|
14
14
|
#
|
|
@@ -16,215 +16,8 @@ module Telnyx
|
|
|
16
16
|
optional :object, String
|
|
17
17
|
|
|
18
18
|
# @!method initialize(data:, object: nil)
|
|
19
|
-
# @param data [Array<Telnyx::Models::
|
|
19
|
+
# @param data [Array<Telnyx::Models::ModelMetadata>]
|
|
20
20
|
# @param object [String]
|
|
21
|
-
|
|
22
|
-
class Data < Telnyx::Internal::Type::BaseModel
|
|
23
|
-
# @!attribute id
|
|
24
|
-
# Model identifier. For open-source models, follows the
|
|
25
|
-
# `{organization}/{model_name}` convention from Hugging Face (e.g.
|
|
26
|
-
# `moonshotai/Kimi-K2.6`).
|
|
27
|
-
#
|
|
28
|
-
# @return [String]
|
|
29
|
-
required :id, String
|
|
30
|
-
|
|
31
|
-
# @!attribute context_length
|
|
32
|
-
# Maximum total tokens (prompt + completion) supported by the model in a single
|
|
33
|
-
# request.
|
|
34
|
-
#
|
|
35
|
-
# @return [Integer]
|
|
36
|
-
required :context_length, Integer
|
|
37
|
-
|
|
38
|
-
# @!attribute created
|
|
39
|
-
# Timestamp at which the model was registered on Telnyx Inference (ISO 8601).
|
|
40
|
-
#
|
|
41
|
-
# @return [Time]
|
|
42
|
-
required :created, Time
|
|
43
|
-
|
|
44
|
-
# @!attribute languages
|
|
45
|
-
# ISO language codes the model supports (e.g. `en`, `es`).
|
|
46
|
-
#
|
|
47
|
-
# @return [Array<String>]
|
|
48
|
-
required :languages, Telnyx::Internal::Type::ArrayOf[String]
|
|
49
|
-
|
|
50
|
-
# @!attribute license
|
|
51
|
-
# License the model is distributed under, e.g. `Apache 2.0`, `MIT`,
|
|
52
|
-
# `Llama 3 Community License`.
|
|
53
|
-
#
|
|
54
|
-
# @return [String]
|
|
55
|
-
required :license, String
|
|
56
|
-
|
|
57
|
-
# @!attribute organization
|
|
58
|
-
# Organization that originally published the model, matching the prefix of `id`
|
|
59
|
-
# for open-source models.
|
|
60
|
-
#
|
|
61
|
-
# @return [String]
|
|
62
|
-
required :organization, String
|
|
63
|
-
|
|
64
|
-
# @!attribute owned_by
|
|
65
|
-
# Owner of the model. `Telnyx` for Telnyx-hosted open-source models, the upstream
|
|
66
|
-
# provider name for proxied models, or the Telnyx organization id for fine-tuned
|
|
67
|
-
# models.
|
|
68
|
-
#
|
|
69
|
-
# @return [String]
|
|
70
|
-
required :owned_by, String
|
|
71
|
-
|
|
72
|
-
# @!attribute parameters
|
|
73
|
-
# Total parameter count of the model.
|
|
74
|
-
#
|
|
75
|
-
# @return [Integer]
|
|
76
|
-
required :parameters, Integer
|
|
77
|
-
|
|
78
|
-
# @!attribute tier
|
|
79
|
-
# Billing tier the model belongs to. Used together with `pricing` to determine
|
|
80
|
-
# cost per 1M tokens.
|
|
81
|
-
#
|
|
82
|
-
# @return [Symbol, Telnyx::Models::AI::OpenAIListModelsResponse::Data::Tier]
|
|
83
|
-
required :tier, enum: -> { Telnyx::Models::AI::OpenAIListModelsResponse::Data::Tier }
|
|
84
|
-
|
|
85
|
-
# @!attribute base_model
|
|
86
|
-
# Base model the fine-tuned model was trained from. Only set for fine-tuned
|
|
87
|
-
# models.
|
|
88
|
-
#
|
|
89
|
-
# @return [String, nil]
|
|
90
|
-
optional :base_model, String, nil?: true
|
|
91
|
-
|
|
92
|
-
# @!attribute description
|
|
93
|
-
# Short, human-readable summary of what the model is best suited for.
|
|
94
|
-
#
|
|
95
|
-
# @return [String, nil]
|
|
96
|
-
optional :description, String, nil?: true
|
|
97
|
-
|
|
98
|
-
# @!attribute is_fine_tunable
|
|
99
|
-
# Whether the model can be used as a base for a fine-tuning job via
|
|
100
|
-
# `POST /v2/ai/fine_tuning/jobs`.
|
|
101
|
-
#
|
|
102
|
-
# @return [Boolean, nil]
|
|
103
|
-
optional :is_fine_tunable, Telnyx::Internal::Type::Boolean
|
|
104
|
-
|
|
105
|
-
# @!attribute is_vision_supported
|
|
106
|
-
# Whether the model accepts image inputs in chat completions (multimodal vision
|
|
107
|
-
# support).
|
|
108
|
-
#
|
|
109
|
-
# @return [Boolean, nil]
|
|
110
|
-
optional :is_vision_supported, Telnyx::Internal::Type::Boolean
|
|
111
|
-
|
|
112
|
-
# @!attribute max_completion_tokens
|
|
113
|
-
# Maximum number of completion (output) tokens the model will generate per
|
|
114
|
-
# request. `null` if unconstrained beyond `context_length`.
|
|
115
|
-
#
|
|
116
|
-
# @return [Integer, nil]
|
|
117
|
-
optional :max_completion_tokens, Integer, nil?: true
|
|
118
|
-
|
|
119
|
-
# @!attribute object
|
|
120
|
-
# Object type. Always `model`.
|
|
121
|
-
#
|
|
122
|
-
# @return [String, nil]
|
|
123
|
-
optional :object, String
|
|
124
|
-
|
|
125
|
-
# @!attribute parameters_str
|
|
126
|
-
# Human-readable parameter count, e.g. `1.0T`, `753.9B`, `8B`.
|
|
127
|
-
#
|
|
128
|
-
# @return [String, nil]
|
|
129
|
-
optional :parameters_str, String, nil?: true
|
|
130
|
-
|
|
131
|
-
# @!attribute pricing
|
|
132
|
-
# Mapping of token kind to price, as strings to preserve precision. Typical keys
|
|
133
|
-
# are `prompt`, `cached_prompt`, and `completion`. When pricing is available the
|
|
134
|
-
# block also includes `currency` (ISO 4217 code matching the account's configured
|
|
135
|
-
# billing currency) and `unit` (the denomination the prices are quoted in,
|
|
136
|
-
# currently always `1M_tokens` for token-priced models).
|
|
137
|
-
#
|
|
138
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
139
|
-
optional :pricing, Telnyx::Internal::Type::HashOf[String]
|
|
140
|
-
|
|
141
|
-
# @!attribute recommended_for_assistants
|
|
142
|
-
# Whether Telnyx currently recommends this model as the LLM powering a Telnyx AI
|
|
143
|
-
# Assistant.
|
|
144
|
-
#
|
|
145
|
-
# @return [Boolean, nil]
|
|
146
|
-
optional :recommended_for_assistants, Telnyx::Internal::Type::Boolean
|
|
147
|
-
|
|
148
|
-
# @!attribute regions
|
|
149
|
-
# Public region names where the model is currently deployed (e.g. `us-central-1`,
|
|
150
|
-
# `eu-central-1`).
|
|
151
|
-
#
|
|
152
|
-
# @return [Array<String>, nil]
|
|
153
|
-
optional :regions, Telnyx::Internal::Type::ArrayOf[String]
|
|
154
|
-
|
|
155
|
-
# @!attribute task
|
|
156
|
-
# Primary task the model is intended for, e.g. `text-generation`,
|
|
157
|
-
# `audio-text-to-text`, `feature-extraction` (embeddings).
|
|
158
|
-
#
|
|
159
|
-
# @return [String, nil]
|
|
160
|
-
optional :task, String
|
|
161
|
-
|
|
162
|
-
# @!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)
|
|
163
|
-
# Some parameter documentations has been truncated, see
|
|
164
|
-
# {Telnyx::Models::AI::OpenAIListModelsResponse::Data} for more details.
|
|
165
|
-
#
|
|
166
|
-
# Metadata for a model available on Telnyx Inference. Returned by
|
|
167
|
-
# `GET /v2/ai/openai/models` (and the deprecated `GET /v2/ai/models`). Open-source
|
|
168
|
-
# models live under their Hugging Face organization (e.g. `moonshotai/Kimi-K2.6`,
|
|
169
|
-
# `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M2.7`); fine-tuned models are owned by
|
|
170
|
-
# the Telnyx organization that trained them.
|
|
171
|
-
#
|
|
172
|
-
# @param id [String] Model identifier. For open-source models, follows the `{organization}/{model_nam
|
|
173
|
-
#
|
|
174
|
-
# @param context_length [Integer] Maximum total tokens (prompt + completion) supported by the model in a single re
|
|
175
|
-
#
|
|
176
|
-
# @param created [Time] Timestamp at which the model was registered on Telnyx Inference (ISO 8601).
|
|
177
|
-
#
|
|
178
|
-
# @param languages [Array<String>] ISO language codes the model supports (e.g. `en`, `es`).
|
|
179
|
-
#
|
|
180
|
-
# @param license [String] License the model is distributed under, e.g. `Apache 2.0`, `MIT`, `Llama 3 Commu
|
|
181
|
-
#
|
|
182
|
-
# @param organization [String] Organization that originally published the model, matching the prefix of `id` fo
|
|
183
|
-
#
|
|
184
|
-
# @param owned_by [String] Owner of the model. `Telnyx` for Telnyx-hosted open-source models, the upstream
|
|
185
|
-
#
|
|
186
|
-
# @param parameters [Integer] Total parameter count of the model.
|
|
187
|
-
#
|
|
188
|
-
# @param tier [Symbol, Telnyx::Models::AI::OpenAIListModelsResponse::Data::Tier] Billing tier the model belongs to. Used together with `pricing` to determine cos
|
|
189
|
-
#
|
|
190
|
-
# @param base_model [String, nil] Base model the fine-tuned model was trained from. Only set for fine-tuned models
|
|
191
|
-
#
|
|
192
|
-
# @param description [String, nil] Short, human-readable summary of what the model is best suited for.
|
|
193
|
-
#
|
|
194
|
-
# @param is_fine_tunable [Boolean] Whether the model can be used as a base for a fine-tuning job via `POST /v2/ai/f
|
|
195
|
-
#
|
|
196
|
-
# @param is_vision_supported [Boolean] Whether the model accepts image inputs in chat completions (multimodal vision su
|
|
197
|
-
#
|
|
198
|
-
# @param max_completion_tokens [Integer, nil] Maximum number of completion (output) tokens the model will generate per request
|
|
199
|
-
#
|
|
200
|
-
# @param object [String] Object type. Always `model`.
|
|
201
|
-
#
|
|
202
|
-
# @param parameters_str [String, nil] Human-readable parameter count, e.g. `1.0T`, `753.9B`, `8B`.
|
|
203
|
-
#
|
|
204
|
-
# @param pricing [Hash{Symbol=>String}] Mapping of token kind to price, as strings to preserve precision. Typical keys a
|
|
205
|
-
#
|
|
206
|
-
# @param recommended_for_assistants [Boolean] Whether Telnyx currently recommends this model as the LLM powering a Telnyx AI A
|
|
207
|
-
#
|
|
208
|
-
# @param regions [Array<String>] Public region names where the model is currently deployed (e.g. `us-central-1`,
|
|
209
|
-
#
|
|
210
|
-
# @param task [String] Primary task the model is intended for, e.g. `text-generation`, `audio-text-to-t
|
|
211
|
-
|
|
212
|
-
# Billing tier the model belongs to. Used together with `pricing` to determine
|
|
213
|
-
# cost per 1M tokens.
|
|
214
|
-
#
|
|
215
|
-
# @see Telnyx::Models::AI::OpenAIListModelsResponse::Data#tier
|
|
216
|
-
module Tier
|
|
217
|
-
extend Telnyx::Internal::Type::Enum
|
|
218
|
-
|
|
219
|
-
SMALL = :small
|
|
220
|
-
MEDIUM = :medium
|
|
221
|
-
LARGE = :large
|
|
222
|
-
UNLISTED = :unlisted
|
|
223
|
-
|
|
224
|
-
# @!method self.values
|
|
225
|
-
# @return [Array<Symbol>]
|
|
226
|
-
end
|
|
227
|
-
end
|
|
228
21
|
end
|
|
229
22
|
end
|
|
230
23
|
end
|
|
@@ -0,0 +1,37 @@
|
|
|
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
|
|
@@ -0,0 +1,39 @@
|
|
|
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
|
|
@@ -32,7 +32,7 @@ module Telnyx
|
|
|
32
32
|
# variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
33
33
|
# variables webhook and resolves to an array of target objects at runtime.
|
|
34
34
|
#
|
|
35
|
-
# @return [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::
|
|
35
|
+
# @return [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsList>, String]
|
|
36
36
|
required :targets, union: -> { Telnyx::AI::TransferTool::Transfer::Targets }
|
|
37
37
|
|
|
38
38
|
# @!method initialize(from:, targets:)
|
|
@@ -41,7 +41,7 @@ module Telnyx
|
|
|
41
41
|
#
|
|
42
42
|
# @param from [String] Number or SIP URI placing the call.
|
|
43
43
|
#
|
|
44
|
-
# @param targets [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::
|
|
44
|
+
# @param targets [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsList>, String] The different possible targets of the transfer. The assistant will be able to ch
|
|
45
45
|
|
|
46
46
|
# The different possible targets of the transfer. The assistant will be able to
|
|
47
47
|
# choose one of the targets to transfer the call to. This can also be a dynamic
|
|
@@ -52,12 +52,12 @@ module Telnyx
|
|
|
52
52
|
module Targets
|
|
53
53
|
extend Telnyx::Internal::Type::Union
|
|
54
54
|
|
|
55
|
-
variant -> { Telnyx::Models::AI::TransferTool::Transfer::Targets::
|
|
55
|
+
variant -> { Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsListArray }
|
|
56
56
|
|
|
57
57
|
# A dynamic variable string like `{{ targets }}` where `targets` is returned by the dynamic variables webhook and resolves to an array of target objects at runtime.
|
|
58
58
|
variant String
|
|
59
59
|
|
|
60
|
-
class
|
|
60
|
+
class TargetsList < Telnyx::Internal::Type::BaseModel
|
|
61
61
|
# @!attribute to
|
|
62
62
|
# The destination number or SIP URI of the call.
|
|
63
63
|
#
|
|
@@ -77,13 +77,11 @@ module Telnyx
|
|
|
77
77
|
end
|
|
78
78
|
|
|
79
79
|
# @!method self.variants
|
|
80
|
-
# @return [Array(Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::
|
|
80
|
+
# @return [Array(Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsList>, String)]
|
|
81
81
|
|
|
82
82
|
# @type [Telnyx::Internal::Type::Converter]
|
|
83
|
-
|
|
84
|
-
Telnyx::Internal::Type::ArrayOf[-> {
|
|
85
|
-
Telnyx::AI::TransferTool::Transfer::Targets::UnionMember0
|
|
86
|
-
}]
|
|
83
|
+
TargetsListArray =
|
|
84
|
+
Telnyx::Internal::Type::ArrayOf[-> { Telnyx::AI::TransferTool::Transfer::Targets::TargetsList }]
|
|
87
85
|
end
|
|
88
86
|
end
|
|
89
87
|
|
|
@@ -7,13 +7,13 @@ module Telnyx
|
|
|
7
7
|
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Telnyx::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute
|
|
10
|
+
# @!attribute params
|
|
11
11
|
#
|
|
12
12
|
# @return [Hash{Symbol=>Object}]
|
|
13
|
-
required :
|
|
13
|
+
required :params, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
14
14
|
|
|
15
|
-
# @!method initialize(
|
|
16
|
-
# @param
|
|
15
|
+
# @!method initialize(params:, request_options: {})
|
|
16
|
+
# @param params [Hash{Symbol=>Object}]
|
|
17
17
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
18
18
|
end
|
|
19
19
|
end
|
|
@@ -6,8 +6,8 @@ module Telnyx
|
|
|
6
6
|
class AIRetrieveModelsResponse < Telnyx::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
8
|
#
|
|
9
|
-
# @return [Array<Telnyx::Models::
|
|
10
|
-
required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::
|
|
9
|
+
# @return [Array<Telnyx::Models::ModelMetadata>]
|
|
10
|
+
required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::ModelMetadata] }
|
|
11
11
|
|
|
12
12
|
# @!attribute object
|
|
13
13
|
#
|
|
@@ -15,215 +15,8 @@ module Telnyx
|
|
|
15
15
|
optional :object, String
|
|
16
16
|
|
|
17
17
|
# @!method initialize(data:, object: nil)
|
|
18
|
-
# @param data [Array<Telnyx::Models::
|
|
18
|
+
# @param data [Array<Telnyx::Models::ModelMetadata>]
|
|
19
19
|
# @param object [String]
|
|
20
|
-
|
|
21
|
-
class Data < Telnyx::Internal::Type::BaseModel
|
|
22
|
-
# @!attribute id
|
|
23
|
-
# Model identifier. For open-source models, follows the
|
|
24
|
-
# `{organization}/{model_name}` convention from Hugging Face (e.g.
|
|
25
|
-
# `moonshotai/Kimi-K2.6`).
|
|
26
|
-
#
|
|
27
|
-
# @return [String]
|
|
28
|
-
required :id, String
|
|
29
|
-
|
|
30
|
-
# @!attribute context_length
|
|
31
|
-
# Maximum total tokens (prompt + completion) supported by the model in a single
|
|
32
|
-
# request.
|
|
33
|
-
#
|
|
34
|
-
# @return [Integer]
|
|
35
|
-
required :context_length, Integer
|
|
36
|
-
|
|
37
|
-
# @!attribute created
|
|
38
|
-
# Timestamp at which the model was registered on Telnyx Inference (ISO 8601).
|
|
39
|
-
#
|
|
40
|
-
# @return [Time]
|
|
41
|
-
required :created, Time
|
|
42
|
-
|
|
43
|
-
# @!attribute languages
|
|
44
|
-
# ISO language codes the model supports (e.g. `en`, `es`).
|
|
45
|
-
#
|
|
46
|
-
# @return [Array<String>]
|
|
47
|
-
required :languages, Telnyx::Internal::Type::ArrayOf[String]
|
|
48
|
-
|
|
49
|
-
# @!attribute license
|
|
50
|
-
# License the model is distributed under, e.g. `Apache 2.0`, `MIT`,
|
|
51
|
-
# `Llama 3 Community License`.
|
|
52
|
-
#
|
|
53
|
-
# @return [String]
|
|
54
|
-
required :license, String
|
|
55
|
-
|
|
56
|
-
# @!attribute organization
|
|
57
|
-
# Organization that originally published the model, matching the prefix of `id`
|
|
58
|
-
# for open-source models.
|
|
59
|
-
#
|
|
60
|
-
# @return [String]
|
|
61
|
-
required :organization, String
|
|
62
|
-
|
|
63
|
-
# @!attribute owned_by
|
|
64
|
-
# Owner of the model. `Telnyx` for Telnyx-hosted open-source models, the upstream
|
|
65
|
-
# provider name for proxied models, or the Telnyx organization id for fine-tuned
|
|
66
|
-
# models.
|
|
67
|
-
#
|
|
68
|
-
# @return [String]
|
|
69
|
-
required :owned_by, String
|
|
70
|
-
|
|
71
|
-
# @!attribute parameters
|
|
72
|
-
# Total parameter count of the model.
|
|
73
|
-
#
|
|
74
|
-
# @return [Integer]
|
|
75
|
-
required :parameters, Integer
|
|
76
|
-
|
|
77
|
-
# @!attribute tier
|
|
78
|
-
# Billing tier the model belongs to. Used together with `pricing` to determine
|
|
79
|
-
# cost per 1M tokens.
|
|
80
|
-
#
|
|
81
|
-
# @return [Symbol, Telnyx::Models::AIRetrieveModelsResponse::Data::Tier]
|
|
82
|
-
required :tier, enum: -> { Telnyx::Models::AIRetrieveModelsResponse::Data::Tier }
|
|
83
|
-
|
|
84
|
-
# @!attribute base_model
|
|
85
|
-
# Base model the fine-tuned model was trained from. Only set for fine-tuned
|
|
86
|
-
# models.
|
|
87
|
-
#
|
|
88
|
-
# @return [String, nil]
|
|
89
|
-
optional :base_model, String, nil?: true
|
|
90
|
-
|
|
91
|
-
# @!attribute description
|
|
92
|
-
# Short, human-readable summary of what the model is best suited for.
|
|
93
|
-
#
|
|
94
|
-
# @return [String, nil]
|
|
95
|
-
optional :description, String, nil?: true
|
|
96
|
-
|
|
97
|
-
# @!attribute is_fine_tunable
|
|
98
|
-
# Whether the model can be used as a base for a fine-tuning job via
|
|
99
|
-
# `POST /v2/ai/fine_tuning/jobs`.
|
|
100
|
-
#
|
|
101
|
-
# @return [Boolean, nil]
|
|
102
|
-
optional :is_fine_tunable, Telnyx::Internal::Type::Boolean
|
|
103
|
-
|
|
104
|
-
# @!attribute is_vision_supported
|
|
105
|
-
# Whether the model accepts image inputs in chat completions (multimodal vision
|
|
106
|
-
# support).
|
|
107
|
-
#
|
|
108
|
-
# @return [Boolean, nil]
|
|
109
|
-
optional :is_vision_supported, Telnyx::Internal::Type::Boolean
|
|
110
|
-
|
|
111
|
-
# @!attribute max_completion_tokens
|
|
112
|
-
# Maximum number of completion (output) tokens the model will generate per
|
|
113
|
-
# request. `null` if unconstrained beyond `context_length`.
|
|
114
|
-
#
|
|
115
|
-
# @return [Integer, nil]
|
|
116
|
-
optional :max_completion_tokens, Integer, nil?: true
|
|
117
|
-
|
|
118
|
-
# @!attribute object
|
|
119
|
-
# Object type. Always `model`.
|
|
120
|
-
#
|
|
121
|
-
# @return [String, nil]
|
|
122
|
-
optional :object, String
|
|
123
|
-
|
|
124
|
-
# @!attribute parameters_str
|
|
125
|
-
# Human-readable parameter count, e.g. `1.0T`, `753.9B`, `8B`.
|
|
126
|
-
#
|
|
127
|
-
# @return [String, nil]
|
|
128
|
-
optional :parameters_str, String, nil?: true
|
|
129
|
-
|
|
130
|
-
# @!attribute pricing
|
|
131
|
-
# Mapping of token kind to price, as strings to preserve precision. Typical keys
|
|
132
|
-
# are `prompt`, `cached_prompt`, and `completion`. When pricing is available the
|
|
133
|
-
# block also includes `currency` (ISO 4217 code matching the account's configured
|
|
134
|
-
# billing currency) and `unit` (the denomination the prices are quoted in,
|
|
135
|
-
# currently always `1M_tokens` for token-priced models).
|
|
136
|
-
#
|
|
137
|
-
# @return [Hash{Symbol=>String}, nil]
|
|
138
|
-
optional :pricing, Telnyx::Internal::Type::HashOf[String]
|
|
139
|
-
|
|
140
|
-
# @!attribute recommended_for_assistants
|
|
141
|
-
# Whether Telnyx currently recommends this model as the LLM powering a Telnyx AI
|
|
142
|
-
# Assistant.
|
|
143
|
-
#
|
|
144
|
-
# @return [Boolean, nil]
|
|
145
|
-
optional :recommended_for_assistants, Telnyx::Internal::Type::Boolean
|
|
146
|
-
|
|
147
|
-
# @!attribute regions
|
|
148
|
-
# Public region names where the model is currently deployed (e.g. `us-central-1`,
|
|
149
|
-
# `eu-central-1`).
|
|
150
|
-
#
|
|
151
|
-
# @return [Array<String>, nil]
|
|
152
|
-
optional :regions, Telnyx::Internal::Type::ArrayOf[String]
|
|
153
|
-
|
|
154
|
-
# @!attribute task
|
|
155
|
-
# Primary task the model is intended for, e.g. `text-generation`,
|
|
156
|
-
# `audio-text-to-text`, `feature-extraction` (embeddings).
|
|
157
|
-
#
|
|
158
|
-
# @return [String, nil]
|
|
159
|
-
optional :task, String
|
|
160
|
-
|
|
161
|
-
# @!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)
|
|
162
|
-
# Some parameter documentations has been truncated, see
|
|
163
|
-
# {Telnyx::Models::AIRetrieveModelsResponse::Data} for more details.
|
|
164
|
-
#
|
|
165
|
-
# Metadata for a model available on Telnyx Inference. Returned by
|
|
166
|
-
# `GET /v2/ai/openai/models` (and the deprecated `GET /v2/ai/models`). Open-source
|
|
167
|
-
# models live under their Hugging Face organization (e.g. `moonshotai/Kimi-K2.6`,
|
|
168
|
-
# `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M2.7`); fine-tuned models are owned by
|
|
169
|
-
# the Telnyx organization that trained them.
|
|
170
|
-
#
|
|
171
|
-
# @param id [String] Model identifier. For open-source models, follows the `{organization}/{model_nam
|
|
172
|
-
#
|
|
173
|
-
# @param context_length [Integer] Maximum total tokens (prompt + completion) supported by the model in a single re
|
|
174
|
-
#
|
|
175
|
-
# @param created [Time] Timestamp at which the model was registered on Telnyx Inference (ISO 8601).
|
|
176
|
-
#
|
|
177
|
-
# @param languages [Array<String>] ISO language codes the model supports (e.g. `en`, `es`).
|
|
178
|
-
#
|
|
179
|
-
# @param license [String] License the model is distributed under, e.g. `Apache 2.0`, `MIT`, `Llama 3 Commu
|
|
180
|
-
#
|
|
181
|
-
# @param organization [String] Organization that originally published the model, matching the prefix of `id` fo
|
|
182
|
-
#
|
|
183
|
-
# @param owned_by [String] Owner of the model. `Telnyx` for Telnyx-hosted open-source models, the upstream
|
|
184
|
-
#
|
|
185
|
-
# @param parameters [Integer] Total parameter count of the model.
|
|
186
|
-
#
|
|
187
|
-
# @param tier [Symbol, Telnyx::Models::AIRetrieveModelsResponse::Data::Tier] Billing tier the model belongs to. Used together with `pricing` to determine cos
|
|
188
|
-
#
|
|
189
|
-
# @param base_model [String, nil] Base model the fine-tuned model was trained from. Only set for fine-tuned models
|
|
190
|
-
#
|
|
191
|
-
# @param description [String, nil] Short, human-readable summary of what the model is best suited for.
|
|
192
|
-
#
|
|
193
|
-
# @param is_fine_tunable [Boolean] Whether the model can be used as a base for a fine-tuning job via `POST /v2/ai/f
|
|
194
|
-
#
|
|
195
|
-
# @param is_vision_supported [Boolean] Whether the model accepts image inputs in chat completions (multimodal vision su
|
|
196
|
-
#
|
|
197
|
-
# @param max_completion_tokens [Integer, nil] Maximum number of completion (output) tokens the model will generate per request
|
|
198
|
-
#
|
|
199
|
-
# @param object [String] Object type. Always `model`.
|
|
200
|
-
#
|
|
201
|
-
# @param parameters_str [String, nil] Human-readable parameter count, e.g. `1.0T`, `753.9B`, `8B`.
|
|
202
|
-
#
|
|
203
|
-
# @param pricing [Hash{Symbol=>String}] Mapping of token kind to price, as strings to preserve precision. Typical keys a
|
|
204
|
-
#
|
|
205
|
-
# @param recommended_for_assistants [Boolean] Whether Telnyx currently recommends this model as the LLM powering a Telnyx AI A
|
|
206
|
-
#
|
|
207
|
-
# @param regions [Array<String>] Public region names where the model is currently deployed (e.g. `us-central-1`,
|
|
208
|
-
#
|
|
209
|
-
# @param task [String] Primary task the model is intended for, e.g. `text-generation`, `audio-text-to-t
|
|
210
|
-
|
|
211
|
-
# Billing tier the model belongs to. Used together with `pricing` to determine
|
|
212
|
-
# cost per 1M tokens.
|
|
213
|
-
#
|
|
214
|
-
# @see Telnyx::Models::AIRetrieveModelsResponse::Data#tier
|
|
215
|
-
module Tier
|
|
216
|
-
extend Telnyx::Internal::Type::Enum
|
|
217
|
-
|
|
218
|
-
SMALL = :small
|
|
219
|
-
MEDIUM = :medium
|
|
220
|
-
LARGE = :large
|
|
221
|
-
UNLISTED = :unlisted
|
|
222
|
-
|
|
223
|
-
# @!method self.values
|
|
224
|
-
# @return [Array<Symbol>]
|
|
225
|
-
end
|
|
226
|
-
end
|
|
227
20
|
end
|
|
228
21
|
end
|
|
229
22
|
end
|
|
@@ -131,6 +131,13 @@ module Telnyx
|
|
|
131
131
|
# @return [String, nil]
|
|
132
132
|
optional :llm_model, String
|
|
133
133
|
|
|
134
|
+
# @!attribute reason
|
|
135
|
+
# Reason the conversation ended. For Conversation Relay, `customer_disconnect`
|
|
136
|
+
# indicates that the customer WebSocket disconnected.
|
|
137
|
+
#
|
|
138
|
+
# @return [String, nil]
|
|
139
|
+
optional :reason, String, nil?: true
|
|
140
|
+
|
|
134
141
|
# @!attribute stt_model
|
|
135
142
|
# The speech-to-text model used in the conversation.
|
|
136
143
|
#
|
|
@@ -161,7 +168,10 @@ module Telnyx
|
|
|
161
168
|
# @return [String, nil]
|
|
162
169
|
optional :tts_voice_id, String
|
|
163
170
|
|
|
164
|
-
# @!method initialize(assistant_id: nil, call_control_id: nil, call_leg_id: nil, call_session_id: nil, calling_party_type: nil, client_state: nil, connection_id: nil, conversation_id: nil, duration_sec: nil, from: nil, llm_model: nil, stt_model: nil, to: nil, tts_model_id: nil, tts_provider: nil, tts_voice_id: nil)
|
|
171
|
+
# @!method initialize(assistant_id: nil, call_control_id: nil, call_leg_id: nil, call_session_id: nil, calling_party_type: nil, client_state: nil, connection_id: nil, conversation_id: nil, duration_sec: nil, from: nil, llm_model: nil, reason: nil, stt_model: nil, to: nil, tts_model_id: nil, tts_provider: nil, tts_voice_id: nil)
|
|
172
|
+
# Some parameter documentations has been truncated, see
|
|
173
|
+
# {Telnyx::Models::CallConversationEnded::Payload} for more details.
|
|
174
|
+
#
|
|
165
175
|
# @param assistant_id [String] Unique identifier of the assistant involved in the call.
|
|
166
176
|
#
|
|
167
177
|
# @param call_control_id [String] Call ID used to issue commands via Call Control API.
|
|
@@ -184,6 +194,8 @@ module Telnyx
|
|
|
184
194
|
#
|
|
185
195
|
# @param llm_model [String] The large language model used during the conversation.
|
|
186
196
|
#
|
|
197
|
+
# @param reason [String, nil] Reason the conversation ended. For Conversation Relay, `customer_disconnect` ind
|
|
198
|
+
#
|
|
187
199
|
# @param stt_model [String] The speech-to-text model used in the conversation.
|
|
188
200
|
#
|
|
189
201
|
# @param to [String] The callee's number or SIP address.
|