telnyx 5.168.0 → 5.170.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 +14 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +40 -0
- data/lib/telnyx/internal/email_cursor_pagination.rb +2 -2
- data/lib/telnyx/internal/type/union.rb +6 -6
- data/lib/telnyx/models/ai/assistant_create_params.rb +9 -9
- data/lib/telnyx/models/ai/assistant_tool.rb +316 -13
- data/lib/telnyx/models/ai/assistant_update_params.rb +23 -12
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +23 -12
- data/lib/telnyx/models/ai/audio_transcribe_params.rb +33 -13
- data/lib/telnyx/models/ai/audio_transcribe_response.rb +34 -56
- data/lib/telnyx/models/ai/audio_transcription_response_word.rb +74 -0
- data/lib/telnyx/models/ai/chat_completion_request.rb +3 -26
- data/lib/telnyx/models/ai/collection.rb +3 -3
- data/lib/telnyx/models/ai/collections/collections_source.rb +64 -0
- data/lib/telnyx/models/ai/collections/source.rb +25 -29
- data/lib/telnyx/models/ai/collections/source_create_response.rb +3 -3
- data/lib/telnyx/models/ai/collections/source_list_response.rb +3 -3
- data/lib/telnyx/models/ai/collections/source_replace_response.rb +3 -3
- data/lib/telnyx/models/ai/flow_node.rb +5 -5
- data/lib/telnyx/models/ai/flow_node_req.rb +3 -3
- data/lib/telnyx/models/ai/inference_embedding.rb +16 -13
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +10 -1
- data/lib/telnyx/models/ai/inference_embedding_voice_settings.rb +334 -0
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +33 -11
- data/lib/telnyx/models/ai/memory/namespace_retrieve_params.rb +30 -0
- data/lib/telnyx/models/ai/memory/namespace_retrieve_response.rb +76 -0
- data/lib/telnyx/models/ai/memory/namespaces/namespace_settings_response.rb +63 -0
- data/lib/telnyx/models/ai/memory/namespaces/page_meta.rb +58 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_delete_params.rb +35 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_delete_response.rb +47 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_params.rb +94 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_ingest_response.rb +61 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_list_params.rb +48 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_list_response.rb +34 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_recall_params.rb +44 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_recall_response.rb +60 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_remember_params.rb +38 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_remember_response.rb +54 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rb +35 -0
- data/lib/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rb +64 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rb +76 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rb +53 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rb +50 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rb +74 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rb +52 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rb +60 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rb +67 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rb +52 -0
- data/lib/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rb +123 -0
- data/lib/telnyx/models/ai/memory/namespaces/setting_list_params.rb +28 -0
- data/lib/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rb +69 -0
- data/lib/telnyx/models/ai/openai/function_definition.rb +31 -0
- data/lib/telnyx/models/ai/post_conversation_settings.rb +4 -4
- data/lib/telnyx/models/ai/post_conversation_settings_req.rb +4 -4
- data/lib/telnyx/models/ai/privacy_settings.rb +20 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +21 -1
- data/lib/telnyx/models/ai/telephony_settings.rb +86 -16
- data/lib/telnyx/models/ai/tool_node.rb +2 -2
- data/lib/telnyx/models/ai/transcription_settings.rb +12 -4
- data/lib/telnyx/models/ai/transcription_settings_config.rb +12 -11
- data/lib/telnyx/models/ai/typesafe/v1_systemone_params.rb +296 -0
- data/lib/telnyx/models/ai/typesafe/v1_systemone_response.rb +235 -0
- data/lib/telnyx/models/ai/webhook_tool.rb +16 -1
- data/lib/telnyx/models/artifact_completed_webhook_event.rb +17 -1
- data/lib/telnyx/models/artifact_failed_webhook_event.rb +4 -0
- data/lib/telnyx/models/bot_challenge_create_params.rb +38 -0
- data/lib/telnyx/models/bot_challenge_create_response.rb +87 -0
- data/lib/telnyx/models/bot_session_list_params.rb +34 -0
- data/lib/telnyx/models/bot_session_list_response.rb +32 -0
- data/lib/telnyx/models/bot_signup_create_params.rb +103 -0
- data/lib/telnyx/models/bot_signup_resend_magic_link_params.rb +22 -0
- data/lib/telnyx/models/call_dial_params.rb +75 -7
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +11 -3
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +11 -3
- data/lib/telnyx/models/calls/action_speak_params.rb +11 -3
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +11 -3
- data/lib/telnyx/models/calls/action_transfer_params.rb +75 -7
- data/lib/telnyx/models/calls/soniox_voice_settings.rb +46 -0
- data/lib/telnyx/models/calls/transcription_config.rb +14 -3
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +6 -3
- data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb +1 -0
- data/lib/telnyx/models/compute/funcs/export_create_params.rb +62 -0
- data/lib/telnyx/models/compute/funcs/export_delete_all_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/export_list_params.rb +24 -0
- data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +113 -0
- data/lib/telnyx/models/conferences/action_speak_params.rb +11 -3
- data/lib/telnyx/models/connection_retrieve_count_params.rb +14 -0
- data/lib/telnyx/models/connection_retrieve_count_response.rb +215 -0
- data/lib/telnyx/models/conversation_relay_embedded_config.rb +11 -3
- data/lib/telnyx/models/conversation_relay_language.rb +5 -3
- data/lib/telnyx/models/detail_record_list_params.rb +19 -2
- data/lib/telnyx/models/email_block.rb +8 -1
- data/lib/telnyx/models/email_blocks/email_block_import.rb +7 -2
- data/lib/telnyx/models/email_domain_rotate_dkim_params.rb +20 -0
- data/lib/telnyx/models/email_domain_rotate_dkim_response.rb +243 -0
- data/lib/telnyx/models/email_domains/email_webhook_event.rb +8 -3
- data/lib/telnyx/models/email_event_list_params.rb +33 -10
- data/lib/telnyx/models/email_event_list_response.rb +300 -73
- data/lib/telnyx/models/email_event_type.rb +16 -0
- data/lib/telnyx/models/email_inboxes/email_message.rb +56 -4
- data/lib/telnyx/models/email_message_batch_params.rb +32 -15
- data/lib/telnyx/models/email_message_create_params.rb +44 -12
- data/lib/telnyx/models/{email_message_retrieve_response.rb → email_message_detail_response.rb} +5 -5
- data/lib/telnyx/models/email_message_list_params.rb +26 -1
- data/lib/telnyx/models/email_message_update_schedule_params.rb +29 -0
- data/lib/telnyx/models/email_messages/email_recipient.rb +2 -0
- data/lib/telnyx/models/email_messages/recipient_list_params.rb +2 -0
- data/lib/telnyx/models/email_template.rb +68 -2
- data/lib/telnyx/models/email_template_create_params.rb +71 -1
- data/lib/telnyx/models/email_webhook_recipient.rb +39 -0
- data/lib/telnyx/models/inbound_message_webhook_event.rb +3 -70
- data/lib/telnyx/models/machine_payment_account_credit_params.rb +29 -0
- data/lib/telnyx/models/machine_payment_account_credit_response.rb +223 -0
- data/lib/telnyx/models/meeting_session.rb +34 -6
- data/lib/telnyx/models/meeting_session_create_params.rb +73 -39
- data/lib/telnyx/models/meeting_sessions/artifact_create_params.rb +77 -13
- data/lib/telnyx/models/meeting_sessions/meeting_session_artifact.rb +25 -1
- data/lib/telnyx/models/message_event.rb +41 -2
- data/lib/telnyx/models/message_retrieve_group_messages_response.rb +3 -3
- data/lib/telnyx/models/message_retrieve_response.rb +4 -4
- data/lib/telnyx/models/message_schedule_response.rb +3 -3
- data/lib/telnyx/models/message_send_group_mms_response.rb +3 -3
- data/lib/telnyx/models/message_send_long_code_response.rb +3 -3
- data/lib/telnyx/models/message_send_number_pool_response.rb +3 -3
- data/lib/telnyx/models/message_send_response.rb +3 -3
- data/lib/telnyx/models/message_send_short_code_response.rb +3 -3
- data/lib/telnyx/models/messaging_inbound_message.rb +71 -0
- data/lib/telnyx/models/messaging_inbound_message_payload.rb +216 -13
- data/lib/telnyx/models/messaging_outbound_message_payload.rb +42 -2
- data/lib/telnyx/models/noise_suppression_engine_list_params.rb +14 -0
- data/lib/telnyx/models/noise_suppression_engine_list_response.rb +50 -0
- data/lib/telnyx/models/number_order_status_update.rb +15 -3
- data/lib/telnyx/models/number_order_status_update_webhook_event.rb +15 -3
- data/lib/telnyx/models/numbers_phone_number_detailed.rb +19 -5
- data/lib/telnyx/models/outbound_message.rb +1 -0
- data/lib/telnyx/models/outbound_message_payload.rb +45 -5
- data/lib/telnyx/models/private_wireless_gateway.rb +0 -1
- data/lib/telnyx/models/private_wireless_gateway_create_params.rb +28 -1
- data/lib/telnyx/models/private_wireless_gateway_create_response.rb +3 -3
- data/lib/telnyx/models/private_wireless_gateway_delete_response.rb +3 -3
- data/lib/telnyx/models/private_wireless_gateway_retrieve_response.rb +3 -3
- data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb +1 -0
- data/lib/telnyx/models/success_response.rb +27 -0
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +246 -3
- data/lib/telnyx/models/texml/accounts/call_retrieve_calls_params.rb +17 -17
- data/lib/telnyx/models/texml/accounts/conferences/participant_participants_params.rb +82 -1
- data/lib/telnyx/models/texml/call_create_params.rb +78 -0
- data/lib/telnyx/models/texml/call_create_response.rb +55 -0
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +76 -1
- data/lib/telnyx/models/text_to_speech_generate_speech_params.rb +129 -3
- data/lib/telnyx/models/text_to_speech_list_voices_params.rb +1 -0
- data/lib/telnyx/models/text_to_speech_retrieve_speech_params.rb +1 -1
- data/lib/telnyx/models/update_email_template_request.rb +54 -1
- data/lib/telnyx/models/voice_clone_create_from_upload_params.rb +2 -2
- data/lib/telnyx/models/wireless_private_wireless_gateway.rb +120 -0
- data/lib/telnyx/models.rb +28 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +2 -2
- data/lib/telnyx/resources/ai/assistants.rb +4 -4
- data/lib/telnyx/resources/ai/audio.rb +2 -2
- data/lib/telnyx/resources/ai/memory/namespaces/profiles/memories.rb +122 -0
- data/lib/telnyx/resources/ai/memory/namespaces/profiles/sources.rb +163 -0
- data/lib/telnyx/resources/ai/memory/namespaces/profiles.rb +244 -0
- data/lib/telnyx/resources/ai/memory/namespaces/settings.rb +76 -0
- data/lib/telnyx/resources/ai/memory/namespaces.rb +55 -0
- data/lib/telnyx/resources/ai/memory.rb +21 -0
- data/lib/telnyx/resources/ai/typesafe/v1.rb +71 -0
- data/lib/telnyx/resources/ai/typesafe.rb +22 -0
- data/lib/telnyx/resources/ai.rb +8 -0
- data/lib/telnyx/resources/bot_challenge.rb +53 -0
- data/lib/telnyx/resources/bot_sessions.rb +57 -0
- data/lib/telnyx/resources/bot_signup.rb +97 -0
- data/lib/telnyx/resources/calls/actions.rb +5 -5
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/compute/funcs/export.rb +105 -0
- data/lib/telnyx/resources/compute/funcs.rb +4 -0
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/connections.rb +20 -0
- data/lib/telnyx/resources/detail_records.rb +1 -1
- data/lib/telnyx/resources/email_blocks/imports.rb +17 -3
- data/lib/telnyx/resources/email_blocks.rb +5 -3
- data/lib/telnyx/resources/email_domains.rb +28 -0
- data/lib/telnyx/resources/email_events.rb +21 -9
- data/lib/telnyx/resources/email_messages.rb +61 -15
- data/lib/telnyx/resources/email_templates.rb +33 -3
- data/lib/telnyx/resources/machine_payments.rb +73 -0
- data/lib/telnyx/resources/meeting_sessions/actions.rb +7 -1
- data/lib/telnyx/resources/meeting_sessions/artifacts.rb +18 -9
- data/lib/telnyx/resources/meeting_sessions.rb +6 -5
- data/lib/telnyx/resources/noise_suppression_engines.rb +37 -0
- data/lib/telnyx/resources/private_wireless_gateways.rb +5 -3
- data/lib/telnyx/resources/texml/accounts/calls.rb +9 -9
- data/lib/telnyx/resources/texml/accounts/conferences/participants.rb +15 -1
- data/lib/telnyx/resources/texml/calls.rb +57 -0
- data/lib/telnyx/resources/texml.rb +20 -1
- data/lib/telnyx/resources/text_to_speech.rb +6 -4
- data/lib/telnyx/resources/voice_clones.rb +4 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +75 -1
- data/rbi/telnyx/client.rbi +35 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +24 -16
- data/rbi/telnyx/models/ai/assistant_tool.rbi +479 -25
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +50 -20
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +54 -20
- data/rbi/telnyx/models/ai/audio_transcribe_params.rbi +71 -20
- data/rbi/telnyx/models/ai/audio_transcribe_response.rbi +63 -97
- data/rbi/telnyx/models/ai/audio_transcription_response_word.rbi +108 -0
- data/rbi/telnyx/models/ai/chat_completion_request.rbi +4 -58
- data/rbi/telnyx/models/ai/collection.rbi +10 -4
- data/rbi/telnyx/models/ai/collections/collections_source.rbi +110 -0
- data/rbi/telnyx/models/ai/collections/source.rbi +36 -62
- data/rbi/telnyx/models/ai/collections/source_create_response.rbi +14 -6
- data/rbi/telnyx/models/ai/collections/source_list_response.rbi +10 -4
- data/rbi/telnyx/models/ai/collections/source_replace_response.rbi +11 -4
- data/rbi/telnyx/models/ai/flow_node.rbi +12 -6
- data/rbi/telnyx/models/ai/flow_node_req.rbi +8 -4
- data/rbi/telnyx/models/ai/inference_embedding.rbi +32 -20
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +10 -0
- data/rbi/telnyx/models/ai/inference_embedding_voice_settings.rbi +803 -0
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +49 -19
- data/rbi/telnyx/models/ai/memory/namespace_retrieve_params.rbi +50 -0
- data/rbi/telnyx/models/ai/memory/namespace_retrieve_response.rbi +167 -0
- data/rbi/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbi +156 -0
- data/rbi/telnyx/models/ai/memory/namespaces/page_meta.rbi +81 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_delete_params.rbi +58 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_delete_response.rbi +97 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_ingest_params.rbi +149 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_ingest_response.rbi +113 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_list_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_list_response.rbi +48 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_recall_params.rbi +68 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_recall_response.rbi +109 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_remember_params.rbi +57 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_remember_response.rbi +107 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rbi +58 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rbi +119 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rbi +102 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rbi +72 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rbi +70 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rbi +129 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rbi +117 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rbi +92 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rbi +74 -0
- data/rbi/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rbi +209 -0
- data/rbi/telnyx/models/ai/memory/namespaces/setting_list_params.rbi +49 -0
- data/rbi/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rbi +125 -0
- data/rbi/telnyx/models/ai/openai/function_definition.rbi +56 -0
- data/rbi/telnyx/models/ai/post_conversation_settings.rbi +4 -4
- data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +4 -4
- data/rbi/telnyx/models/ai/privacy_settings.rbi +43 -3
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +29 -3
- data/rbi/telnyx/models/ai/telephony_settings.rbi +174 -20
- data/rbi/telnyx/models/ai/tool_node.rbi +4 -2
- data/rbi/telnyx/models/ai/transcription_settings.rbi +25 -6
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +18 -16
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_params.rbi +566 -0
- data/rbi/telnyx/models/ai/typesafe/v1_systemone_response.rbi +388 -0
- data/rbi/telnyx/models/ai/webhook_tool.rbi +23 -3
- data/rbi/telnyx/models/artifact_completed_webhook_event.rbi +30 -0
- data/rbi/telnyx/models/artifact_failed_webhook_event.rbi +20 -0
- data/rbi/telnyx/models/bot_challenge_create_params.rbi +68 -0
- data/rbi/telnyx/models/bot_challenge_create_response.rbi +169 -0
- data/rbi/telnyx/models/bot_session_list_params.rbi +53 -0
- data/rbi/telnyx/models/bot_session_list_response.rbi +64 -0
- data/rbi/telnyx/models/bot_signup_create_params.rbi +179 -0
- data/rbi/telnyx/models/bot_signup_resend_magic_link_params.rbi +43 -0
- data/rbi/telnyx/models/call_dial_params.rbi +111 -10
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_speak_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +22 -5
- data/rbi/telnyx/models/calls/action_transfer_params.rbi +111 -10
- data/rbi/telnyx/models/calls/soniox_voice_settings.rbi +86 -0
- data/rbi/telnyx/models/calls/transcription_config.rbi +29 -5
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +11 -3
- data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi +5 -0
- data/rbi/telnyx/models/compute/funcs/export_create_params.rbi +84 -0
- data/rbi/telnyx/models/compute/funcs/export_delete_all_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/export_list_params.rbi +42 -0
- data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +227 -0
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +22 -5
- data/rbi/telnyx/models/connection_retrieve_count_params.rbi +30 -0
- data/rbi/telnyx/models/connection_retrieve_count_response.rbi +353 -0
- data/rbi/telnyx/models/conversation_relay_embedded_config.rbi +22 -5
- data/rbi/telnyx/models/conversation_relay_language.rbi +10 -5
- data/rbi/telnyx/models/detail_record_list_params.rbi +30 -2
- data/rbi/telnyx/models/email_block.rbi +8 -0
- data/rbi/telnyx/models/email_blocks/email_block_import.rbi +6 -2
- data/rbi/telnyx/models/email_domain_rotate_dkim_params.rbi +35 -0
- data/rbi/telnyx/models/email_domain_rotate_dkim_response.rbi +487 -0
- data/rbi/telnyx/models/email_domains/email_webhook_event.rbi +20 -3
- data/rbi/telnyx/models/email_event_list_params.rbi +46 -11
- data/rbi/telnyx/models/email_event_list_response.rbi +599 -97
- data/rbi/telnyx/models/email_event_type.rbi +25 -0
- data/rbi/telnyx/models/email_inboxes/email_message.rbi +81 -3
- data/rbi/telnyx/models/email_message_batch_params.rbi +54 -20
- data/rbi/telnyx/models/email_message_create_params.rbi +80 -16
- data/rbi/telnyx/models/{email_message_retrieve_response.rbi → email_message_detail_response.rbi} +9 -16
- data/rbi/telnyx/models/email_message_list_params.rbi +40 -0
- data/rbi/telnyx/models/email_message_update_schedule_params.rbi +52 -0
- data/rbi/telnyx/models/email_messages/email_recipient.rbi +10 -0
- data/rbi/telnyx/models/email_messages/recipient_list_params.rbi +10 -0
- data/rbi/telnyx/models/email_template.rbi +84 -0
- data/rbi/telnyx/models/email_template_create_params.rbi +124 -0
- data/rbi/telnyx/models/email_webhook_recipient.rbi +68 -0
- data/rbi/telnyx/models/inbound_message_webhook_event.rbi +4 -173
- data/rbi/telnyx/models/machine_payment_account_credit_params.rbi +51 -0
- data/rbi/telnyx/models/machine_payment_account_credit_response.rbi +446 -0
- data/rbi/telnyx/models/meeting_session.rbi +36 -10
- data/rbi/telnyx/models/meeting_session_create_params.rbi +112 -48
- data/rbi/telnyx/models/meeting_sessions/artifact_create_params.rbi +161 -24
- data/rbi/telnyx/models/meeting_sessions/meeting_session_artifact.rbi +30 -0
- data/rbi/telnyx/models/message_event.rbi +48 -1
- data/rbi/telnyx/models/message_retrieve_group_messages_response.rbi +6 -12
- data/rbi/telnyx/models/message_retrieve_response.rbi +3 -3
- data/rbi/telnyx/models/message_schedule_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_group_mms_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_long_code_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_number_pool_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_response.rbi +4 -6
- data/rbi/telnyx/models/message_send_short_code_response.rbi +4 -6
- data/rbi/telnyx/models/messaging_inbound_message.rbi +152 -0
- data/rbi/telnyx/models/messaging_inbound_message_payload.rbi +477 -15
- data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +90 -16
- data/rbi/telnyx/models/noise_suppression_engine_list_params.rbi +30 -0
- data/rbi/telnyx/models/noise_suppression_engine_list_response.rbi +94 -0
- data/rbi/telnyx/models/number_order_status_update.rbi +34 -3
- data/rbi/telnyx/models/number_order_status_update_webhook_event.rbi +39 -3
- data/rbi/telnyx/models/numbers_phone_number_detailed.rbi +24 -4
- data/rbi/telnyx/models/outbound_message.rbi +5 -0
- data/rbi/telnyx/models/outbound_message_payload.rbi +74 -4
- data/rbi/telnyx/models/private_wireless_gateway_create_params.rbi +71 -0
- data/rbi/telnyx/models/private_wireless_gateway_create_response.rbi +4 -4
- data/rbi/telnyx/models/private_wireless_gateway_delete_response.rbi +4 -4
- data/rbi/telnyx/models/private_wireless_gateway_retrieve_response.rbi +4 -4
- data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi +5 -0
- data/rbi/telnyx/models/success_response.rbi +36 -0
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +339 -0
- data/rbi/telnyx/models/texml/accounts/call_retrieve_calls_params.rbi +22 -22
- data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi +111 -0
- data/rbi/telnyx/models/texml/call_create_params.rbi +124 -0
- data/rbi/telnyx/models/texml/call_create_response.rbi +98 -0
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +103 -0
- data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi +311 -2
- data/rbi/telnyx/models/text_to_speech_list_voices_params.rbi +5 -0
- data/rbi/telnyx/models/text_to_speech_retrieve_speech_params.rbi +5 -5
- data/rbi/telnyx/models/update_email_template_request.rbi +90 -0
- data/rbi/telnyx/models/voice_clone_create_from_upload_params.rbi +4 -4
- data/rbi/telnyx/models/wireless_private_wireless_gateway.rbi +211 -0
- data/rbi/telnyx/models.rbi +33 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +21 -8
- data/rbi/telnyx/resources/ai/assistants.rbi +27 -14
- data/rbi/telnyx/resources/ai/audio.rbi +20 -9
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles/memories.rbi +94 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles/sources.rbi +117 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/profiles.rbi +196 -0
- data/rbi/telnyx/resources/ai/memory/namespaces/settings.rbi +67 -0
- data/rbi/telnyx/resources/ai/memory/namespaces.rbi +37 -0
- data/rbi/telnyx/resources/ai/memory.rbi +18 -0
- data/rbi/telnyx/resources/ai/typesafe/v1.rbi +71 -0
- data/rbi/telnyx/resources/ai/typesafe.rbi +19 -0
- data/rbi/telnyx/resources/ai.rbi +6 -0
- data/rbi/telnyx/resources/bot_challenge.rbi +45 -0
- data/rbi/telnyx/resources/bot_sessions.rbi +45 -0
- data/rbi/telnyx/resources/bot_signup.rbi +87 -0
- data/rbi/telnyx/resources/calls/actions.rbi +38 -9
- data/rbi/telnyx/resources/calls.rbi +6 -5
- data/rbi/telnyx/resources/compute/funcs/export.rbi +86 -0
- data/rbi/telnyx/resources/compute/funcs.rbi +3 -0
- data/rbi/telnyx/resources/conferences/actions.rbi +8 -1
- data/rbi/telnyx/resources/connections.rbi +11 -0
- data/rbi/telnyx/resources/detail_records.rbi +12 -1
- data/rbi/telnyx/resources/email_blocks/imports.rbi +17 -3
- data/rbi/telnyx/resources/email_blocks.rbi +5 -3
- data/rbi/telnyx/resources/email_domains.rbi +22 -0
- data/rbi/telnyx/resources/email_events.rbi +30 -9
- data/rbi/telnyx/resources/email_messages.rbi +104 -18
- data/rbi/telnyx/resources/email_templates.rbi +71 -0
- data/rbi/telnyx/resources/machine_payments.rbi +64 -0
- data/rbi/telnyx/resources/meeting_sessions/actions.rbi +7 -1
- data/rbi/telnyx/resources/meeting_sessions/artifacts.rbi +19 -8
- data/rbi/telnyx/resources/meeting_sessions.rbi +15 -7
- data/rbi/telnyx/resources/noise_suppression_engines.rbi +26 -0
- data/rbi/telnyx/resources/private_wireless_gateways.rbi +9 -1
- data/rbi/telnyx/resources/texml/accounts/calls.rbi +6 -6
- data/rbi/telnyx/resources/texml/accounts/conferences/participants.rbi +32 -0
- data/rbi/telnyx/resources/texml/calls.rbi +50 -0
- data/rbi/telnyx/resources/texml.rbi +36 -0
- data/rbi/telnyx/resources/text_to_speech.rbi +7 -3
- data/rbi/telnyx/resources/voice_clones.rbi +4 -2
- data/sig/telnyx/client.rbs +10 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +6 -6
- data/sig/telnyx/models/ai/assistant_tool.rbs +195 -26
- data/sig/telnyx/models/ai/assistant_update_params.rbs +6 -6
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +6 -6
- data/sig/telnyx/models/ai/audio_transcribe_params.rbs +10 -0
- data/sig/telnyx/models/ai/audio_transcribe_response.rbs +29 -43
- data/sig/telnyx/models/ai/audio_transcription_response_word.rbs +60 -0
- data/sig/telnyx/models/ai/chat_completion_request.rbs +4 -35
- data/sig/telnyx/models/ai/collection.rbs +6 -6
- data/sig/telnyx/models/ai/collections/collections_source.rbs +65 -0
- data/sig/telnyx/models/ai/collections/source.rbs +18 -37
- data/sig/telnyx/models/ai/collections/source_create_response.rbs +9 -6
- data/sig/telnyx/models/ai/collections/source_list_response.rbs +8 -6
- data/sig/telnyx/models/ai/collections/source_replace_response.rbs +6 -6
- data/sig/telnyx/models/ai/flow_node.rbs +6 -6
- data/sig/telnyx/models/ai/flow_node_req.rbs +6 -6
- data/sig/telnyx/models/ai/inference_embedding.rbs +6 -6
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +5 -0
- data/sig/telnyx/models/ai/inference_embedding_voice_settings.rbs +308 -0
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +20 -13
- data/sig/telnyx/models/ai/memory/namespace_retrieve_params.rbs +32 -0
- data/sig/telnyx/models/ai/memory/namespace_retrieve_response.rbs +69 -0
- data/sig/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbs +59 -0
- data/sig/telnyx/models/ai/memory/namespaces/page_meta.rbs +41 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_delete_params.rbs +34 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_delete_response.rbs +41 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_ingest_params.rbs +69 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_ingest_response.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_list_params.rbs +42 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_list_response.rbs +22 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_recall_params.rbs +47 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_recall_response.rbs +53 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_remember_params.rbs +38 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_remember_response.rbs +49 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_params.rbs +34 -0
- data/sig/telnyx/models/ai/memory/namespaces/profile_retrieve_summary_response.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_list_params.rbs +63 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_list_response.rbs +43 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/memory_retrieve_response.rbs +65 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_delete_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_delete_response.rbs +55 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_list_params.rbs +58 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_params.rbs +40 -0
- data/sig/telnyx/models/ai/memory/namespaces/profiles/source_retrieve_response.rbs +92 -0
- data/sig/telnyx/models/ai/memory/namespaces/setting_list_params.rbs +29 -0
- data/sig/telnyx/models/ai/memory/namespaces/setting_patch_all_params.rbs +47 -0
- data/sig/telnyx/models/ai/openai/function_definition.rbs +34 -0
- data/sig/telnyx/models/ai/privacy_settings.rbs +11 -3
- data/sig/telnyx/models/ai/retrieval_tool.rbs +10 -3
- data/sig/telnyx/models/ai/telephony_settings.rbs +52 -4
- data/sig/telnyx/models/ai/transcription_settings.rbs +4 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_params.rbs +215 -0
- data/sig/telnyx/models/ai/typesafe/v1_systemone_response.rbs +152 -0
- data/sig/telnyx/models/ai/webhook_tool.rbs +10 -3
- data/sig/telnyx/models/artifact_completed_webhook_event.rbs +16 -1
- data/sig/telnyx/models/artifact_failed_webhook_event.rbs +11 -1
- data/sig/telnyx/models/bot_challenge_create_params.rbs +42 -0
- data/sig/telnyx/models/bot_challenge_create_response.rbs +72 -0
- data/sig/telnyx/models/bot_session_list_params.rbs +28 -0
- data/sig/telnyx/models/bot_session_list_response.rbs +26 -0
- data/sig/telnyx/models/bot_signup_create_params.rbs +89 -0
- data/sig/telnyx/models/bot_signup_resend_magic_link_params.rbs +20 -0
- data/sig/telnyx/models/call_dial_params.rbs +49 -0
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_speak_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +1 -0
- data/sig/telnyx/models/calls/action_transfer_params.rbs +49 -0
- data/sig/telnyx/models/calls/soniox_voice_settings.rbs +46 -0
- data/sig/telnyx/models/calls/transcription_config.rbs +4 -0
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +3 -1
- data/sig/telnyx/models/calls/transcription_engine_parakeet_config.rbs +3 -1
- data/sig/telnyx/models/compute/funcs/export_create_params.rbs +50 -0
- data/sig/telnyx/models/compute/funcs/export_delete_all_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/export_list_params.rbs +27 -0
- data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +115 -0
- data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -0
- data/sig/telnyx/models/connection_retrieve_count_params.rbs +15 -0
- data/sig/telnyx/models/connection_retrieve_count_response.rbs +169 -0
- data/sig/telnyx/models/conversation_relay_embedded_config.rbs +1 -0
- data/sig/telnyx/models/conversation_relay_language.rbs +1 -0
- data/sig/telnyx/models/email_domain_rotate_dkim_params.rbs +23 -0
- data/sig/telnyx/models/email_domain_rotate_dkim_response.rbs +195 -0
- data/sig/telnyx/models/email_domains/email_webhook_event.rbs +6 -0
- data/sig/telnyx/models/email_event_list_params.rbs +7 -7
- data/sig/telnyx/models/email_event_list_response.rbs +235 -59
- data/sig/telnyx/models/email_event_type.rbs +20 -0
- data/sig/telnyx/models/email_inboxes/email_message.rbs +43 -4
- data/sig/telnyx/models/{email_message_retrieve_response.rbs → email_message_detail_response.rbs} +6 -10
- data/sig/telnyx/models/email_message_list_params.rbs +18 -1
- data/sig/telnyx/models/email_message_update_schedule_params.rbs +28 -0
- data/sig/telnyx/models/email_messages/email_recipient.rbs +4 -0
- data/sig/telnyx/models/email_messages/recipient_list_params.rbs +4 -0
- data/sig/telnyx/models/email_template.rbs +29 -0
- data/sig/telnyx/models/email_template_create_params.rbs +33 -0
- data/sig/telnyx/models/email_webhook_recipient.rbs +46 -0
- data/sig/telnyx/models/inbound_message_webhook_event.rbs +6 -79
- data/sig/telnyx/models/machine_payment_account_credit_params.rbs +23 -0
- data/sig/telnyx/models/machine_payment_account_credit_response.rbs +164 -0
- data/sig/telnyx/models/meeting_session.rbs +20 -5
- data/sig/telnyx/models/meeting_session_create_params.rbs +28 -20
- data/sig/telnyx/models/meeting_sessions/artifact_create_params.rbs +53 -10
- data/sig/telnyx/models/meeting_sessions/meeting_session_artifact.rbs +16 -1
- data/sig/telnyx/models/message_event.rbs +10 -0
- data/sig/telnyx/models/message_retrieve_group_messages_response.rbs +6 -8
- data/sig/telnyx/models/message_retrieve_response.rbs +1 -2
- data/sig/telnyx/models/message_schedule_response.rbs +6 -7
- data/sig/telnyx/models/message_send_group_mms_response.rbs +6 -6
- data/sig/telnyx/models/message_send_long_code_response.rbs +6 -6
- data/sig/telnyx/models/message_send_number_pool_response.rbs +6 -6
- data/sig/telnyx/models/message_send_response.rbs +6 -7
- data/sig/telnyx/models/message_send_short_code_response.rbs +6 -6
- data/sig/telnyx/models/messaging_inbound_message.rbs +76 -0
- data/sig/telnyx/models/messaging_inbound_message_payload.rbs +235 -6
- data/sig/telnyx/models/messaging_outbound_message_payload.rbs +39 -1
- data/sig/telnyx/models/noise_suppression_engine_list_params.rbs +15 -0
- data/sig/telnyx/models/noise_suppression_engine_list_response.rbs +43 -0
- data/sig/telnyx/models/number_order_status_update.rbs +14 -4
- data/sig/telnyx/models/number_order_status_update_webhook_event.rbs +14 -4
- data/sig/telnyx/models/numbers_phone_number_detailed.rbs +5 -0
- data/sig/telnyx/models/outbound_message.rbs +2 -1
- data/sig/telnyx/models/outbound_message_payload.rbs +45 -7
- data/sig/telnyx/models/private_wireless_gateway_create_params.rbs +25 -1
- data/sig/telnyx/models/private_wireless_gateway_create_response.rbs +6 -6
- data/sig/telnyx/models/private_wireless_gateway_delete_response.rbs +6 -6
- data/sig/telnyx/models/private_wireless_gateway_retrieve_response.rbs +6 -6
- data/sig/telnyx/models/speech_to_text_retrieve_transcription_params.rbs +2 -0
- data/sig/telnyx/models/success_response.rbs +15 -0
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +159 -0
- data/sig/telnyx/models/texml/accounts/call_retrieve_calls_params.rbs +14 -14
- data/sig/telnyx/models/texml/accounts/conferences/participant_participants_params.rbs +49 -0
- data/sig/telnyx/models/texml/call_create_params.rbs +72 -0
- data/sig/telnyx/models/texml/call_create_response.rbs +47 -0
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +49 -0
- data/sig/telnyx/models/text_to_speech_generate_speech_params.rbs +114 -0
- data/sig/telnyx/models/text_to_speech_list_voices_params.rbs +2 -0
- data/sig/telnyx/models/text_to_speech_retrieve_speech_params.rbs +2 -2
- data/sig/telnyx/models/update_email_template_request.rbs +33 -0
- data/sig/telnyx/models/wireless_private_wireless_gateway.rbs +109 -0
- data/sig/telnyx/models.rbs +28 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -1
- data/sig/telnyx/resources/ai/assistants.rbs +2 -2
- data/sig/telnyx/resources/ai/memory/namespaces/profiles/memories.rbs +32 -0
- data/sig/telnyx/resources/ai/memory/namespaces/profiles/sources.rbs +38 -0
- data/sig/telnyx/resources/ai/memory/namespaces/profiles.rbs +59 -0
- data/sig/telnyx/resources/ai/memory/namespaces/settings.rbs +24 -0
- data/sig/telnyx/resources/ai/memory/namespaces.rbs +21 -0
- data/sig/telnyx/resources/ai/memory.rbs +11 -0
- data/sig/telnyx/resources/ai/typesafe/v1.rbs +18 -0
- data/sig/telnyx/resources/ai/typesafe.rbs +11 -0
- data/sig/telnyx/resources/ai.rbs +4 -0
- data/sig/telnyx/resources/bot_challenge.rbs +14 -0
- data/sig/telnyx/resources/bot_sessions.rbs +13 -0
- data/sig/telnyx/resources/bot_signup.rbs +24 -0
- data/sig/telnyx/resources/compute/funcs/export.rbs +30 -0
- data/sig/telnyx/resources/compute/funcs.rbs +2 -0
- data/sig/telnyx/resources/connections.rbs +4 -0
- data/sig/telnyx/resources/email_domains.rbs +5 -0
- data/sig/telnyx/resources/email_events.rbs +2 -2
- data/sig/telnyx/resources/email_messages.rbs +9 -1
- data/sig/telnyx/resources/email_templates.rbs +9 -0
- data/sig/telnyx/resources/machine_payments.rbs +12 -0
- data/sig/telnyx/resources/meeting_sessions/artifacts.rbs +1 -1
- data/sig/telnyx/resources/meeting_sessions.rbs +1 -0
- data/sig/telnyx/resources/noise_suppression_engines.rbs +11 -0
- data/sig/telnyx/resources/private_wireless_gateways.rbs +2 -1
- data/sig/telnyx/resources/texml/accounts/conferences/participants.rbs +7 -0
- data/sig/telnyx/resources/texml/calls.rbs +19 -0
- data/sig/telnyx/resources/texml.rbs +9 -0
- data/sig/telnyx/resources/text_to_speech.rbs +1 -0
- metadata +227 -5
|
@@ -234,10 +234,10 @@ module Telnyx
|
|
|
234
234
|
|
|
235
235
|
# Configuration for post-conversation processing. When enabled, the assistant
|
|
236
236
|
# receives one additional LLM turn after the conversation ends, allowing it to
|
|
237
|
-
# execute tool calls such as
|
|
238
|
-
#
|
|
239
|
-
#
|
|
240
|
-
#
|
|
237
|
+
# execute final tool calls such as sending a summary or updating a record via
|
|
238
|
+
# webhook or function tools. Integration and MCP server tools are not available
|
|
239
|
+
# post-conversation; call-control tools (e.g. hangup, transfer) are also
|
|
240
|
+
# unavailable. Beta feature.
|
|
241
241
|
sig { returns(T.nilable(Telnyx::AI::PostConversationSettingsReq)) }
|
|
242
242
|
attr_reader :post_conversation_settings
|
|
243
243
|
|
|
@@ -282,7 +282,11 @@ module Telnyx
|
|
|
282
282
|
attr_writer :telephony_settings
|
|
283
283
|
|
|
284
284
|
# IDs of shared tools to attach to the assistant. New integrations should prefer
|
|
285
|
-
# `tool_ids` over inline `tools`.
|
|
285
|
+
# `tool_ids` over inline `tools`. On update, a sent `tool_ids` array fully
|
|
286
|
+
# replaces the assistant's attached shared tools; omit the field to leave them
|
|
287
|
+
# unchanged. Single-instance tool types are counted across inline `tools` and
|
|
288
|
+
# `tool_ids` combined, so attaching a shared tool of such a type when an instance
|
|
289
|
+
# already exists returns HTTP 400 with error code 10015.
|
|
286
290
|
sig { returns(T.nilable(T::Array[String])) }
|
|
287
291
|
attr_reader :tool_ids
|
|
288
292
|
|
|
@@ -291,17 +295,25 @@ module Telnyx
|
|
|
291
295
|
|
|
292
296
|
# Deprecated for new integrations. Inline tool definitions available to the
|
|
293
297
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
294
|
-
# endpoints.
|
|
298
|
+
# endpoints. On update, a sent `tools` array fully replaces the assistant's inline
|
|
299
|
+
# tools; omit the field to leave the inline tools unchanged. Each tool type except
|
|
300
|
+
# `function`, `webhook`, and `client_side_tool` allows at most one instance per
|
|
301
|
+
# assistant, counted across inline `tools` and shared `tool_ids` combined —
|
|
302
|
+
# sending a duplicate of such a type returns HTTP 400 with error code 10015.
|
|
303
|
+
# Responses merge shared tools into `tools` with `shared: true`; when updating,
|
|
304
|
+
# omit those tools from the `tools` array and manage them through `tool_ids`
|
|
305
|
+
# instead.
|
|
295
306
|
sig do
|
|
296
307
|
returns(
|
|
297
308
|
T.nilable(
|
|
298
309
|
T::Array[
|
|
299
310
|
T.any(
|
|
311
|
+
Telnyx::AI::AssistantTool::Function,
|
|
300
312
|
Telnyx::AI::InferenceEmbeddingWebhookToolParams,
|
|
301
313
|
Telnyx::AI::AssistantTool::ClientSideTool,
|
|
302
314
|
Telnyx::AI::RetrievalTool,
|
|
303
315
|
Telnyx::AI::AssistantTool::Handoff,
|
|
304
|
-
Telnyx::AI::
|
|
316
|
+
Telnyx::AI::AssistantTool::Hangup,
|
|
305
317
|
Telnyx::AI::AssistantTool::Transfer,
|
|
306
318
|
Telnyx::AI::AssistantTool::Invite,
|
|
307
319
|
Telnyx::AI::AssistantTool::Refer,
|
|
@@ -322,11 +334,12 @@ module Telnyx
|
|
|
322
334
|
tools:
|
|
323
335
|
T::Array[
|
|
324
336
|
T.any(
|
|
337
|
+
Telnyx::AI::AssistantTool::Function::OrHash,
|
|
325
338
|
Telnyx::AI::InferenceEmbeddingWebhookToolParams::OrHash,
|
|
326
339
|
Telnyx::AI::AssistantTool::ClientSideTool::OrHash,
|
|
327
340
|
Telnyx::AI::RetrievalTool::OrHash,
|
|
328
341
|
Telnyx::AI::AssistantTool::Handoff::OrHash,
|
|
329
|
-
Telnyx::AI::
|
|
342
|
+
Telnyx::AI::AssistantTool::Hangup::OrHash,
|
|
330
343
|
Telnyx::AI::AssistantTool::Transfer::OrHash,
|
|
331
344
|
Telnyx::AI::AssistantTool::Invite::OrHash,
|
|
332
345
|
Telnyx::AI::AssistantTool::Refer::OrHash,
|
|
@@ -356,10 +369,14 @@ module Telnyx
|
|
|
356
369
|
sig { params(version_name: String).void }
|
|
357
370
|
attr_writer :version_name
|
|
358
371
|
|
|
359
|
-
sig { returns(T.nilable(Telnyx::AI::
|
|
372
|
+
sig { returns(T.nilable(Telnyx::AI::InferenceEmbeddingVoiceSettings)) }
|
|
360
373
|
attr_reader :voice_settings
|
|
361
374
|
|
|
362
|
-
sig
|
|
375
|
+
sig do
|
|
376
|
+
params(
|
|
377
|
+
voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash
|
|
378
|
+
).void
|
|
379
|
+
end
|
|
363
380
|
attr_writer :voice_settings
|
|
364
381
|
|
|
365
382
|
# Configuration settings for the assistant's web widget.
|
|
@@ -403,11 +420,12 @@ module Telnyx
|
|
|
403
420
|
tools:
|
|
404
421
|
T::Array[
|
|
405
422
|
T.any(
|
|
423
|
+
Telnyx::AI::AssistantTool::Function::OrHash,
|
|
406
424
|
Telnyx::AI::InferenceEmbeddingWebhookToolParams::OrHash,
|
|
407
425
|
Telnyx::AI::AssistantTool::ClientSideTool::OrHash,
|
|
408
426
|
Telnyx::AI::RetrievalTool::OrHash,
|
|
409
427
|
Telnyx::AI::AssistantTool::Handoff::OrHash,
|
|
410
|
-
Telnyx::AI::
|
|
428
|
+
Telnyx::AI::AssistantTool::Hangup::OrHash,
|
|
411
429
|
Telnyx::AI::AssistantTool::Transfer::OrHash,
|
|
412
430
|
Telnyx::AI::AssistantTool::Invite::OrHash,
|
|
413
431
|
Telnyx::AI::AssistantTool::Refer::OrHash,
|
|
@@ -420,7 +438,7 @@ module Telnyx
|
|
|
420
438
|
],
|
|
421
439
|
transcription: Telnyx::AI::TranscriptionSettings::OrHash,
|
|
422
440
|
version_name: String,
|
|
423
|
-
voice_settings: Telnyx::AI::
|
|
441
|
+
voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
|
|
424
442
|
widget_settings: Telnyx::AI::WidgetSettings::OrHash,
|
|
425
443
|
request_options: Telnyx::RequestOptions::OrHash
|
|
426
444
|
).returns(T.attached_class)
|
|
@@ -507,10 +525,10 @@ module Telnyx
|
|
|
507
525
|
observability_settings: nil,
|
|
508
526
|
# Configuration for post-conversation processing. When enabled, the assistant
|
|
509
527
|
# receives one additional LLM turn after the conversation ends, allowing it to
|
|
510
|
-
# execute tool calls such as
|
|
511
|
-
#
|
|
512
|
-
#
|
|
513
|
-
#
|
|
528
|
+
# execute final tool calls such as sending a summary or updating a record via
|
|
529
|
+
# webhook or function tools. Integration and MCP server tools are not available
|
|
530
|
+
# post-conversation; call-control tools (e.g. hangup, transfer) are also
|
|
531
|
+
# unavailable. Beta feature.
|
|
514
532
|
post_conversation_settings: nil,
|
|
515
533
|
privacy_settings: nil,
|
|
516
534
|
# Indicates whether the assistant should be promoted to the main version. Defaults
|
|
@@ -521,11 +539,22 @@ module Telnyx
|
|
|
521
539
|
tags: nil,
|
|
522
540
|
telephony_settings: nil,
|
|
523
541
|
# IDs of shared tools to attach to the assistant. New integrations should prefer
|
|
524
|
-
# `tool_ids` over inline `tools`.
|
|
542
|
+
# `tool_ids` over inline `tools`. On update, a sent `tool_ids` array fully
|
|
543
|
+
# replaces the assistant's attached shared tools; omit the field to leave them
|
|
544
|
+
# unchanged. Single-instance tool types are counted across inline `tools` and
|
|
545
|
+
# `tool_ids` combined, so attaching a shared tool of such a type when an instance
|
|
546
|
+
# already exists returns HTTP 400 with error code 10015.
|
|
525
547
|
tool_ids: nil,
|
|
526
548
|
# Deprecated for new integrations. Inline tool definitions available to the
|
|
527
549
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
528
|
-
# endpoints.
|
|
550
|
+
# endpoints. On update, a sent `tools` array fully replaces the assistant's inline
|
|
551
|
+
# tools; omit the field to leave the inline tools unchanged. Each tool type except
|
|
552
|
+
# `function`, `webhook`, and `client_side_tool` allows at most one instance per
|
|
553
|
+
# assistant, counted across inline `tools` and shared `tool_ids` combined —
|
|
554
|
+
# sending a duplicate of such a type returns HTTP 400 with error code 10015.
|
|
555
|
+
# Responses merge shared tools into `tools` with `shared: true`; when updating,
|
|
556
|
+
# omit those tools from the `tools` array and manage them through `tool_ids`
|
|
557
|
+
# instead.
|
|
529
558
|
tools: nil,
|
|
530
559
|
transcription: nil,
|
|
531
560
|
# Human-readable name for the assistant version.
|
|
@@ -572,11 +601,12 @@ module Telnyx
|
|
|
572
601
|
tools:
|
|
573
602
|
T::Array[
|
|
574
603
|
T.any(
|
|
604
|
+
Telnyx::AI::AssistantTool::Function,
|
|
575
605
|
Telnyx::AI::InferenceEmbeddingWebhookToolParams,
|
|
576
606
|
Telnyx::AI::AssistantTool::ClientSideTool,
|
|
577
607
|
Telnyx::AI::RetrievalTool,
|
|
578
608
|
Telnyx::AI::AssistantTool::Handoff,
|
|
579
|
-
Telnyx::AI::
|
|
609
|
+
Telnyx::AI::AssistantTool::Hangup,
|
|
580
610
|
Telnyx::AI::AssistantTool::Transfer,
|
|
581
611
|
Telnyx::AI::AssistantTool::Invite,
|
|
582
612
|
Telnyx::AI::AssistantTool::Refer,
|
|
@@ -589,7 +619,7 @@ module Telnyx
|
|
|
589
619
|
],
|
|
590
620
|
transcription: Telnyx::AI::TranscriptionSettings,
|
|
591
621
|
version_name: String,
|
|
592
|
-
voice_settings: Telnyx::AI::
|
|
622
|
+
voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings,
|
|
593
623
|
widget_settings: Telnyx::AI::WidgetSettings,
|
|
594
624
|
request_options: Telnyx::RequestOptions
|
|
595
625
|
}
|
|
@@ -238,10 +238,10 @@ module Telnyx
|
|
|
238
238
|
|
|
239
239
|
# Configuration for post-conversation processing. When enabled, the assistant
|
|
240
240
|
# receives one additional LLM turn after the conversation ends, allowing it to
|
|
241
|
-
# execute tool calls such as
|
|
242
|
-
#
|
|
243
|
-
#
|
|
244
|
-
#
|
|
241
|
+
# execute final tool calls such as sending a summary or updating a record via
|
|
242
|
+
# webhook or function tools. Integration and MCP server tools are not available
|
|
243
|
+
# post-conversation; call-control tools (e.g. hangup, transfer) are also
|
|
244
|
+
# unavailable. Beta feature.
|
|
245
245
|
sig { returns(T.nilable(Telnyx::AI::PostConversationSettingsReq)) }
|
|
246
246
|
attr_reader :post_conversation_settings
|
|
247
247
|
|
|
@@ -280,7 +280,11 @@ module Telnyx
|
|
|
280
280
|
attr_writer :telephony_settings
|
|
281
281
|
|
|
282
282
|
# IDs of shared tools to attach to the assistant. New integrations should prefer
|
|
283
|
-
# `tool_ids` over inline `tools`.
|
|
283
|
+
# `tool_ids` over inline `tools`. On update, a sent `tool_ids` array fully
|
|
284
|
+
# replaces the assistant's attached shared tools; omit the field to leave them
|
|
285
|
+
# unchanged. Single-instance tool types are counted across inline `tools` and
|
|
286
|
+
# `tool_ids` combined, so attaching a shared tool of such a type when an instance
|
|
287
|
+
# already exists returns HTTP 400 with error code 10015.
|
|
284
288
|
sig { returns(T.nilable(T::Array[String])) }
|
|
285
289
|
attr_reader :tool_ids
|
|
286
290
|
|
|
@@ -289,17 +293,25 @@ module Telnyx
|
|
|
289
293
|
|
|
290
294
|
# Deprecated for new integrations. Inline tool definitions available to the
|
|
291
295
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
292
|
-
# endpoints.
|
|
296
|
+
# endpoints. On update, a sent `tools` array fully replaces the assistant's inline
|
|
297
|
+
# tools; omit the field to leave the inline tools unchanged. Each tool type except
|
|
298
|
+
# `function`, `webhook`, and `client_side_tool` allows at most one instance per
|
|
299
|
+
# assistant, counted across inline `tools` and shared `tool_ids` combined —
|
|
300
|
+
# sending a duplicate of such a type returns HTTP 400 with error code 10015.
|
|
301
|
+
# Responses merge shared tools into `tools` with `shared: true`; when updating,
|
|
302
|
+
# omit those tools from the `tools` array and manage them through `tool_ids`
|
|
303
|
+
# instead.
|
|
293
304
|
sig do
|
|
294
305
|
returns(
|
|
295
306
|
T.nilable(
|
|
296
307
|
T::Array[
|
|
297
308
|
T.any(
|
|
309
|
+
Telnyx::AI::AssistantTool::Function,
|
|
298
310
|
Telnyx::AI::InferenceEmbeddingWebhookToolParams,
|
|
299
311
|
Telnyx::AI::AssistantTool::ClientSideTool,
|
|
300
312
|
Telnyx::AI::RetrievalTool,
|
|
301
313
|
Telnyx::AI::AssistantTool::Handoff,
|
|
302
|
-
Telnyx::AI::
|
|
314
|
+
Telnyx::AI::AssistantTool::Hangup,
|
|
303
315
|
Telnyx::AI::AssistantTool::Transfer,
|
|
304
316
|
Telnyx::AI::AssistantTool::Invite,
|
|
305
317
|
Telnyx::AI::AssistantTool::Refer,
|
|
@@ -320,11 +332,12 @@ module Telnyx
|
|
|
320
332
|
tools:
|
|
321
333
|
T::Array[
|
|
322
334
|
T.any(
|
|
335
|
+
Telnyx::AI::AssistantTool::Function::OrHash,
|
|
323
336
|
Telnyx::AI::InferenceEmbeddingWebhookToolParams::OrHash,
|
|
324
337
|
Telnyx::AI::AssistantTool::ClientSideTool::OrHash,
|
|
325
338
|
Telnyx::AI::RetrievalTool::OrHash,
|
|
326
339
|
Telnyx::AI::AssistantTool::Handoff::OrHash,
|
|
327
|
-
Telnyx::AI::
|
|
340
|
+
Telnyx::AI::AssistantTool::Hangup::OrHash,
|
|
328
341
|
Telnyx::AI::AssistantTool::Transfer::OrHash,
|
|
329
342
|
Telnyx::AI::AssistantTool::Invite::OrHash,
|
|
330
343
|
Telnyx::AI::AssistantTool::Refer::OrHash,
|
|
@@ -356,10 +369,17 @@ module Telnyx
|
|
|
356
369
|
sig { params(version_name: String).void }
|
|
357
370
|
attr_writer :version_name
|
|
358
371
|
|
|
359
|
-
sig
|
|
372
|
+
sig do
|
|
373
|
+
returns(T.nilable(Telnyx::AI::InferenceEmbeddingVoiceSettings))
|
|
374
|
+
end
|
|
360
375
|
attr_reader :voice_settings
|
|
361
376
|
|
|
362
|
-
sig
|
|
377
|
+
sig do
|
|
378
|
+
params(
|
|
379
|
+
voice_settings:
|
|
380
|
+
Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash
|
|
381
|
+
).void
|
|
382
|
+
end
|
|
363
383
|
attr_writer :voice_settings
|
|
364
384
|
|
|
365
385
|
# Configuration settings for the assistant's web widget.
|
|
@@ -403,11 +423,12 @@ module Telnyx
|
|
|
403
423
|
tools:
|
|
404
424
|
T::Array[
|
|
405
425
|
T.any(
|
|
426
|
+
Telnyx::AI::AssistantTool::Function::OrHash,
|
|
406
427
|
Telnyx::AI::InferenceEmbeddingWebhookToolParams::OrHash,
|
|
407
428
|
Telnyx::AI::AssistantTool::ClientSideTool::OrHash,
|
|
408
429
|
Telnyx::AI::RetrievalTool::OrHash,
|
|
409
430
|
Telnyx::AI::AssistantTool::Handoff::OrHash,
|
|
410
|
-
Telnyx::AI::
|
|
431
|
+
Telnyx::AI::AssistantTool::Hangup::OrHash,
|
|
411
432
|
Telnyx::AI::AssistantTool::Transfer::OrHash,
|
|
412
433
|
Telnyx::AI::AssistantTool::Invite::OrHash,
|
|
413
434
|
Telnyx::AI::AssistantTool::Refer::OrHash,
|
|
@@ -420,7 +441,8 @@ module Telnyx
|
|
|
420
441
|
],
|
|
421
442
|
transcription: Telnyx::AI::TranscriptionSettings::OrHash,
|
|
422
443
|
version_name: String,
|
|
423
|
-
voice_settings:
|
|
444
|
+
voice_settings:
|
|
445
|
+
Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
|
|
424
446
|
widget_settings: Telnyx::AI::WidgetSettings::OrHash
|
|
425
447
|
).returns(T.attached_class)
|
|
426
448
|
end
|
|
@@ -505,10 +527,10 @@ module Telnyx
|
|
|
505
527
|
observability_settings: nil,
|
|
506
528
|
# Configuration for post-conversation processing. When enabled, the assistant
|
|
507
529
|
# receives one additional LLM turn after the conversation ends, allowing it to
|
|
508
|
-
# execute tool calls such as
|
|
509
|
-
#
|
|
510
|
-
#
|
|
511
|
-
#
|
|
530
|
+
# execute final tool calls such as sending a summary or updating a record via
|
|
531
|
+
# webhook or function tools. Integration and MCP server tools are not available
|
|
532
|
+
# post-conversation; call-control tools (e.g. hangup, transfer) are also
|
|
533
|
+
# unavailable. Beta feature.
|
|
512
534
|
post_conversation_settings: nil,
|
|
513
535
|
privacy_settings: nil,
|
|
514
536
|
# Tags associated with the assistant. Tags can also be managed with the assistant
|
|
@@ -516,11 +538,22 @@ module Telnyx
|
|
|
516
538
|
tags: nil,
|
|
517
539
|
telephony_settings: nil,
|
|
518
540
|
# IDs of shared tools to attach to the assistant. New integrations should prefer
|
|
519
|
-
# `tool_ids` over inline `tools`.
|
|
541
|
+
# `tool_ids` over inline `tools`. On update, a sent `tool_ids` array fully
|
|
542
|
+
# replaces the assistant's attached shared tools; omit the field to leave them
|
|
543
|
+
# unchanged. Single-instance tool types are counted across inline `tools` and
|
|
544
|
+
# `tool_ids` combined, so attaching a shared tool of such a type when an instance
|
|
545
|
+
# already exists returns HTTP 400 with error code 10015.
|
|
520
546
|
tool_ids: nil,
|
|
521
547
|
# Deprecated for new integrations. Inline tool definitions available to the
|
|
522
548
|
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
523
|
-
# endpoints.
|
|
549
|
+
# endpoints. On update, a sent `tools` array fully replaces the assistant's inline
|
|
550
|
+
# tools; omit the field to leave the inline tools unchanged. Each tool type except
|
|
551
|
+
# `function`, `webhook`, and `client_side_tool` allows at most one instance per
|
|
552
|
+
# assistant, counted across inline `tools` and shared `tool_ids` combined —
|
|
553
|
+
# sending a duplicate of such a type returns HTTP 400 with error code 10015.
|
|
554
|
+
# Responses merge shared tools into `tools` with `shared: true`; when updating,
|
|
555
|
+
# omit those tools from the `tools` array and manage them through `tool_ids`
|
|
556
|
+
# instead.
|
|
524
557
|
tools: nil,
|
|
525
558
|
transcription: nil,
|
|
526
559
|
# Human-readable name for the assistant version.
|
|
@@ -565,11 +598,12 @@ module Telnyx
|
|
|
565
598
|
tools:
|
|
566
599
|
T::Array[
|
|
567
600
|
T.any(
|
|
601
|
+
Telnyx::AI::AssistantTool::Function,
|
|
568
602
|
Telnyx::AI::InferenceEmbeddingWebhookToolParams,
|
|
569
603
|
Telnyx::AI::AssistantTool::ClientSideTool,
|
|
570
604
|
Telnyx::AI::RetrievalTool,
|
|
571
605
|
Telnyx::AI::AssistantTool::Handoff,
|
|
572
|
-
Telnyx::AI::
|
|
606
|
+
Telnyx::AI::AssistantTool::Hangup,
|
|
573
607
|
Telnyx::AI::AssistantTool::Transfer,
|
|
574
608
|
Telnyx::AI::AssistantTool::Invite,
|
|
575
609
|
Telnyx::AI::AssistantTool::Refer,
|
|
@@ -582,7 +616,7 @@ module Telnyx
|
|
|
582
616
|
],
|
|
583
617
|
transcription: Telnyx::AI::TranscriptionSettings,
|
|
584
618
|
version_name: String,
|
|
585
|
-
voice_settings: Telnyx::AI::
|
|
619
|
+
voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings,
|
|
586
620
|
widget_settings: Telnyx::AI::WidgetSettings
|
|
587
621
|
}
|
|
588
622
|
)
|
|
@@ -14,15 +14,19 @@ module Telnyx
|
|
|
14
14
|
|
|
15
15
|
# ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but
|
|
16
16
|
# English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly
|
|
17
|
-
# higher latency. `deepgram
|
|
18
|
-
#
|
|
17
|
+
# higher latency. The `deepgram/*` models only accept mp3/wav files:
|
|
18
|
+
# `deepgram/nova-3` covers ~49 languages plus `multi` and `deepgram/nova-2` covers
|
|
19
|
+
# ~33, while the `-medical` variants are tuned for clinical vocabulary and accept
|
|
20
|
+
# English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
|
|
21
|
+
# `nvidia/parakeet-v3` is multilingual with automatic language detection;
|
|
22
|
+
# `omi-health/omi-med-stt-v1` is a medical model, English only.
|
|
19
23
|
sig { returns(Telnyx::AI::AudioTranscribeParams::Model::OrSymbol) }
|
|
20
24
|
attr_accessor :model
|
|
21
25
|
|
|
22
26
|
# The audio file object to transcribe, in one of these formats: flac, mp3, mp4,
|
|
23
27
|
# mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB. Cannot
|
|
24
|
-
# be used together with `file_url`. Note: `deepgram
|
|
25
|
-
# wav formats.
|
|
28
|
+
# be used together with `file_url`. Note: the `deepgram/*` models only support mp3
|
|
29
|
+
# and wav formats.
|
|
26
30
|
sig { returns(T.nilable(Telnyx::Internal::FileInput)) }
|
|
27
31
|
attr_reader :file
|
|
28
32
|
|
|
@@ -31,25 +35,32 @@ module Telnyx
|
|
|
31
35
|
|
|
32
36
|
# Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a,
|
|
33
37
|
# ogg, wav, or webm. Support for hosted files is limited to 100MB. Cannot be used
|
|
34
|
-
# together with `file`. Note: `deepgram
|
|
38
|
+
# together with `file`. Note: the `deepgram/*` models only support mp3 and wav
|
|
39
|
+
# formats.
|
|
35
40
|
sig { returns(T.nilable(String)) }
|
|
36
41
|
attr_reader :file_url
|
|
37
42
|
|
|
38
43
|
sig { params(file_url: String).void }
|
|
39
44
|
attr_writer :file_url
|
|
40
45
|
|
|
41
|
-
# The language of the audio to be transcribed.
|
|
42
|
-
#
|
|
46
|
+
# The language of the audio to be transcribed. `deepgram/nova-3` supports ~49
|
|
47
|
+
# languages plus `multi`, and `deepgram/nova-2` supports ~33 plus `multi`; the
|
|
48
|
+
# `-medical` variants are English only (`en` and its regional variants, e.g.
|
|
49
|
+
# `en-US`, `en-GB`). Deepgram models validate on the base language and forward the
|
|
50
|
+
# full tag, so regional variants such as `de-CH` and `pt-BR` are accepted where
|
|
51
|
+
# the base language is supported; an unsupported language returns a 400. For
|
|
43
52
|
# `openai/whisper-large-v3-turbo`, supports multiple languages.
|
|
44
53
|
# `distil-whisper/distil-large-v2` does not support language parameter.
|
|
54
|
+
# `nvidia/parakeet-v3` detects the language automatically;
|
|
55
|
+
# `omi-health/omi-med-stt-v1` is English only.
|
|
45
56
|
sig { returns(T.nilable(String)) }
|
|
46
57
|
attr_reader :language
|
|
47
58
|
|
|
48
59
|
sig { params(language: String).void }
|
|
49
60
|
attr_writer :language
|
|
50
61
|
|
|
51
|
-
# Additional model-specific configuration parameters. Only allowed with
|
|
52
|
-
# `deepgram
|
|
62
|
+
# Additional model-specific configuration parameters. Only allowed with the
|
|
63
|
+
# `deepgram/*` models. Can include Deepgram-specific options such as
|
|
53
64
|
# `smart_format`, `punctuate`, `diarize`, `utterance`, `numerals`, and `language`.
|
|
54
65
|
# If `language` is provided both as a top-level parameter and in `model_config`,
|
|
55
66
|
# the top-level parameter takes precedence.
|
|
@@ -115,25 +126,36 @@ module Telnyx
|
|
|
115
126
|
def self.new(
|
|
116
127
|
# ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but
|
|
117
128
|
# English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly
|
|
118
|
-
# higher latency. `deepgram
|
|
119
|
-
#
|
|
129
|
+
# higher latency. The `deepgram/*` models only accept mp3/wav files:
|
|
130
|
+
# `deepgram/nova-3` covers ~49 languages plus `multi` and `deepgram/nova-2` covers
|
|
131
|
+
# ~33, while the `-medical` variants are tuned for clinical vocabulary and accept
|
|
132
|
+
# English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
|
|
133
|
+
# `nvidia/parakeet-v3` is multilingual with automatic language detection;
|
|
134
|
+
# `omi-health/omi-med-stt-v1` is a medical model, English only.
|
|
120
135
|
model:,
|
|
121
136
|
# The audio file object to transcribe, in one of these formats: flac, mp3, mp4,
|
|
122
137
|
# mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB. Cannot
|
|
123
|
-
# be used together with `file_url`. Note: `deepgram
|
|
124
|
-
# wav formats.
|
|
138
|
+
# be used together with `file_url`. Note: the `deepgram/*` models only support mp3
|
|
139
|
+
# and wav formats.
|
|
125
140
|
file: nil,
|
|
126
141
|
# Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a,
|
|
127
142
|
# ogg, wav, or webm. Support for hosted files is limited to 100MB. Cannot be used
|
|
128
|
-
# together with `file`. Note: `deepgram
|
|
143
|
+
# together with `file`. Note: the `deepgram/*` models only support mp3 and wav
|
|
144
|
+
# formats.
|
|
129
145
|
file_url: nil,
|
|
130
|
-
# The language of the audio to be transcribed.
|
|
131
|
-
#
|
|
146
|
+
# The language of the audio to be transcribed. `deepgram/nova-3` supports ~49
|
|
147
|
+
# languages plus `multi`, and `deepgram/nova-2` supports ~33 plus `multi`; the
|
|
148
|
+
# `-medical` variants are English only (`en` and its regional variants, e.g.
|
|
149
|
+
# `en-US`, `en-GB`). Deepgram models validate on the base language and forward the
|
|
150
|
+
# full tag, so regional variants such as `de-CH` and `pt-BR` are accepted where
|
|
151
|
+
# the base language is supported; an unsupported language returns a 400. For
|
|
132
152
|
# `openai/whisper-large-v3-turbo`, supports multiple languages.
|
|
133
153
|
# `distil-whisper/distil-large-v2` does not support language parameter.
|
|
154
|
+
# `nvidia/parakeet-v3` detects the language automatically;
|
|
155
|
+
# `omi-health/omi-med-stt-v1` is English only.
|
|
134
156
|
language: nil,
|
|
135
|
-
# Additional model-specific configuration parameters. Only allowed with
|
|
136
|
-
# `deepgram
|
|
157
|
+
# Additional model-specific configuration parameters. Only allowed with the
|
|
158
|
+
# `deepgram/*` models. Can include Deepgram-specific options such as
|
|
137
159
|
# `smart_format`, `punctuate`, `diarize`, `utterance`, `numerals`, and `language`.
|
|
138
160
|
# If `language` is provided both as a top-level parameter and in `model_config`,
|
|
139
161
|
# the top-level parameter takes precedence.
|
|
@@ -170,8 +192,12 @@ module Telnyx
|
|
|
170
192
|
|
|
171
193
|
# ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but
|
|
172
194
|
# English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly
|
|
173
|
-
# higher latency. `deepgram
|
|
174
|
-
#
|
|
195
|
+
# higher latency. The `deepgram/*` models only accept mp3/wav files:
|
|
196
|
+
# `deepgram/nova-3` covers ~49 languages plus `multi` and `deepgram/nova-2` covers
|
|
197
|
+
# ~33, while the `-medical` variants are tuned for clinical vocabulary and accept
|
|
198
|
+
# English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
|
|
199
|
+
# `nvidia/parakeet-v3` is multilingual with automatic language detection;
|
|
200
|
+
# `omi-health/omi-med-stt-v1` is a medical model, English only.
|
|
175
201
|
module Model
|
|
176
202
|
extend Telnyx::Internal::Type::Enum
|
|
177
203
|
|
|
@@ -191,11 +217,36 @@ module Telnyx
|
|
|
191
217
|
:"openai/whisper-large-v3-turbo",
|
|
192
218
|
Telnyx::AI::AudioTranscribeParams::Model::TaggedSymbol
|
|
193
219
|
)
|
|
220
|
+
DEEPGRAM_NOVA_2 =
|
|
221
|
+
T.let(
|
|
222
|
+
:"deepgram/nova-2",
|
|
223
|
+
Telnyx::AI::AudioTranscribeParams::Model::TaggedSymbol
|
|
224
|
+
)
|
|
225
|
+
DEEPGRAM_NOVA_2_MEDICAL =
|
|
226
|
+
T.let(
|
|
227
|
+
:"deepgram/nova-2-medical",
|
|
228
|
+
Telnyx::AI::AudioTranscribeParams::Model::TaggedSymbol
|
|
229
|
+
)
|
|
194
230
|
DEEPGRAM_NOVA_3 =
|
|
195
231
|
T.let(
|
|
196
232
|
:"deepgram/nova-3",
|
|
197
233
|
Telnyx::AI::AudioTranscribeParams::Model::TaggedSymbol
|
|
198
234
|
)
|
|
235
|
+
DEEPGRAM_NOVA_3_MEDICAL =
|
|
236
|
+
T.let(
|
|
237
|
+
:"deepgram/nova-3-medical",
|
|
238
|
+
Telnyx::AI::AudioTranscribeParams::Model::TaggedSymbol
|
|
239
|
+
)
|
|
240
|
+
NVIDIA_PARAKEET_V3 =
|
|
241
|
+
T.let(
|
|
242
|
+
:"nvidia/parakeet-v3",
|
|
243
|
+
Telnyx::AI::AudioTranscribeParams::Model::TaggedSymbol
|
|
244
|
+
)
|
|
245
|
+
OMI_HEALTH_OMI_MED_STT_V1 =
|
|
246
|
+
T.let(
|
|
247
|
+
:"omi-health/omi-med-stt-v1",
|
|
248
|
+
Telnyx::AI::AudioTranscribeParams::Model::TaggedSymbol
|
|
249
|
+
)
|
|
199
250
|
|
|
200
251
|
sig do
|
|
201
252
|
override.returns(
|