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
|
@@ -11,8 +11,12 @@ module Telnyx
|
|
|
11
11
|
# @!attribute model
|
|
12
12
|
# ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but
|
|
13
13
|
# English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly
|
|
14
|
-
# higher latency. `deepgram
|
|
15
|
-
#
|
|
14
|
+
# higher latency. The `deepgram/*` models only accept mp3/wav files:
|
|
15
|
+
# `deepgram/nova-3` covers ~49 languages plus `multi` and `deepgram/nova-2` covers
|
|
16
|
+
# ~33, while the `-medical` variants are tuned for clinical vocabulary and accept
|
|
17
|
+
# English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
|
|
18
|
+
# `nvidia/parakeet-v3` is multilingual with automatic language detection;
|
|
19
|
+
# `omi-health/omi-med-stt-v1` is a medical model, English only.
|
|
16
20
|
#
|
|
17
21
|
# @return [Symbol, Telnyx::Models::AI::AudioTranscribeParams::Model]
|
|
18
22
|
required :model, enum: -> { Telnyx::AI::AudioTranscribeParams::Model }
|
|
@@ -20,8 +24,8 @@ module Telnyx
|
|
|
20
24
|
# @!attribute file
|
|
21
25
|
# The audio file object to transcribe, in one of these formats: flac, mp3, mp4,
|
|
22
26
|
# mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB. Cannot
|
|
23
|
-
# be used together with `file_url`. Note: `deepgram
|
|
24
|
-
# wav formats.
|
|
27
|
+
# be used together with `file_url`. Note: the `deepgram/*` models only support mp3
|
|
28
|
+
# and wav formats.
|
|
25
29
|
#
|
|
26
30
|
# @return [Pathname, StringIO, IO, String, Telnyx::FilePart, nil]
|
|
27
31
|
optional :file, Telnyx::Internal::Type::FileInput
|
|
@@ -29,23 +33,30 @@ module Telnyx
|
|
|
29
33
|
# @!attribute file_url
|
|
30
34
|
# Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a,
|
|
31
35
|
# ogg, wav, or webm. Support for hosted files is limited to 100MB. Cannot be used
|
|
32
|
-
# together with `file`. Note: `deepgram
|
|
36
|
+
# together with `file`. Note: the `deepgram/*` models only support mp3 and wav
|
|
37
|
+
# formats.
|
|
33
38
|
#
|
|
34
39
|
# @return [String, nil]
|
|
35
40
|
optional :file_url, String
|
|
36
41
|
|
|
37
42
|
# @!attribute language
|
|
38
|
-
# The language of the audio to be transcribed.
|
|
39
|
-
#
|
|
43
|
+
# The language of the audio to be transcribed. `deepgram/nova-3` supports ~49
|
|
44
|
+
# languages plus `multi`, and `deepgram/nova-2` supports ~33 plus `multi`; the
|
|
45
|
+
# `-medical` variants are English only (`en` and its regional variants, e.g.
|
|
46
|
+
# `en-US`, `en-GB`). Deepgram models validate on the base language and forward the
|
|
47
|
+
# full tag, so regional variants such as `de-CH` and `pt-BR` are accepted where
|
|
48
|
+
# the base language is supported; an unsupported language returns a 400. For
|
|
40
49
|
# `openai/whisper-large-v3-turbo`, supports multiple languages.
|
|
41
50
|
# `distil-whisper/distil-large-v2` does not support language parameter.
|
|
51
|
+
# `nvidia/parakeet-v3` detects the language automatically;
|
|
52
|
+
# `omi-health/omi-med-stt-v1` is English only.
|
|
42
53
|
#
|
|
43
54
|
# @return [String, nil]
|
|
44
55
|
optional :language, String
|
|
45
56
|
|
|
46
57
|
# @!attribute model_config
|
|
47
|
-
# Additional model-specific configuration parameters. Only allowed with
|
|
48
|
-
# `deepgram
|
|
58
|
+
# Additional model-specific configuration parameters. Only allowed with the
|
|
59
|
+
# `deepgram/*` models. Can include Deepgram-specific options such as
|
|
49
60
|
# `smart_format`, `punctuate`, `diarize`, `utterance`, `numerals`, and `language`.
|
|
50
61
|
# If `language` is provided both as a top-level parameter and in `model_config`,
|
|
51
62
|
# the top-level parameter takes precedence.
|
|
@@ -80,9 +91,9 @@ module Telnyx
|
|
|
80
91
|
#
|
|
81
92
|
# @param file_url [String] Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg
|
|
82
93
|
#
|
|
83
|
-
# @param language [String] The language of the audio to be transcribed.
|
|
94
|
+
# @param language [String] The language of the audio to be transcribed. `deepgram/nova-3` supports ~49 lang
|
|
84
95
|
#
|
|
85
|
-
# @param model_config [Hash{Symbol=>Object}] Additional model-specific configuration parameters. Only allowed with `
|
|
96
|
+
# @param model_config [Hash{Symbol=>Object}] Additional model-specific configuration parameters. Only allowed with the `deepg
|
|
86
97
|
#
|
|
87
98
|
# @param response_format [Symbol, Telnyx::Models::AI::AudioTranscribeParams::ResponseFormat] The format of the transcript output. Use `verbose_json` to take advantage of tim
|
|
88
99
|
#
|
|
@@ -92,14 +103,23 @@ module Telnyx
|
|
|
92
103
|
|
|
93
104
|
# ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but
|
|
94
105
|
# English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly
|
|
95
|
-
# higher latency. `deepgram
|
|
96
|
-
#
|
|
106
|
+
# higher latency. The `deepgram/*` models only accept mp3/wav files:
|
|
107
|
+
# `deepgram/nova-3` covers ~49 languages plus `multi` and `deepgram/nova-2` covers
|
|
108
|
+
# ~33, while the `-medical` variants are tuned for clinical vocabulary and accept
|
|
109
|
+
# English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
|
|
110
|
+
# `nvidia/parakeet-v3` is multilingual with automatic language detection;
|
|
111
|
+
# `omi-health/omi-med-stt-v1` is a medical model, English only.
|
|
97
112
|
module Model
|
|
98
113
|
extend Telnyx::Internal::Type::Enum
|
|
99
114
|
|
|
100
115
|
DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
|
|
101
116
|
OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
|
|
117
|
+
DEEPGRAM_NOVA_2 = :"deepgram/nova-2"
|
|
118
|
+
DEEPGRAM_NOVA_2_MEDICAL = :"deepgram/nova-2-medical"
|
|
102
119
|
DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
|
|
120
|
+
DEEPGRAM_NOVA_3_MEDICAL = :"deepgram/nova-3-medical"
|
|
121
|
+
NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
|
|
122
|
+
OMI_HEALTH_OMI_MED_STT_V1 = :"omi-health/omi-med-stt-v1"
|
|
103
123
|
|
|
104
124
|
# @!method self.values
|
|
105
125
|
# @return [Array<Symbol>]
|
|
@@ -13,27 +13,29 @@ module Telnyx
|
|
|
13
13
|
|
|
14
14
|
# @!attribute duration
|
|
15
15
|
# The duration of the audio file in seconds. Returned by
|
|
16
|
-
# `distil-whisper/distil-large-v2` and `deepgram
|
|
17
|
-
# `verbose_json`. Not returned by
|
|
16
|
+
# `distil-whisper/distil-large-v2` and the `deepgram/*` models when
|
|
17
|
+
# `response_format` is `verbose_json`. Not returned by
|
|
18
|
+
# `openai/whisper-large-v3-turbo`.
|
|
18
19
|
#
|
|
19
20
|
# @return [Float, nil]
|
|
20
21
|
optional :duration, Float
|
|
21
22
|
|
|
22
23
|
# @!attribute segments
|
|
23
24
|
# Segments of the transcribed text and their corresponding details. Returned by
|
|
24
|
-
# `distil-whisper/distil-large-v2`
|
|
25
|
-
#
|
|
25
|
+
# `distil-whisper/distil-large-v2` and the `deepgram/*` models when
|
|
26
|
+
# `response_format` is `verbose_json`; Deepgram segments also carry nested `words`
|
|
27
|
+
# and `speakers`. Not returned by `openai/whisper-large-v3-turbo`.
|
|
26
28
|
#
|
|
27
29
|
# @return [Array<Telnyx::Models::AI::AudioTranscribeResponse::Segment>, nil]
|
|
28
30
|
optional :segments,
|
|
29
31
|
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::AudioTranscribeResponse::Segment] }
|
|
30
32
|
|
|
31
33
|
# @!attribute words
|
|
32
|
-
# Word-level timestamps and optional speaker labels. Only returned by
|
|
33
|
-
# `deepgram
|
|
34
|
+
# Word-level timestamps and optional speaker labels. Only returned by the
|
|
35
|
+
# `deepgram/*` models when word-level output is enabled via `model_config`.
|
|
34
36
|
#
|
|
35
|
-
# @return [Array<Telnyx::Models::AI::
|
|
36
|
-
optional :words, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::
|
|
37
|
+
# @return [Array<Telnyx::Models::AI::AudioTranscriptionResponseWord>, nil]
|
|
38
|
+
optional :words, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AudioTranscriptionResponseWord] }
|
|
37
39
|
|
|
38
40
|
# @!method initialize(text:, duration: nil, segments: nil, words: nil)
|
|
39
41
|
# Some parameter documentations has been truncated, see
|
|
@@ -41,9 +43,10 @@ module Telnyx
|
|
|
41
43
|
#
|
|
42
44
|
# Response fields vary by model. `distil-whisper/distil-large-v2` returns `text`,
|
|
43
45
|
# `duration`, and `segments` in `verbose_json` mode.
|
|
44
|
-
# `openai/whisper-large-v3-turbo` returns `text` only. `deepgram
|
|
45
|
-
# `text` and, depending on `model_config`, may include `words` with
|
|
46
|
-
# timestamps and speaker labels.
|
|
46
|
+
# `openai/whisper-large-v3-turbo` returns `text` only. The `deepgram/*` models
|
|
47
|
+
# return `text` and, depending on `model_config`, may include `words` with
|
|
48
|
+
# per-word timestamps and speaker labels. The Parakeet models
|
|
49
|
+
# (`nvidia/parakeet-v3`, `omi-health/omi-med-stt-v1`) return `text` only.
|
|
47
50
|
#
|
|
48
51
|
# @param text [String] The transcribed text for the audio file.
|
|
49
52
|
#
|
|
@@ -51,7 +54,7 @@ module Telnyx
|
|
|
51
54
|
#
|
|
52
55
|
# @param segments [Array<Telnyx::Models::AI::AudioTranscribeResponse::Segment>] Segments of the transcribed text and their corresponding details. Returned by `d
|
|
53
56
|
#
|
|
54
|
-
# @param words [Array<Telnyx::Models::AI::
|
|
57
|
+
# @param words [Array<Telnyx::Models::AI::AudioTranscriptionResponseWord>] Word-level timestamps and optional speaker labels. Only returned by the `deepgra
|
|
55
58
|
|
|
56
59
|
class Segment < Telnyx::Internal::Type::BaseModel
|
|
57
60
|
# @!attribute id
|
|
@@ -78,60 +81,35 @@ module Telnyx
|
|
|
78
81
|
# @return [String]
|
|
79
82
|
required :text, String
|
|
80
83
|
|
|
81
|
-
# @!
|
|
82
|
-
#
|
|
83
|
-
#
|
|
84
|
-
# @param end_ [Float] End time of the segment in seconds.
|
|
84
|
+
# @!attribute speakers
|
|
85
|
+
# Speaker indices heard in this segment. Returned by the `deepgram/*` models when
|
|
86
|
+
# `diarize` is enabled via `model_config`.
|
|
85
87
|
#
|
|
86
|
-
# @
|
|
87
|
-
|
|
88
|
-
# @param text [String] Text content of the segment.
|
|
89
|
-
end
|
|
88
|
+
# @return [Array<Integer>, nil]
|
|
89
|
+
optional :speakers, Telnyx::Internal::Type::ArrayOf[Integer]
|
|
90
90
|
|
|
91
|
-
|
|
92
|
-
#
|
|
93
|
-
#
|
|
91
|
+
# @!attribute words
|
|
92
|
+
# Word-level timing detail for this segment. Returned by the `deepgram/*` models
|
|
93
|
+
# when word-level output is enabled via `model_config`.
|
|
94
94
|
#
|
|
95
|
-
# @return [
|
|
96
|
-
|
|
95
|
+
# @return [Array<Telnyx::Models::AI::AudioTranscriptionResponseWord>, nil]
|
|
96
|
+
optional :words, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AudioTranscriptionResponseWord] }
|
|
97
97
|
|
|
98
|
-
# @!
|
|
99
|
-
#
|
|
98
|
+
# @!method initialize(id:, end_:, start:, text:, speakers: nil, words: nil)
|
|
99
|
+
# Some parameter documentations has been truncated, see
|
|
100
|
+
# {Telnyx::Models::AI::AudioTranscribeResponse::Segment} for more details.
|
|
100
101
|
#
|
|
101
|
-
# @
|
|
102
|
-
required :start, Float
|
|
103
|
-
|
|
104
|
-
# @!attribute word
|
|
105
|
-
# The transcribed word.
|
|
106
|
-
#
|
|
107
|
-
# @return [String]
|
|
108
|
-
required :word, String
|
|
109
|
-
|
|
110
|
-
# @!attribute confidence
|
|
111
|
-
# Confidence score for the word (0.0 to 1.0).
|
|
112
|
-
#
|
|
113
|
-
# @return [Float, nil]
|
|
114
|
-
optional :confidence, Float
|
|
115
|
-
|
|
116
|
-
# @!attribute speaker
|
|
117
|
-
# Speaker index. Only present when diarization is enabled via `model_config`.
|
|
118
|
-
#
|
|
119
|
-
# @return [Integer, nil]
|
|
120
|
-
optional :speaker, Integer
|
|
121
|
-
|
|
122
|
-
# @!method initialize(end_:, start:, word:, confidence: nil, speaker: nil)
|
|
123
|
-
# Word-level timing detail. Only present when using `deepgram/nova-3` with
|
|
124
|
-
# `model_config` options that enable word timestamps.
|
|
102
|
+
# @param id [Float] Unique identifier of the segment.
|
|
125
103
|
#
|
|
126
|
-
# @param end_ [Float] End time of the
|
|
104
|
+
# @param end_ [Float] End time of the segment in seconds.
|
|
127
105
|
#
|
|
128
|
-
# @param start [Float] Start time of the
|
|
106
|
+
# @param start [Float] Start time of the segment in seconds.
|
|
129
107
|
#
|
|
130
|
-
# @param
|
|
108
|
+
# @param text [String] Text content of the segment.
|
|
131
109
|
#
|
|
132
|
-
# @param
|
|
110
|
+
# @param speakers [Array<Integer>] Speaker indices heard in this segment. Returned by the `deepgram/*` models when
|
|
133
111
|
#
|
|
134
|
-
# @param
|
|
112
|
+
# @param words [Array<Telnyx::Models::AI::AudioTranscriptionResponseWord>] Word-level timing detail for this segment. Returned by the `deepgram/*` models w
|
|
135
113
|
end
|
|
136
114
|
end
|
|
137
115
|
end
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
class AudioTranscriptionResponseWord < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute end_
|
|
8
|
+
# End time of the word in seconds.
|
|
9
|
+
#
|
|
10
|
+
# @return [Float]
|
|
11
|
+
required :end_, Float, api_name: :end
|
|
12
|
+
|
|
13
|
+
# @!attribute start
|
|
14
|
+
# Start time of the word in seconds.
|
|
15
|
+
#
|
|
16
|
+
# @return [Float]
|
|
17
|
+
required :start, Float
|
|
18
|
+
|
|
19
|
+
# @!attribute word
|
|
20
|
+
# The transcribed word.
|
|
21
|
+
#
|
|
22
|
+
# @return [String]
|
|
23
|
+
required :word, String
|
|
24
|
+
|
|
25
|
+
# @!attribute confidence
|
|
26
|
+
# Confidence score for the word (0.0 to 1.0).
|
|
27
|
+
#
|
|
28
|
+
# @return [Float, nil]
|
|
29
|
+
optional :confidence, Float
|
|
30
|
+
|
|
31
|
+
# @!attribute punctuated_word
|
|
32
|
+
# The transcribed word with punctuation and capitalisation applied. Only present
|
|
33
|
+
# when `punctuate` or `smart_format` is enabled via `model_config`.
|
|
34
|
+
#
|
|
35
|
+
# @return [String, nil]
|
|
36
|
+
optional :punctuated_word, String
|
|
37
|
+
|
|
38
|
+
# @!attribute speaker
|
|
39
|
+
# Speaker index. Only present when diarization is enabled via `model_config`.
|
|
40
|
+
#
|
|
41
|
+
# @return [Integer, nil]
|
|
42
|
+
optional :speaker, Integer
|
|
43
|
+
|
|
44
|
+
# @!attribute speaker_confidence
|
|
45
|
+
# Confidence score for the speaker assignment (0.0 to 1.0). Only present when
|
|
46
|
+
# diarization is enabled via `model_config`.
|
|
47
|
+
#
|
|
48
|
+
# @return [Float, nil]
|
|
49
|
+
optional :speaker_confidence, Float
|
|
50
|
+
|
|
51
|
+
# @!method initialize(end_:, start:, word:, confidence: nil, punctuated_word: nil, speaker: nil, speaker_confidence: nil)
|
|
52
|
+
# Some parameter documentations has been truncated, see
|
|
53
|
+
# {Telnyx::Models::AI::AudioTranscriptionResponseWord} for more details.
|
|
54
|
+
#
|
|
55
|
+
# Word-level timing detail. Only present when using a `deepgram/*` model with
|
|
56
|
+
# `model_config` options that enable word timestamps.
|
|
57
|
+
#
|
|
58
|
+
# @param end_ [Float] End time of the word in seconds.
|
|
59
|
+
#
|
|
60
|
+
# @param start [Float] Start time of the word in seconds.
|
|
61
|
+
#
|
|
62
|
+
# @param word [String] The transcribed word.
|
|
63
|
+
#
|
|
64
|
+
# @param confidence [Float] Confidence score for the word (0.0 to 1.0).
|
|
65
|
+
#
|
|
66
|
+
# @param punctuated_word [String] The transcribed word with punctuation and capitalisation applied. Only present w
|
|
67
|
+
#
|
|
68
|
+
# @param speaker [Integer] Speaker index. Only present when diarization is enabled via `model_config`.
|
|
69
|
+
#
|
|
70
|
+
# @param speaker_confidence [Float] Confidence score for the speaker assignment (0.0 to 1.0). Only present when diar
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
@@ -571,8 +571,8 @@ module Telnyx
|
|
|
571
571
|
class Function < Telnyx::Internal::Type::BaseModel
|
|
572
572
|
# @!attribute function
|
|
573
573
|
#
|
|
574
|
-
# @return [Telnyx::Models::AI::
|
|
575
|
-
required :function, -> { Telnyx::AI::
|
|
574
|
+
# @return [Telnyx::Models::AI::OpenAI::FunctionDefinition]
|
|
575
|
+
required :function, -> { Telnyx::AI::OpenAI::FunctionDefinition }
|
|
576
576
|
|
|
577
577
|
# @!attribute type
|
|
578
578
|
#
|
|
@@ -580,31 +580,8 @@ module Telnyx
|
|
|
580
580
|
required :type, const: :function
|
|
581
581
|
|
|
582
582
|
# @!method initialize(function:, type: :function)
|
|
583
|
-
# @param function [Telnyx::Models::AI::
|
|
583
|
+
# @param function [Telnyx::Models::AI::OpenAI::FunctionDefinition]
|
|
584
584
|
# @param type [Symbol, :function]
|
|
585
|
-
|
|
586
|
-
# @see Telnyx::Models::AI::ChatCompletionRequest::Tool::Function#function
|
|
587
|
-
class Function < Telnyx::Internal::Type::BaseModel
|
|
588
|
-
# @!attribute name
|
|
589
|
-
#
|
|
590
|
-
# @return [String]
|
|
591
|
-
required :name, String
|
|
592
|
-
|
|
593
|
-
# @!attribute description
|
|
594
|
-
#
|
|
595
|
-
# @return [String, nil]
|
|
596
|
-
optional :description, String
|
|
597
|
-
|
|
598
|
-
# @!attribute parameters
|
|
599
|
-
#
|
|
600
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
601
|
-
optional :parameters, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
602
|
-
|
|
603
|
-
# @!method initialize(name:, description: nil, parameters: nil)
|
|
604
|
-
# @param name [String]
|
|
605
|
-
# @param description [String]
|
|
606
|
-
# @param parameters [Hash{Symbol=>Object}]
|
|
607
|
-
end
|
|
608
585
|
end
|
|
609
586
|
|
|
610
587
|
class Retrieval < Telnyx::Internal::Type::BaseModel
|
|
@@ -38,8 +38,8 @@ module Telnyx
|
|
|
38
38
|
|
|
39
39
|
# @!attribute sources
|
|
40
40
|
#
|
|
41
|
-
# @return [Array<Telnyx::Models::AI::Collections::
|
|
42
|
-
optional :sources, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::
|
|
41
|
+
# @return [Array<Telnyx::Models::AI::Collections::CollectionsSource>, nil]
|
|
42
|
+
optional :sources, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::CollectionsSource] }
|
|
43
43
|
|
|
44
44
|
# @!attribute status
|
|
45
45
|
#
|
|
@@ -69,7 +69,7 @@ module Telnyx
|
|
|
69
69
|
#
|
|
70
70
|
# @param slug [String]
|
|
71
71
|
#
|
|
72
|
-
# @param sources [Array<Telnyx::Models::AI::Collections::
|
|
72
|
+
# @param sources [Array<Telnyx::Models::AI::Collections::CollectionsSource>]
|
|
73
73
|
#
|
|
74
74
|
# @param status [String]
|
|
75
75
|
#
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
module Collections
|
|
7
|
+
class CollectionsSource < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute id
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute bucket_id
|
|
14
|
+
# The Telnyx Storage bucket name. Present only for `bucket` sources.
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
optional :bucket_id, String
|
|
18
|
+
|
|
19
|
+
# @!attribute collection_id
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :collection_id, String
|
|
23
|
+
|
|
24
|
+
# @!attribute record_type
|
|
25
|
+
# Identifies the record type. Always `ai_collection_source`.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :record_type, String
|
|
29
|
+
|
|
30
|
+
# @!attribute source_type
|
|
31
|
+
# The type of Telnyx data attached as a source. `bucket` requires an additional
|
|
32
|
+
# `bucket_id`. Only `voice` is searchable today; `meeting_bot`, `message`, and
|
|
33
|
+
# `bucket` attach but are not yet searchable (Coming soon).
|
|
34
|
+
#
|
|
35
|
+
# @return [Symbol, Telnyx::Models::AI::Collections::SourceType, nil]
|
|
36
|
+
optional :source_type, enum: -> { Telnyx::AI::Collections::SourceType }
|
|
37
|
+
|
|
38
|
+
# @!attribute status
|
|
39
|
+
#
|
|
40
|
+
# @return [String, nil]
|
|
41
|
+
optional :status, String
|
|
42
|
+
|
|
43
|
+
# @!method initialize(id: nil, bucket_id: nil, collection_id: nil, record_type: nil, source_type: nil, status: nil)
|
|
44
|
+
# Some parameter documentations has been truncated, see
|
|
45
|
+
# {Telnyx::Models::AI::Collections::CollectionsSource} for more details.
|
|
46
|
+
#
|
|
47
|
+
# @param id [String]
|
|
48
|
+
#
|
|
49
|
+
# @param bucket_id [String] The Telnyx Storage bucket name. Present only for `bucket` sources.
|
|
50
|
+
#
|
|
51
|
+
# @param collection_id [String]
|
|
52
|
+
#
|
|
53
|
+
# @param record_type [String] Identifies the record type. Always `ai_collection_source`.
|
|
54
|
+
#
|
|
55
|
+
# @param source_type [Symbol, Telnyx::Models::AI::Collections::SourceType] The type of Telnyx data attached as a source. `bucket` requires an additional `b
|
|
56
|
+
#
|
|
57
|
+
# @param status [String]
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
CollectionsSource = Collections::CollectionsSource
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
@@ -6,55 +6,51 @@ module Telnyx
|
|
|
6
6
|
module Collections
|
|
7
7
|
class Source < Telnyx::Internal::Type::BaseModel
|
|
8
8
|
# @!attribute id
|
|
9
|
+
# Identifies one source within its profile: an ingested session, or one remembered
|
|
10
|
+
# fact. Returned by `ingest` and `remember` when the write is accepted.
|
|
11
|
+
# Re-ingesting a session keeps its source id.
|
|
9
12
|
#
|
|
10
|
-
# @return [String
|
|
11
|
-
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :id, String
|
|
12
15
|
|
|
13
|
-
# @!attribute
|
|
14
|
-
#
|
|
16
|
+
# @!attribute memory_count
|
|
17
|
+
# Memories extracted from this source. A memory derived from several sources is
|
|
18
|
+
# not counted here.
|
|
15
19
|
#
|
|
16
|
-
# @return [
|
|
17
|
-
|
|
20
|
+
# @return [Integer]
|
|
21
|
+
required :memory_count, Integer
|
|
18
22
|
|
|
19
|
-
# @!attribute
|
|
23
|
+
# @!attribute session_id
|
|
24
|
+
# The session this source was ingested as. Null for a remembered fact.
|
|
20
25
|
#
|
|
21
26
|
# @return [String, nil]
|
|
22
|
-
|
|
27
|
+
required :session_id, String, nil?: true
|
|
23
28
|
|
|
24
|
-
# @!attribute
|
|
25
|
-
#
|
|
29
|
+
# @!attribute created_at
|
|
30
|
+
# When the source was first stored.
|
|
26
31
|
#
|
|
27
32
|
# @return [String, nil]
|
|
28
|
-
optional :
|
|
33
|
+
optional :created_at, String, nil?: true
|
|
29
34
|
|
|
30
|
-
# @!attribute
|
|
31
|
-
#
|
|
32
|
-
# `bucket_id`. Only `voice` is searchable today; `meeting_bot`, `message`, and
|
|
33
|
-
# `bucket` attach but are not yet searchable (Coming soon).
|
|
34
|
-
#
|
|
35
|
-
# @return [Symbol, Telnyx::Models::AI::Collections::SourceType, nil]
|
|
36
|
-
optional :source_type, enum: -> { Telnyx::AI::Collections::SourceType }
|
|
37
|
-
|
|
38
|
-
# @!attribute status
|
|
35
|
+
# @!attribute updated_at
|
|
36
|
+
# When the source was last written; re-ingesting moves it.
|
|
39
37
|
#
|
|
40
38
|
# @return [String, nil]
|
|
41
|
-
optional :
|
|
39
|
+
optional :updated_at, String, nil?: true
|
|
42
40
|
|
|
43
|
-
# @!method initialize(id
|
|
41
|
+
# @!method initialize(id:, memory_count:, session_id:, created_at: nil, updated_at: nil)
|
|
44
42
|
# Some parameter documentations has been truncated, see
|
|
45
43
|
# {Telnyx::Models::AI::Collections::Source} for more details.
|
|
46
44
|
#
|
|
47
|
-
# @param id [String]
|
|
48
|
-
#
|
|
49
|
-
# @param bucket_id [String] The Telnyx Storage bucket name. Present only for `bucket` sources.
|
|
45
|
+
# @param id [String] Identifies one source within its profile: an ingested session, or one remembered
|
|
50
46
|
#
|
|
51
|
-
# @param
|
|
47
|
+
# @param memory_count [Integer] Memories extracted from this source. A memory derived from several sources is no
|
|
52
48
|
#
|
|
53
|
-
# @param
|
|
49
|
+
# @param session_id [String, nil] The session this source was ingested as. Null for a remembered fact.
|
|
54
50
|
#
|
|
55
|
-
# @param
|
|
51
|
+
# @param created_at [String, nil] When the source was first stored.
|
|
56
52
|
#
|
|
57
|
-
# @param
|
|
53
|
+
# @param updated_at [String, nil] When the source was last written; re-ingesting moves it.
|
|
58
54
|
end
|
|
59
55
|
end
|
|
60
56
|
end
|
|
@@ -8,13 +8,13 @@ module Telnyx
|
|
|
8
8
|
class SourceCreateResponse < Telnyx::Internal::Type::BaseModel
|
|
9
9
|
# @!attribute data
|
|
10
10
|
#
|
|
11
|
-
# @return [Telnyx::Models::AI::Collections::
|
|
12
|
-
optional :data, -> { Telnyx::AI::Collections::
|
|
11
|
+
# @return [Telnyx::Models::AI::Collections::CollectionsSource, nil]
|
|
12
|
+
optional :data, -> { Telnyx::AI::Collections::CollectionsSource }
|
|
13
13
|
|
|
14
14
|
# @!method initialize(data: nil)
|
|
15
15
|
# Envelope containing a single collection source.
|
|
16
16
|
#
|
|
17
|
-
# @param data [Telnyx::Models::AI::Collections::
|
|
17
|
+
# @param data [Telnyx::Models::AI::Collections::CollectionsSource]
|
|
18
18
|
end
|
|
19
19
|
end
|
|
20
20
|
end
|
|
@@ -8,11 +8,11 @@ module Telnyx
|
|
|
8
8
|
class SourceListResponse < Telnyx::Internal::Type::BaseModel
|
|
9
9
|
# @!attribute data
|
|
10
10
|
#
|
|
11
|
-
# @return [Array<Telnyx::Models::AI::Collections::
|
|
12
|
-
optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::
|
|
11
|
+
# @return [Array<Telnyx::Models::AI::Collections::CollectionsSource>, nil]
|
|
12
|
+
optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::CollectionsSource] }
|
|
13
13
|
|
|
14
14
|
# @!method initialize(data: nil)
|
|
15
|
-
# @param data [Array<Telnyx::Models::AI::Collections::
|
|
15
|
+
# @param data [Array<Telnyx::Models::AI::Collections::CollectionsSource>]
|
|
16
16
|
end
|
|
17
17
|
end
|
|
18
18
|
end
|
|
@@ -8,8 +8,8 @@ module Telnyx
|
|
|
8
8
|
class SourceReplaceResponse < Telnyx::Internal::Type::BaseModel
|
|
9
9
|
# @!attribute data
|
|
10
10
|
#
|
|
11
|
-
# @return [Array<Telnyx::Models::AI::Collections::
|
|
12
|
-
optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::
|
|
11
|
+
# @return [Array<Telnyx::Models::AI::Collections::CollectionsSource>, nil]
|
|
12
|
+
optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::CollectionsSource] }
|
|
13
13
|
|
|
14
14
|
# @!attribute meta
|
|
15
15
|
# Reports which source IDs were added, retained, and removed by a replace
|
|
@@ -22,7 +22,7 @@ module Telnyx
|
|
|
22
22
|
# Some parameter documentations has been truncated, see
|
|
23
23
|
# {Telnyx::Models::AI::Collections::SourceReplaceResponse} for more details.
|
|
24
24
|
#
|
|
25
|
-
# @param data [Array<Telnyx::Models::AI::Collections::
|
|
25
|
+
# @param data [Array<Telnyx::Models::AI::Collections::CollectionsSource>]
|
|
26
26
|
#
|
|
27
27
|
# @param meta [Telnyx::Models::AI::Collections::SourceReplaceResponse::Meta] Reports which source IDs were added, retained, and removed by a replace operatio
|
|
28
28
|
|
|
@@ -78,7 +78,7 @@ module Telnyx
|
|
|
78
78
|
# follow-up fetch per shared tool. Ignored on input — set `shared_tool_ids` to
|
|
79
79
|
# configure a node's tools.
|
|
80
80
|
#
|
|
81
|
-
# @return [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::
|
|
81
|
+
# @return [Array<Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>>, nil]
|
|
82
82
|
optional :tools,
|
|
83
83
|
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool]] }
|
|
84
84
|
|
|
@@ -105,8 +105,8 @@ module Telnyx
|
|
|
105
105
|
# @!attribute voice_settings
|
|
106
106
|
# Per-node voice override (response form).
|
|
107
107
|
#
|
|
108
|
-
# @return [Telnyx::Models::AI::
|
|
109
|
-
optional :voice_settings, -> { Telnyx::AI::
|
|
108
|
+
# @return [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings, nil]
|
|
109
|
+
optional :voice_settings, -> { Telnyx::AI::InferenceEmbeddingVoiceSettings }
|
|
110
110
|
|
|
111
111
|
# @!method initialize(id:, instructions:, external_llm: nil, instructions_mode: nil, llm_api_key_ref: nil, model: nil, name: nil, position: nil, shared_tool_ids: nil, tools: nil, tools_mode: nil, transcription: nil, type: nil, voice_settings: nil)
|
|
112
112
|
# Some parameter documentations has been truncated, see
|
|
@@ -132,7 +132,7 @@ module Telnyx
|
|
|
132
132
|
#
|
|
133
133
|
# @param shared_tool_ids [Array<String>] IDs of shared (org-level) tools available at this node. Knowledge bases are atta
|
|
134
134
|
#
|
|
135
|
-
# @param tools [Array<Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::
|
|
135
|
+
# @param tools [Array<Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>>] Full tool definitions for this node, resolved from `shared_tool_ids` server-side
|
|
136
136
|
#
|
|
137
137
|
# @param tools_mode [Symbol, Telnyx::Models::AI::FlowNode::ToolsMode] How `shared_tool_ids` combine with the assistant-level tool set. `replace` (defa
|
|
138
138
|
#
|
|
@@ -140,7 +140,7 @@ module Telnyx
|
|
|
140
140
|
#
|
|
141
141
|
# @param type [Symbol, Telnyx::Models::AI::FlowNode::Type] Node kind discriminator. `prompt` is an LLM-driven step.
|
|
142
142
|
#
|
|
143
|
-
# @param voice_settings [Telnyx::Models::AI::
|
|
143
|
+
# @param voice_settings [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings] Per-node voice override (response form).
|
|
144
144
|
|
|
145
145
|
# How `instructions` combine with the assistant-level instructions. `replace`
|
|
146
146
|
# (default): the node's instructions are used alone. `append`: the node's
|
|
@@ -98,8 +98,8 @@ module Telnyx
|
|
|
98
98
|
# Per-node voice override. Only fields set here override the assistant-level voice
|
|
99
99
|
# settings; unset fields cascade.
|
|
100
100
|
#
|
|
101
|
-
# @return [Telnyx::Models::AI::
|
|
102
|
-
optional :voice_settings, -> { Telnyx::AI::
|
|
101
|
+
# @return [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings, nil]
|
|
102
|
+
optional :voice_settings, -> { Telnyx::AI::InferenceEmbeddingVoiceSettings }
|
|
103
103
|
|
|
104
104
|
# @!method initialize(id:, instructions:, external_llm: nil, instructions_mode: nil, llm_api_key_ref: nil, model: nil, name: nil, position: nil, shared_tool_ids: nil, tools_mode: nil, transcription: nil, type: nil, voice_settings: nil)
|
|
105
105
|
# Some parameter documentations has been truncated, see
|
|
@@ -134,7 +134,7 @@ module Telnyx
|
|
|
134
134
|
#
|
|
135
135
|
# @param type [Symbol, Telnyx::Models::AI::FlowNodeReq::Type] Node kind discriminator. `prompt` (default) is an LLM-driven step; `tool` is a s
|
|
136
136
|
#
|
|
137
|
-
# @param voice_settings [Telnyx::Models::AI::
|
|
137
|
+
# @param voice_settings [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings] Per-node voice override. Only fields set here override the assistant-level voice
|
|
138
138
|
|
|
139
139
|
# How `instructions` combine with the assistant-level instructions. `replace`
|
|
140
140
|
# (default): the node's instructions are used alone. `append`: the node's
|