Module: Telnyx::Models::AI

Defined in:: lib/telnyx/models/ai/assistant.rb,
lib/telnyx/models/ai/bucket_ids.rb,
lib/telnyx/models/ai/hangup_tool.rb,
lib/telnyx/models/ai/conversation.rb,
lib/telnyx/models/ai/webhook_tool.rb,
lib/telnyx/models/ai/transfer_tool.rb,
lib/telnyx/models/ai/assistant_tool.rb,
lib/telnyx/models/ai/retrieval_tool.rb,
lib/telnyx/models/ai/voice_settings.rb,
lib/telnyx/models/ai/assistants_list.rb,
lib/telnyx/models/ai/import_metadata.rb,
lib/telnyx/models/ai/widget_settings.rb,
lib/telnyx/models/ai/enabled_features.rb,
lib/telnyx/models/ai/insight_settings.rb,
lib/telnyx/models/ai/privacy_settings.rb,
lib/telnyx/models/ai/recursive_cluster.rb,
lib/telnyx/models/ai/embedding_response.rb,
lib/telnyx/models/ai/hangup_tool_params.rb,
lib/telnyx/models/ai/messaging_settings.rb,
lib/telnyx/models/ai/telephony_settings.rb,
lib/telnyx/models/ai/cluster_list_params.rb,
lib/telnyx/models/ai/inference_embedding.rb,
lib/telnyx/models/ai/embedding_url_params.rb,
lib/telnyx/models/ai/assistant_chat_params.rb,
lib/telnyx/models/ai/assistant_list_params.rb,
lib/telnyx/models/ai/cluster_delete_params.rb,
lib/telnyx/models/ai/cluster_list_response.rb,
lib/telnyx/models/ai/embedding_list_params.rb,
lib/telnyx/models/ai/assistant_clone_params.rb,
lib/telnyx/models/ai/background_task_status.rb,
lib/telnyx/models/ai/cluster_compute_params.rb,
lib/telnyx/models/ai/mcp_server_list_params.rb,
lib/telnyx/models/ai/transcription_settings.rb,
lib/telnyx/models/ai/assistant_chat_response.rb,
lib/telnyx/models/ai/assistant_create_params.rb,
lib/telnyx/models/ai/assistant_delete_params.rb,
lib/telnyx/models/ai/assistant_update_params.rb,
lib/telnyx/models/ai/assistants/event_status.rb,
lib/telnyx/models/ai/audio_transcribe_params.rb,
lib/telnyx/models/ai/cluster_retrieve_params.rb,
lib/telnyx/models/ai/embedding_create_params.rb,
lib/telnyx/models/ai/embedding_list_response.rb,
lib/telnyx/models/ai/integration_list_params.rb,
lib/telnyx/models/ai/assistant_imports_params.rb,
lib/telnyx/models/ai/assistants/canary_deploy.rb,
lib/telnyx/models/ai/cluster_compute_response.rb,
lib/telnyx/models/ai/conversation_list_params.rb,
lib/telnyx/models/ai/mcp_server_create_params.rb,
lib/telnyx/models/ai/mcp_server_delete_params.rb,
lib/telnyx/models/ai/mcp_server_list_response.rb,
lib/telnyx/models/ai/mcp_server_update_params.rb,
lib/telnyx/models/ai/assistant_delete_response.rb,
lib/telnyx/models/ai/assistant_retrieve_params.rb,
lib/telnyx/models/ai/assistant_send_sms_params.rb,
lib/telnyx/models/ai/assistants/assistant_test.rb,
lib/telnyx/models/ai/assistants/version_config.rb,
lib/telnyx/models/ai/audio_transcribe_response.rb,
lib/telnyx/models/ai/cluster_retrieve_response.rb,
lib/telnyx/models/ai/embedding_retrieve_params.rb,
lib/telnyx/models/ai/integration_list_response.rb,
lib/telnyx/models/ai/assistant_get_texml_params.rb,
lib/telnyx/models/ai/cluster_fetch_graph_params.rb,
lib/telnyx/models/ai/conversation_create_params.rb,
lib/telnyx/models/ai/conversation_delete_params.rb,
lib/telnyx/models/ai/conversation_list_response.rb,
lib/telnyx/models/ai/conversation_update_params.rb,
lib/telnyx/models/ai/mcp_server_create_response.rb,
lib/telnyx/models/ai/mcp_server_retrieve_params.rb,
lib/telnyx/models/ai/mcp_server_update_response.rb,
lib/telnyx/models/ai/assistant_send_sms_response.rb,
lib/telnyx/models/ai/assistants/test_list_params.rb,
lib/telnyx/models/ai/assistants/tool_test_params.rb,
lib/telnyx/models/ai/assistants/update_assistant.rb,
lib/telnyx/models/ai/embedding_retrieve_response.rb,
lib/telnyx/models/ai/fine_tuning/fine_tuning_job.rb,
lib/telnyx/models/ai/fine_tuning/job_list_params.rb,
lib/telnyx/models/ai/integration_retrieve_params.rb,
lib/telnyx/models/ai/assistant_get_texml_response.rb,
lib/telnyx/models/ai/assistants/tests/test_status.rb,
lib/telnyx/models/ai/conversation_retrieve_params.rb,
lib/telnyx/models/ai/conversation_update_response.rb,
lib/telnyx/models/ai/mcp_server_retrieve_response.rb,
lib/telnyx/models/ai/assistants/test_create_params.rb,
lib/telnyx/models/ai/assistants/test_delete_params.rb,
lib/telnyx/models/ai/assistants/test_update_params.rb,
lib/telnyx/models/ai/assistants/tool_test_response.rb,
lib/telnyx/models/ai/chat_create_completion_params.rb,
lib/telnyx/models/ai/embeddings/bucket_list_params.rb,
lib/telnyx/models/ai/fine_tuning/job_cancel_params.rb,
lib/telnyx/models/ai/fine_tuning/job_create_params.rb,
lib/telnyx/models/ai/fine_tuning/job_list_response.rb,
lib/telnyx/models/ai/integration_retrieve_response.rb,
lib/telnyx/models/ai/transcription_settings_config.rb,
lib/telnyx/models/ai/assistants/version_list_params.rb,
lib/telnyx/models/ai/conversation_retrieve_response.rb,
lib/telnyx/models/ai/conversations/insight_template.rb,
lib/telnyx/models/ai/assistants/test_retrieve_params.rb,
lib/telnyx/models/ai/chat_create_completion_response.rb,
lib/telnyx/models/ai/conversation_add_message_params.rb,
lib/telnyx/models/ai/embeddings/bucket_delete_params.rb,
lib/telnyx/models/ai/embeddings/bucket_list_response.rb,
lib/telnyx/models/ai/fine_tuning/job_retrieve_params.rb,
lib/telnyx/models/ai/assistants/tests/run_list_params.rb,
lib/telnyx/models/ai/assistants/version_delete_params.rb,
lib/telnyx/models/ai/assistants/version_update_params.rb,
lib/telnyx/models/ai/assistants/canary_deploy_response.rb,
lib/telnyx/models/ai/assistants/tests/test_suites/meta.rb,
lib/telnyx/models/ai/assistants/version_promote_params.rb,
lib/telnyx/models/ai/conversations/insight_list_params.rb,
lib/telnyx/models/ai/conversations/message_list_params.rb,
lib/telnyx/models/ai/embeddings/bucket_retrieve_params.rb,
lib/telnyx/models/ai/assistants/tests/test_run_response.rb,
lib/telnyx/models/ai/assistants/version_retrieve_params.rb,
lib/telnyx/models/ai/embedding_similarity_search_params.rb,
lib/telnyx/models/ai/assistants/scheduled_event_response.rb,
lib/telnyx/models/ai/assistants/tests/run_trigger_params.rb,
lib/telnyx/models/ai/conversations/insight_create_params.rb,
lib/telnyx/models/ai/conversations/insight_delete_params.rb,
lib/telnyx/models/ai/conversations/insight_update_params.rb,
lib/telnyx/models/ai/conversations/message_list_response.rb,
lib/telnyx/models/ai/embeddings/bucket_retrieve_response.rb,
lib/telnyx/models/ai/integrations/connection_list_params.rb,
lib/telnyx/models/ai/assistants/conversation_channel_type.rb,
lib/telnyx/models/ai/assistants/tests/run_retrieve_params.rb,
lib/telnyx/models/ai/conversations/insight_template_group.rb,
lib/telnyx/models/ai/embedding_similarity_search_response.rb,
lib/telnyx/models/ai/conversations/insight_retrieve_params.rb,
lib/telnyx/models/ai/conversations/insight_template_detail.rb,
lib/telnyx/models/ai/integrations/connection_delete_params.rb,
lib/telnyx/models/ai/integrations/connection_list_response.rb,
lib/telnyx/models/ai/assistants/canary_deploy_create_params.rb,
lib/telnyx/models/ai/assistants/canary_deploy_delete_params.rb,
lib/telnyx/models/ai/assistants/canary_deploy_update_params.rb,
lib/telnyx/models/ai/assistants/scheduled_event_list_params.rb,
lib/telnyx/models/ai/assistants/telnyx_conversation_channel.rb,
lib/telnyx/models/ai/assistants/scheduled_sms_event_response.rb,
lib/telnyx/models/ai/assistants/tests/test_suite_list_params.rb,
lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb,
lib/telnyx/models/ai/integrations/connection_retrieve_params.rb,
lib/telnyx/models/ai/assistants/canary_deploy_retrieve_params.rb,
lib/telnyx/models/ai/assistants/scheduled_event_create_params.rb,
lib/telnyx/models/ai/assistants/scheduled_event_delete_params.rb,
lib/telnyx/models/ai/assistants/scheduled_event_list_response.rb,
lib/telnyx/models/ai/assistants/tests/test_suite_list_response.rb,
lib/telnyx/models/ai/conversations/insight_group_delete_params.rb,
lib/telnyx/models/ai/conversations/insight_group_update_params.rb,
lib/telnyx/models/ai/integrations/connection_retrieve_response.rb,
lib/telnyx/models/ai/assistants/scheduled_event_retrieve_params.rb,
lib/telnyx/models/ai/conversations/insight_group_retrieve_params.rb,
lib/telnyx/models/ai/conversations/insight_template_group_detail.rb,
lib/telnyx/models/ai/assistants/tests/test_suites/run_list_params.rb,
lib/telnyx/models/ai/assistants/scheduled_phone_call_event_response.rb,
lib/telnyx/models/ai/assistants/tests/test_suites/run_trigger_params.rb,
lib/telnyx/models/ai/assistants/tests/test_suites/run_trigger_response.rb,
lib/telnyx/models/ai/conversations/insight_group_insight_groups_params.rb,
lib/telnyx/models/ai/conversations/insight_groups/insight_assign_params.rb,
lib/telnyx/models/ai/conversation_retrieve_conversations_insights_params.rb,
lib/telnyx/models/ai/assistants/tests/test_suites/paginated_test_run_list.rb,
lib/telnyx/models/ai/conversation_retrieve_conversations_insights_response.rb,
lib/telnyx/models/ai/conversations/insight_group_retrieve_insight_groups_params.rb,
lib/telnyx/models/ai/conversations/insight_groups/insight_delete_unassign_params.rb

