Class: Telnyx::Models::AI::AssistantCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/ai/assistant_create_params.rb

Overview

See Also:

Defined Under Namespace

Classes: PostConversationSettings

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from Telnyx::Internal::Type::BaseModel

Instance Attribute Details

#description ⇒ String?

Returns:

  • (String, nil) 


34
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 34

optional :description, String

#dynamic_variables ⇒ Hash{Symbol=>Object}?

Map of dynamic variables and their default values

Returns:

  • (Hash{Symbol=>Object}, nil) 


40
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 40

optional :dynamic_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#dynamic_variables_webhook_url ⇒ String?

If the dynamic_variables_webhook_url is set for the assistant, we will send a request at the start of the conversation. See our [guide](developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) for more information.

Returns:

  • (String, nil) 


49
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 49

optional :dynamic_variables_webhook_url, String

#enabled_features ⇒ Array<Symbol, Telnyx::Models::AI::EnabledFeatures>?

Returns:



54
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 54

optional :enabled_features, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AI::EnabledFeatures] }

#greeting ⇒ String?

Text that the assistant will use to start the conversation. This may be templated with [dynamic variables](developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables). Use an empty string to have the assistant wait for the user to speak first. Use the special value ‘<assistant-speaks-first-with-model-generated-message>` to have the assistant generate the greeting based on the system instructions.

Returns:

  • (String, nil) 


65
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 65

optional :greeting, String

#insight_settings ⇒ Telnyx::Models::AI::InsightSettings?

Returns:



70
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 70

optional :insight_settings, -> { Telnyx::AI::InsightSettings }

#instructions ⇒ String

System instructions for the assistant. These may be templated with [dynamic variables](developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)

Returns:

  • (String) 


16
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 16

required :instructions, String

#llm_api_key_ref ⇒ String?

This is only needed when using third-party inference providers. The ‘identifier` for an integration secret [/v2/integration_secrets](developers.telnyx.com/api-reference/integration-secrets/create-a-secret) that refers to your LLM provider’s API key. Warning: Free plans are unlikely to work with this integration.

Returns:

  • (String, nil) 


80
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 80

optional :llm_api_key_ref, String

#messaging_settings ⇒ Telnyx::Models::AI::MessagingSettings?

Returns:



85
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 85

optional :messaging_settings, -> { Telnyx::AI::MessagingSettings }

#model ⇒ String

ID of the model to use. You can use the [Get models API](developers.telnyx.com/api-reference/chat/get-available-models) to see all of your available models,

Returns:

  • (String) 


24
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 24

required :model, String

#name ⇒ String

Returns:

  • (String) 


29
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 29

required :name, String

#observability_settings ⇒ Telnyx::Models::AI::ObservabilityReq?

Returns:



90
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 90

optional :observability_settings, -> { Telnyx::AI::ObservabilityReq }

#post_conversation_settings ⇒ Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings?

Configuration for post-conversation processing. When enabled, the assistant receives one additional LLM turn after the conversation ends, allowing it to execute tool calls such as logging to a CRM or sending a summary. The assistant can execute multiple parallel or sequential tools during this phase. Telephony-control tools (e.g. hangup, transfer) are unavailable post-conversation. Beta feature.

Returns:



101
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 101

optional :post_conversation_settings, -> { Telnyx::AI::AssistantCreateParams::PostConversationSettings }

#privacy_settings ⇒ Telnyx::Models::AI::PrivacySettings?

Returns:



106
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 106

optional :privacy_settings, -> { Telnyx::AI::PrivacySettings }

#telephony_settings ⇒ Telnyx::Models::AI::TelephonySettings?

Returns:



111
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 111

optional :telephony_settings, -> { Telnyx::AI::TelephonySettings }

#tool_ids ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


116
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 116

optional :tool_ids, Telnyx::Internal::Type::ArrayOf[String]

#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::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>?

The tools that the assistant can use. These may be templated with [dynamic variables](developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)

Returns:



123
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 123

optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }

#transcription ⇒ Telnyx::Models::AI::TranscriptionSettings?

Returns:



128
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 128

optional :transcription, -> { Telnyx::AI::TranscriptionSettings }

#voice_settings ⇒ Telnyx::Models::AI::VoiceSettings?

Returns:



133
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 133

optional :voice_settings, -> { Telnyx::AI::VoiceSettings }

#widget_settings ⇒ Telnyx::Models::AI::WidgetSettings?

Configuration settings for the assistant’s web widget.

Returns:



139
 
# File 'lib/telnyx/models/ai/assistant_create_params.rb', line 139

optional :widget_settings, -> { Telnyx::AI::WidgetSettings }