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
|
@@ -0,0 +1,296 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
module Typesafe
|
|
7
|
+
# @see Telnyx::Resources::AI::Typesafe::V1#systemone
|
|
8
|
+
class V1SystemoneParams < Telnyx::Internal::Type::BaseModel
|
|
9
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!attribute questions
|
|
13
|
+
# Between 1 and 64 named questions. Each key identifies the corresponding answer.
|
|
14
|
+
#
|
|
15
|
+
# @return [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score}]
|
|
16
|
+
required :questions,
|
|
17
|
+
-> { Telnyx::Internal::Type::HashOf[union: Telnyx::AI::Typesafe::V1SystemoneParams::Question] }
|
|
18
|
+
|
|
19
|
+
# @!attribute state
|
|
20
|
+
# Shared context evaluated by every question.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, Hash{Symbol=>Object}, Array<Object>]
|
|
23
|
+
required :state, union: -> { Telnyx::AI::Typesafe::V1SystemoneParams::State }
|
|
24
|
+
|
|
25
|
+
# @!attribute model
|
|
26
|
+
# Public model alias. telnyx/decision-flash offers the lowest cost and latency;
|
|
27
|
+
# telnyx/decision-pro supports decisions that require long context, including
|
|
28
|
+
# inputs beyond Jev’s 32k per-decision limit. Applies to every question in the
|
|
29
|
+
# request. Other values are rejected.
|
|
30
|
+
#
|
|
31
|
+
# @return [Symbol, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Model, nil]
|
|
32
|
+
optional :model, enum: -> { Telnyx::AI::Typesafe::V1SystemoneParams::Model }
|
|
33
|
+
|
|
34
|
+
# @!method initialize(questions:, state:, model: nil, request_options: {})
|
|
35
|
+
# Some parameter documentations has been truncated, see
|
|
36
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneParams} for more details.
|
|
37
|
+
#
|
|
38
|
+
# @param questions [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score}] Between 1 and 64 named questions. Each key identifies the corresponding answer.
|
|
39
|
+
#
|
|
40
|
+
# @param state [String, Hash{Symbol=>Object}, Array<Object>] Shared context evaluated by every question.
|
|
41
|
+
#
|
|
42
|
+
# @param model [Symbol, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Model] Public model alias. telnyx/decision-flash offers the lowest cost and latency; te
|
|
43
|
+
#
|
|
44
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
45
|
+
|
|
46
|
+
# A choice, yes/no, or ordered-score question.
|
|
47
|
+
module Question
|
|
48
|
+
extend Telnyx::Internal::Type::Union
|
|
49
|
+
|
|
50
|
+
discriminator :type
|
|
51
|
+
|
|
52
|
+
# Select one of the supplied options.
|
|
53
|
+
variant :choice, -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice }
|
|
54
|
+
|
|
55
|
+
# Evaluate a yes/no question. Omit criteria to use Yes and No descriptions.
|
|
56
|
+
variant :noul, -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul }
|
|
57
|
+
|
|
58
|
+
# Rate the state against an ordered rubric.
|
|
59
|
+
variant :score, -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score }
|
|
60
|
+
|
|
61
|
+
class Choice < Telnyx::Internal::Type::BaseModel
|
|
62
|
+
# @!attribute criteria
|
|
63
|
+
# Between 2 and 64 option keys mapped to description strings or null. A null
|
|
64
|
+
# description uses the option key as its text.
|
|
65
|
+
#
|
|
66
|
+
# @return [Hash{Symbol=>String, nil}]
|
|
67
|
+
required :criteria, Telnyx::Internal::Type::HashOf[String, nil?: true]
|
|
68
|
+
|
|
69
|
+
# @!attribute instructions
|
|
70
|
+
# Required instructions describing what to decide about the shared state.
|
|
71
|
+
#
|
|
72
|
+
# @return [String, Hash{Symbol=>Object}, Array<Object>]
|
|
73
|
+
required :instructions,
|
|
74
|
+
union: -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Choice::Instructions }
|
|
75
|
+
|
|
76
|
+
# @!attribute type
|
|
77
|
+
# Question type.
|
|
78
|
+
#
|
|
79
|
+
# @return [Symbol, :choice]
|
|
80
|
+
required :type, const: :choice
|
|
81
|
+
|
|
82
|
+
# @!method initialize(criteria:, instructions:, type: :choice)
|
|
83
|
+
# Some parameter documentations has been truncated, see
|
|
84
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice} for more
|
|
85
|
+
# details.
|
|
86
|
+
#
|
|
87
|
+
# Select one of the supplied options.
|
|
88
|
+
#
|
|
89
|
+
# @param criteria [Hash{Symbol=>String, nil}] Between 2 and 64 option keys mapped to description strings or null. A null descr
|
|
90
|
+
#
|
|
91
|
+
# @param instructions [String, Hash{Symbol=>Object}, Array<Object>] Required instructions describing what to decide about the shared state.
|
|
92
|
+
#
|
|
93
|
+
# @param type [Symbol, :choice] Question type.
|
|
94
|
+
|
|
95
|
+
# Required instructions describing what to decide about the shared state.
|
|
96
|
+
#
|
|
97
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice#instructions
|
|
98
|
+
module Instructions
|
|
99
|
+
extend Telnyx::Internal::Type::Union
|
|
100
|
+
|
|
101
|
+
variant String
|
|
102
|
+
|
|
103
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice::Instructions::UnionMember1Map }
|
|
104
|
+
|
|
105
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice::Instructions::UnionMember2Array }
|
|
106
|
+
|
|
107
|
+
# @!method self.variants
|
|
108
|
+
# @return [Array(String, Hash{Symbol=>Object}, Array<Object>)]
|
|
109
|
+
|
|
110
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
111
|
+
UnionMember1Map = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
112
|
+
|
|
113
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
114
|
+
UnionMember2Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
|
|
115
|
+
end
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
class Noul < Telnyx::Internal::Type::BaseModel
|
|
119
|
+
# @!attribute instructions
|
|
120
|
+
# Required instructions describing what to decide about the shared state.
|
|
121
|
+
#
|
|
122
|
+
# @return [String, Hash{Symbol=>Object}, Array<Object>]
|
|
123
|
+
required :instructions,
|
|
124
|
+
union: -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Instructions }
|
|
125
|
+
|
|
126
|
+
# @!attribute type
|
|
127
|
+
# Question type.
|
|
128
|
+
#
|
|
129
|
+
# @return [Symbol, :noul]
|
|
130
|
+
required :type, const: :noul
|
|
131
|
+
|
|
132
|
+
# @!attribute criteria
|
|
133
|
+
# Optional descriptions for the positive and negative outcomes. Descriptions must
|
|
134
|
+
# be strings.
|
|
135
|
+
#
|
|
136
|
+
# @return [Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria, nil]
|
|
137
|
+
optional :criteria, -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria }
|
|
138
|
+
|
|
139
|
+
# @!method initialize(instructions:, criteria: nil, type: :noul)
|
|
140
|
+
# Some parameter documentations has been truncated, see
|
|
141
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul} for more
|
|
142
|
+
# details.
|
|
143
|
+
#
|
|
144
|
+
# Evaluate a yes/no question. Omit criteria to use Yes and No descriptions.
|
|
145
|
+
#
|
|
146
|
+
# @param instructions [String, Hash{Symbol=>Object}, Array<Object>] Required instructions describing what to decide about the shared state.
|
|
147
|
+
#
|
|
148
|
+
# @param criteria [Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul::Criteria] Optional descriptions for the positive and negative outcomes. Descriptions must
|
|
149
|
+
#
|
|
150
|
+
# @param type [Symbol, :noul] Question type.
|
|
151
|
+
|
|
152
|
+
# Required instructions describing what to decide about the shared state.
|
|
153
|
+
#
|
|
154
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul#instructions
|
|
155
|
+
module Instructions
|
|
156
|
+
extend Telnyx::Internal::Type::Union
|
|
157
|
+
|
|
158
|
+
variant String
|
|
159
|
+
|
|
160
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul::Instructions::UnionMember1Map }
|
|
161
|
+
|
|
162
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul::Instructions::UnionMember2Array }
|
|
163
|
+
|
|
164
|
+
# @!method self.variants
|
|
165
|
+
# @return [Array(String, Hash{Symbol=>Object}, Array<Object>)]
|
|
166
|
+
|
|
167
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
168
|
+
UnionMember1Map = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
169
|
+
|
|
170
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
171
|
+
UnionMember2Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul#criteria
|
|
175
|
+
class Criteria < Telnyx::Internal::Type::BaseModel
|
|
176
|
+
# @!attribute false_
|
|
177
|
+
# Description of the negative outcome.
|
|
178
|
+
#
|
|
179
|
+
# @return [String, nil]
|
|
180
|
+
optional :false_, String, api_name: :false
|
|
181
|
+
|
|
182
|
+
# @!attribute true_
|
|
183
|
+
# Description of the positive outcome.
|
|
184
|
+
#
|
|
185
|
+
# @return [String, nil]
|
|
186
|
+
optional :true_, String, api_name: :true
|
|
187
|
+
|
|
188
|
+
# @!method initialize(false_: nil, true_: nil)
|
|
189
|
+
# Optional descriptions for the positive and negative outcomes. Descriptions must
|
|
190
|
+
# be strings.
|
|
191
|
+
#
|
|
192
|
+
# @param false_ [String] Description of the negative outcome.
|
|
193
|
+
#
|
|
194
|
+
# @param true_ [String] Description of the positive outcome.
|
|
195
|
+
end
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
class Score < Telnyx::Internal::Type::BaseModel
|
|
199
|
+
# @!attribute criteria
|
|
200
|
+
# Between 2 and 64 description strings in ascending score order. Indices start at
|
|
201
|
+
# zero.
|
|
202
|
+
#
|
|
203
|
+
# @return [Array<String>]
|
|
204
|
+
required :criteria, Telnyx::Internal::Type::ArrayOf[String]
|
|
205
|
+
|
|
206
|
+
# @!attribute instructions
|
|
207
|
+
# Required instructions describing what to decide about the shared state.
|
|
208
|
+
#
|
|
209
|
+
# @return [String, Hash{Symbol=>Object}, Array<Object>]
|
|
210
|
+
required :instructions,
|
|
211
|
+
union: -> { Telnyx::AI::Typesafe::V1SystemoneParams::Question::Score::Instructions }
|
|
212
|
+
|
|
213
|
+
# @!attribute type
|
|
214
|
+
# Question type.
|
|
215
|
+
#
|
|
216
|
+
# @return [Symbol, :score]
|
|
217
|
+
required :type, const: :score
|
|
218
|
+
|
|
219
|
+
# @!method initialize(criteria:, instructions:, type: :score)
|
|
220
|
+
# Some parameter documentations has been truncated, see
|
|
221
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score} for more
|
|
222
|
+
# details.
|
|
223
|
+
#
|
|
224
|
+
# Rate the state against an ordered rubric.
|
|
225
|
+
#
|
|
226
|
+
# @param criteria [Array<String>] Between 2 and 64 description strings in ascending score order. Indices start at
|
|
227
|
+
#
|
|
228
|
+
# @param instructions [String, Hash{Symbol=>Object}, Array<Object>] Required instructions describing what to decide about the shared state.
|
|
229
|
+
#
|
|
230
|
+
# @param type [Symbol, :score] Question type.
|
|
231
|
+
|
|
232
|
+
# Required instructions describing what to decide about the shared state.
|
|
233
|
+
#
|
|
234
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score#instructions
|
|
235
|
+
module Instructions
|
|
236
|
+
extend Telnyx::Internal::Type::Union
|
|
237
|
+
|
|
238
|
+
variant String
|
|
239
|
+
|
|
240
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score::Instructions::UnionMember1Map }
|
|
241
|
+
|
|
242
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score::Instructions::UnionMember2Array }
|
|
243
|
+
|
|
244
|
+
# @!method self.variants
|
|
245
|
+
# @return [Array(String, Hash{Symbol=>Object}, Array<Object>)]
|
|
246
|
+
|
|
247
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
248
|
+
UnionMember1Map = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
249
|
+
|
|
250
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
251
|
+
UnionMember2Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
|
|
252
|
+
end
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# @!method self.variants
|
|
256
|
+
# @return [Array(Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score)]
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
# Shared context evaluated by every question.
|
|
260
|
+
module State
|
|
261
|
+
extend Telnyx::Internal::Type::Union
|
|
262
|
+
|
|
263
|
+
variant String
|
|
264
|
+
|
|
265
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::State::UnionMember1Map }
|
|
266
|
+
|
|
267
|
+
variant -> { Telnyx::Models::AI::Typesafe::V1SystemoneParams::State::UnionMember2Array }
|
|
268
|
+
|
|
269
|
+
# @!method self.variants
|
|
270
|
+
# @return [Array(String, Hash{Symbol=>Object}, Array<Object>)]
|
|
271
|
+
|
|
272
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
273
|
+
UnionMember1Map = Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
274
|
+
|
|
275
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
276
|
+
UnionMember2Array = Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]
|
|
277
|
+
end
|
|
278
|
+
|
|
279
|
+
# Public model alias. telnyx/decision-flash offers the lowest cost and latency;
|
|
280
|
+
# telnyx/decision-pro supports decisions that require long context, including
|
|
281
|
+
# inputs beyond Jev’s 32k per-decision limit. Applies to every question in the
|
|
282
|
+
# request. Other values are rejected.
|
|
283
|
+
module Model
|
|
284
|
+
extend Telnyx::Internal::Type::Enum
|
|
285
|
+
|
|
286
|
+
TELNYX_DECISION_FLASH = :"telnyx/decision-flash"
|
|
287
|
+
TELNYX_DECISION_PRO = :"telnyx/decision-pro"
|
|
288
|
+
|
|
289
|
+
# @!method self.values
|
|
290
|
+
# @return [Array<Symbol>]
|
|
291
|
+
end
|
|
292
|
+
end
|
|
293
|
+
end
|
|
294
|
+
end
|
|
295
|
+
end
|
|
296
|
+
end
|
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
module Typesafe
|
|
7
|
+
# @see Telnyx::Resources::AI::Typesafe::V1#systemone
|
|
8
|
+
class V1SystemoneResponse < Telnyx::Internal::Type::BaseModel
|
|
9
|
+
# @!attribute answers
|
|
10
|
+
# Answers keyed by exactly the question IDs in the request. Each answer type
|
|
11
|
+
# matches its question.
|
|
12
|
+
#
|
|
13
|
+
# @return [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score}]
|
|
14
|
+
required :answers,
|
|
15
|
+
-> { Telnyx::Internal::Type::HashOf[union: Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer] }
|
|
16
|
+
|
|
17
|
+
# @!attribute usage
|
|
18
|
+
# Token usage for the completed evaluation.
|
|
19
|
+
#
|
|
20
|
+
# @return [Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage]
|
|
21
|
+
required :usage, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage }
|
|
22
|
+
|
|
23
|
+
response_only do
|
|
24
|
+
# @!attribute model
|
|
25
|
+
# Public model alias used to evaluate the request. Returns telnyx/decision-flash
|
|
26
|
+
# when model was omitted. The underlying model is managed by Telnyx.
|
|
27
|
+
#
|
|
28
|
+
# @return [Symbol, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model]
|
|
29
|
+
required :model, enum: -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model }
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# @!method initialize(answers:, model:, usage:)
|
|
33
|
+
# Some parameter documentations has been truncated, see
|
|
34
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneResponse} for more details.
|
|
35
|
+
#
|
|
36
|
+
# A complete synchronous evaluation. Answers are returned directly without a data
|
|
37
|
+
# wrapper.
|
|
38
|
+
#
|
|
39
|
+
# @param answers [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score}] Answers keyed by exactly the question IDs in the request. Each answer type match
|
|
40
|
+
#
|
|
41
|
+
# @param model [Symbol, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Model] Public model alias used to evaluate the request. Returns telnyx/decision-flash w
|
|
42
|
+
#
|
|
43
|
+
# @param usage [Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage] Token usage for the completed evaluation.
|
|
44
|
+
|
|
45
|
+
# An answer whose type matches its question.
|
|
46
|
+
module Answer
|
|
47
|
+
extend Telnyx::Internal::Type::Union
|
|
48
|
+
|
|
49
|
+
discriminator :type
|
|
50
|
+
|
|
51
|
+
# A selected option and the distribution across all supplied option keys.
|
|
52
|
+
variant :choice, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice }
|
|
53
|
+
|
|
54
|
+
# A yes/no score with no separate confidence or probabilities fields.
|
|
55
|
+
variant :noul, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul }
|
|
56
|
+
|
|
57
|
+
# An expected rating over the ordered criteria.
|
|
58
|
+
variant :score, -> { Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score }
|
|
59
|
+
|
|
60
|
+
class Choice < Telnyx::Internal::Type::BaseModel
|
|
61
|
+
# @!attribute choice
|
|
62
|
+
# The option key with the highest relative score. Ties favor the first option in
|
|
63
|
+
# request order.
|
|
64
|
+
#
|
|
65
|
+
# @return [String]
|
|
66
|
+
required :choice, String
|
|
67
|
+
|
|
68
|
+
# @!attribute confidence
|
|
69
|
+
# Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
|
|
70
|
+
# and N is the number of options. Zero indicates a uniform distribution; one
|
|
71
|
+
# indicates concentration on one option. This is neither the winning probability
|
|
72
|
+
# nor calibrated correctness.
|
|
73
|
+
#
|
|
74
|
+
# @return [Float]
|
|
75
|
+
required :confidence, Float
|
|
76
|
+
|
|
77
|
+
# @!attribute probabilities
|
|
78
|
+
# Relative scores normalized across the supplied options, summing approximately
|
|
79
|
+
# to 1. These are not calibrated probabilities of correctness.
|
|
80
|
+
#
|
|
81
|
+
# @return [Hash{Symbol=>Float}]
|
|
82
|
+
required :probabilities, Telnyx::Internal::Type::HashOf[Float]
|
|
83
|
+
|
|
84
|
+
# @!attribute type
|
|
85
|
+
# Answer type.
|
|
86
|
+
#
|
|
87
|
+
# @return [Symbol, :choice]
|
|
88
|
+
required :type, const: :choice
|
|
89
|
+
|
|
90
|
+
# @!method initialize(choice:, confidence:, probabilities:, type: :choice)
|
|
91
|
+
# Some parameter documentations has been truncated, see
|
|
92
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice} for more
|
|
93
|
+
# details.
|
|
94
|
+
#
|
|
95
|
+
# A selected option and the distribution across all supplied option keys.
|
|
96
|
+
#
|
|
97
|
+
# @param choice [String] The option key with the highest relative score. Ties favor the first option in r
|
|
98
|
+
#
|
|
99
|
+
# @param confidence [Float] Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
|
|
100
|
+
# an
|
|
101
|
+
#
|
|
102
|
+
# @param probabilities [Hash{Symbol=>Float}] Relative scores normalized across the supplied options, summing approximately to
|
|
103
|
+
#
|
|
104
|
+
# @param type [Symbol, :choice] Answer type.
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
class Noul < Telnyx::Internal::Type::BaseModel
|
|
108
|
+
# @!attribute noul
|
|
109
|
+
# Score of the positive outcome. Values near 1 favor yes; values near 0 favor no.
|
|
110
|
+
# This is a number, not a Boolean, and is not calibrated correctness.
|
|
111
|
+
#
|
|
112
|
+
# @return [Float]
|
|
113
|
+
required :noul, Float
|
|
114
|
+
|
|
115
|
+
# @!attribute type
|
|
116
|
+
# Answer type.
|
|
117
|
+
#
|
|
118
|
+
# @return [Symbol, :noul]
|
|
119
|
+
required :type, const: :noul
|
|
120
|
+
|
|
121
|
+
# @!method initialize(noul:, type: :noul)
|
|
122
|
+
# Some parameter documentations has been truncated, see
|
|
123
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul} for more
|
|
124
|
+
# details.
|
|
125
|
+
#
|
|
126
|
+
# A yes/no score with no separate confidence or probabilities fields.
|
|
127
|
+
#
|
|
128
|
+
# @param noul [Float] Score of the positive outcome. Values near 1 favor yes; values near 0 favor no.
|
|
129
|
+
#
|
|
130
|
+
# @param type [Symbol, :noul] Answer type.
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
class Score < Telnyx::Internal::Type::BaseModel
|
|
134
|
+
# @!attribute confidence
|
|
135
|
+
# Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
|
|
136
|
+
# and N is the number of options. Zero indicates a uniform distribution; one
|
|
137
|
+
# indicates concentration on one option. This is neither the winning probability
|
|
138
|
+
# nor calibrated correctness.
|
|
139
|
+
#
|
|
140
|
+
# @return [Float]
|
|
141
|
+
required :confidence, Float
|
|
142
|
+
|
|
143
|
+
# @!attribute legend
|
|
144
|
+
# Criterion descriptions keyed by stringified zero-based indices, such as "0",
|
|
145
|
+
# "1", and "2".
|
|
146
|
+
#
|
|
147
|
+
# @return [Hash{Symbol=>String}]
|
|
148
|
+
required :legend, Telnyx::Internal::Type::HashOf[String]
|
|
149
|
+
|
|
150
|
+
# @!attribute probabilities
|
|
151
|
+
# Relative scores keyed by the same stringified indices as legend.
|
|
152
|
+
#
|
|
153
|
+
# @return [Hash{Symbol=>Float}]
|
|
154
|
+
required :probabilities, Telnyx::Internal::Type::HashOf[Float]
|
|
155
|
+
|
|
156
|
+
# @!attribute score
|
|
157
|
+
# Expected zero-based criterion index: sum(index \* probability). Ranges from 0 to
|
|
158
|
+
# N-1 for N criteria; fractional values are valid.
|
|
159
|
+
#
|
|
160
|
+
# @return [Float]
|
|
161
|
+
required :score, Float
|
|
162
|
+
|
|
163
|
+
# @!attribute type
|
|
164
|
+
# Answer type.
|
|
165
|
+
#
|
|
166
|
+
# @return [Symbol, :score]
|
|
167
|
+
required :type, const: :score
|
|
168
|
+
|
|
169
|
+
# @!method initialize(confidence:, legend:, probabilities:, score:, type: :score)
|
|
170
|
+
# Some parameter documentations has been truncated, see
|
|
171
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score} for more
|
|
172
|
+
# details.
|
|
173
|
+
#
|
|
174
|
+
# An expected rating over the ordered criteria.
|
|
175
|
+
#
|
|
176
|
+
# @param confidence [Float] Normalized entropy confidence: 1 - H(p) / ln(N), where H(p) = -sum(p \* ln(p))
|
|
177
|
+
# an
|
|
178
|
+
#
|
|
179
|
+
# @param legend [Hash{Symbol=>String}] Criterion descriptions keyed by stringified zero-based indices, such as "0", "1"
|
|
180
|
+
#
|
|
181
|
+
# @param probabilities [Hash{Symbol=>Float}] Relative scores keyed by the same stringified indices as legend.
|
|
182
|
+
#
|
|
183
|
+
# @param score [Float] Expected zero-based criterion index: sum(index \* probability). Ranges from 0 to
|
|
184
|
+
#
|
|
185
|
+
# @param type [Symbol, :score] Answer type.
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
# @!method self.variants
|
|
189
|
+
# @return [Array(Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Answer::Score)]
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# Public model alias used to evaluate the request. Returns telnyx/decision-flash
|
|
193
|
+
# when model was omitted. The underlying model is managed by Telnyx.
|
|
194
|
+
#
|
|
195
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneResponse#model
|
|
196
|
+
module Model
|
|
197
|
+
extend Telnyx::Internal::Type::Enum
|
|
198
|
+
|
|
199
|
+
TELNYX_DECISION_FLASH = :"telnyx/decision-flash"
|
|
200
|
+
TELNYX_DECISION_PRO = :"telnyx/decision-pro"
|
|
201
|
+
|
|
202
|
+
# @!method self.values
|
|
203
|
+
# @return [Array<Symbol>]
|
|
204
|
+
end
|
|
205
|
+
|
|
206
|
+
# @see Telnyx::Models::AI::Typesafe::V1SystemoneResponse#usage
|
|
207
|
+
class Usage < Telnyx::Internal::Type::BaseModel
|
|
208
|
+
# @!attribute input_tokens
|
|
209
|
+
# Input tokens processed, including shared-context preparation and question
|
|
210
|
+
# evaluation. This can exceed the token count of the unique input text.
|
|
211
|
+
#
|
|
212
|
+
# @return [Integer]
|
|
213
|
+
required :input_tokens, Integer
|
|
214
|
+
|
|
215
|
+
# @!attribute output_tokens
|
|
216
|
+
# Output tokens used for the evaluation, including shared-context preparation.
|
|
217
|
+
#
|
|
218
|
+
# @return [Integer]
|
|
219
|
+
required :output_tokens, Integer
|
|
220
|
+
|
|
221
|
+
# @!method initialize(input_tokens:, output_tokens:)
|
|
222
|
+
# Some parameter documentations has been truncated, see
|
|
223
|
+
# {Telnyx::Models::AI::Typesafe::V1SystemoneResponse::Usage} for more details.
|
|
224
|
+
#
|
|
225
|
+
# Token usage for the completed evaluation.
|
|
226
|
+
#
|
|
227
|
+
# @param input_tokens [Integer] Input tokens processed, including shared-context preparation and question evalua
|
|
228
|
+
#
|
|
229
|
+
# @param output_tokens [Integer] Output tokens used for the evaluation, including shared-context preparation.
|
|
230
|
+
end
|
|
231
|
+
end
|
|
232
|
+
end
|
|
233
|
+
end
|
|
234
|
+
end
|
|
235
|
+
end
|
|
@@ -14,9 +14,24 @@ module Telnyx
|
|
|
14
14
|
# @return [Telnyx::Models::AI::WebhookTool::Webhook]
|
|
15
15
|
required :webhook, -> { Telnyx::AI::WebhookTool::Webhook }
|
|
16
16
|
|
|
17
|
-
# @!
|
|
17
|
+
# @!attribute timeout_ms
|
|
18
|
+
# The maximum number of milliseconds to wait for the webhook to respond before the
|
|
19
|
+
# tool call is aborted. Set this at the tool level, as a sibling of `type` — a
|
|
20
|
+
# `timeout_ms` nested inside the `webhook` object is not applied, and the tool
|
|
21
|
+
# runs at this default instead.
|
|
22
|
+
#
|
|
23
|
+
# @return [Integer, nil]
|
|
24
|
+
optional :timeout_ms, Integer
|
|
25
|
+
|
|
26
|
+
# @!method initialize(type:, webhook:, timeout_ms: nil)
|
|
27
|
+
# Some parameter documentations has been truncated, see
|
|
28
|
+
# {Telnyx::Models::AI::WebhookTool} for more details.
|
|
29
|
+
#
|
|
18
30
|
# @param type [Symbol, Telnyx::Models::AI::WebhookTool::Type]
|
|
31
|
+
#
|
|
19
32
|
# @param webhook [Telnyx::Models::AI::WebhookTool::Webhook]
|
|
33
|
+
#
|
|
34
|
+
# @param timeout_ms [Integer] The maximum number of milliseconds to wait for the webhook to respond before the
|
|
20
35
|
|
|
21
36
|
# @see Telnyx::Models::AI::WebhookTool#type
|
|
22
37
|
module Type
|
|
@@ -64,6 +64,13 @@ module Telnyx
|
|
|
64
64
|
# @return [Telnyx::Models::ArtifactCompletedWebhookEvent::Data::ModelProvenance]
|
|
65
65
|
required :model_provenance, -> { Telnyx::ArtifactCompletedWebhookEvent::Data::ModelProvenance }
|
|
66
66
|
|
|
67
|
+
# @!attribute prompt
|
|
68
|
+
# The prompt that produced this artifact, or null for a named type. Non-null only
|
|
69
|
+
# when `type` is `custom`; the five named types always return `null`.
|
|
70
|
+
#
|
|
71
|
+
# @return [String, nil]
|
|
72
|
+
required :prompt, String, nil?: true
|
|
73
|
+
|
|
67
74
|
# @!attribute session_id
|
|
68
75
|
# The meeting session this event belongs to.
|
|
69
76
|
#
|
|
@@ -76,7 +83,10 @@ module Telnyx
|
|
|
76
83
|
# @return [Symbol, Telnyx::Models::ArtifactCompletedWebhookEvent::Data::Type]
|
|
77
84
|
required :type, enum: -> { Telnyx::ArtifactCompletedWebhookEvent::Data::Type }
|
|
78
85
|
|
|
79
|
-
# @!method initialize(artifact_id:, content:, model_provenance:, session_id:, type:)
|
|
86
|
+
# @!method initialize(artifact_id:, content:, model_provenance:, prompt:, session_id:, type:)
|
|
87
|
+
# Some parameter documentations has been truncated, see
|
|
88
|
+
# {Telnyx::Models::ArtifactCompletedWebhookEvent::Data} for more details.
|
|
89
|
+
#
|
|
80
90
|
# Completed artifact, including its generated content.
|
|
81
91
|
#
|
|
82
92
|
# @param artifact_id [String] Id of the completed artifact.
|
|
@@ -85,6 +95,8 @@ module Telnyx
|
|
|
85
95
|
#
|
|
86
96
|
# @param model_provenance [Telnyx::Models::ArtifactCompletedWebhookEvent::Data::ModelProvenance] Model that generated the artifact.
|
|
87
97
|
#
|
|
98
|
+
# @param prompt [String, nil] The prompt that produced this artifact, or null for a named type. Non-null only
|
|
99
|
+
#
|
|
88
100
|
# @param session_id [String] The meeting session this event belongs to.
|
|
89
101
|
#
|
|
90
102
|
# @param type [Symbol, Telnyx::Models::ArtifactCompletedWebhookEvent::Data::Type] Type of the completed artifact.
|
|
@@ -130,6 +142,10 @@ module Telnyx
|
|
|
130
142
|
|
|
131
143
|
SUMMARY = :summary
|
|
132
144
|
ACTION_ITEMS = :action_items
|
|
145
|
+
DECISIONS = :decisions
|
|
146
|
+
TOPICS = :topics
|
|
147
|
+
OPEN_QUESTIONS = :open_questions
|
|
148
|
+
CUSTOM = :custom
|
|
133
149
|
|
|
134
150
|
# @!method self.values
|
|
135
151
|
# @return [Array<Symbol>]
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::BotChallenge#create
|
|
6
|
+
class BotChallengeCreateParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute llm_model_name
|
|
11
|
+
# Name of the LLM the client is using.
|
|
12
|
+
#
|
|
13
|
+
# @return [String, nil]
|
|
14
|
+
optional :llm_model_name, String
|
|
15
|
+
|
|
16
|
+
# @!attribute llm_parameter_count
|
|
17
|
+
# Parameter count of the client LLM.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :llm_parameter_count, String
|
|
21
|
+
|
|
22
|
+
# @!attribute llm_quantization
|
|
23
|
+
# Quantization of the client LLM.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :llm_quantization, String
|
|
27
|
+
|
|
28
|
+
# @!method initialize(llm_model_name: nil, llm_parameter_count: nil, llm_quantization: nil, request_options: {})
|
|
29
|
+
# @param llm_model_name [String] Name of the LLM the client is using.
|
|
30
|
+
#
|
|
31
|
+
# @param llm_parameter_count [String] Parameter count of the client LLM.
|
|
32
|
+
#
|
|
33
|
+
# @param llm_quantization [String] Quantization of the client LLM.
|
|
34
|
+
#
|
|
35
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|