Defined Under Namespace

Modules: AssistantTool, Assistants, BackgroundTaskStatus, Conversations, Embeddings, EnabledFeatures, FineTuning, Integrations Classes: Assistant, AssistantChatParams, AssistantChatResponse, AssistantCloneParams, AssistantCreateParams, AssistantDeleteParams, AssistantDeleteResponse, AssistantGetTexmlParams, AssistantImportsParams, AssistantListParams, AssistantRetrieveParams, AssistantSendSMSParams, AssistantSendSMSResponse, AssistantUpdateParams, AssistantsList, AudioTranscribeParams, AudioTranscribeResponse, BucketIDs, ChatCreateCompletionParams, ClusterComputeParams, ClusterComputeResponse, ClusterDeleteParams, ClusterFetchGraphParams, ClusterListParams, ClusterListResponse, ClusterRetrieveParams, ClusterRetrieveResponse, Conversation, ConversationAddMessageParams, ConversationCreateParams, ConversationDeleteParams, ConversationListParams, ConversationListResponse, ConversationRetrieveConversationsInsightsParams, ConversationRetrieveConversationsInsightsResponse, ConversationRetrieveParams, ConversationRetrieveResponse, ConversationUpdateParams, ConversationUpdateResponse, EmbeddingCreateParams, EmbeddingListParams, EmbeddingListResponse, EmbeddingResponse, EmbeddingRetrieveParams, EmbeddingRetrieveResponse, EmbeddingSimilaritySearchParams, EmbeddingSimilaritySearchResponse, EmbeddingURLParams, HangupTool, HangupToolParams, ImportMetadata, InferenceEmbedding, InferenceEmbeddingWebhookToolParams, InsightSettings, IntegrationListParams, IntegrationListResponse, IntegrationRetrieveParams, IntegrationRetrieveResponse, McpServerCreateParams, McpServerCreateResponse, McpServerDeleteParams, McpServerListParams, McpServerListResponse, McpServerRetrieveParams, McpServerRetrieveResponse, McpServerUpdateParams, McpServerUpdateResponse, MessagingSettings, PrivacySettings, RecursiveCluster, RetrievalTool, TelephonySettings, TranscriptionSettings, TranscriptionSettingsConfig, TransferTool, VoiceSettings, WebhookTool, WidgetSettings

Constant Summary collapse

AssistantTest =

Assistants::AssistantTest

UpdateAssistant =

Assistants::UpdateAssistant

FineTuningJob =

FineTuning::FineTuningJob

AssistantGetTexmlResponse =

String

ChatCreateCompletionResponse =

Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

Class Method Summary collapse

.values ⇒ Array<Symbol>

Instance Method Summary collapse

#initialize(description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil) ⇒ Object

Some parameter documentations has been truncated, see Assistants::UpdateAssistant for more details.

Class Method Details

.values ⇒ `Array<Symbol>`

Returns:

(Array<Symbol>)

# File 'lib/telnyx/models/ai/fine_tuning/fine_tuning_job.rb', line 121

Instance Method Details

#initialize(description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil) ⇒ `Object`

Some parameter documentations has been truncated, see Telnyx::Models::AI::Assistants::UpdateAssistant for more details.

Parameters:

description (String) (defaults to: nil)
dynamic_variables (Hash{Symbol=>Object}) (defaults to: nil) —

Map of dynamic variables and their default values
dynamic_variables_webhook_url (String) (defaults to: nil) —

If the dynamic_variables_webhook_url is set for the assistant, we will send a re
enabled_features (Array<Symbol, Telnyx::Models::AI::EnabledFeatures>) (defaults to: nil)
greeting (String) (defaults to: nil) —

Text that the assistant will use to start the conversation. This may be template
insight_settings (Telnyx::Models::AI::InsightSettings) (defaults to: nil)
instructions (String) (defaults to: nil) —

System instructions for the assistant. These may be templated with [dynamic vari
llm_api_key_ref (String) (defaults to: nil) —

This is only needed when using third-party inference providers. The ‘identifier`
messaging_settings (Telnyx::Models::AI::MessagingSettings) (defaults to: nil)
model (String) (defaults to: nil) —

ID of the model to use. You can use the [Get models API](developers.teln
name (String) (defaults to: nil)
privacy_settings (Telnyx::Models::AI::PrivacySettings) (defaults to: nil)
telephony_settings (Telnyx::Models::AI::TelephonySettings) (defaults to: nil)
tools (Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>) (defaults to: nil) —

The tools that the assistant can use. These may be templated with [dynamic varia
transcription (Telnyx::Models::AI::TranscriptionSettings) (defaults to: nil)
voice_settings (Telnyx::Models::AI::VoiceSettings) (defaults to: nil)
widget_settings (Telnyx::Models::AI::WidgetSettings) (defaults to: nil) —

Configuration settings for the assistant’s web widget.

# File 'lib/telnyx/models/ai/assistants/assistant_test.rb', line 110