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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::AI::AssistantCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/ai/assistant_create_params.rb

Overview

See Also:

• Resources::AI::Assistants#create

Instance Attribute Summary

• #description ⇒ String^?
• #dynamic_variables ⇒ Hash{Symbol=>Object}^?

  Map of dynamic variables and their default values.

• #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.

• #enabled_features ⇒ Array<Symbol, Telnyx::Models::AI::EnabledFeatures>^?
• #greeting ⇒ String^?

  Text that the assistant will use to start the conversation.

• #insight_settings ⇒ Telnyx::Models::AI::InsightSettings^?
• #instructions ⇒ String

  System instructions for the assistant.

• #llm_api_key_ref ⇒ String^?

  This is only needed when using third-party inference providers.

• #messaging_settings ⇒ Telnyx::Models::AI::MessagingSettings^?
• #model ⇒ String

  ID of the model to use.

• #name ⇒ String
• #observability_settings ⇒ Telnyx::Models::AI::ObservabilityReq^?
• #privacy_settings ⇒ Telnyx::Models::AI::PrivacySettings^?
• #telephony_settings ⇒ Telnyx::Models::AI::TelephonySettings^?
• #tool_ids ⇒ Array<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.

• #transcription ⇒ Telnyx::Models::AI::TranscriptionSettings^?
• #voice_settings ⇒ Telnyx::Models::AI::VoiceSettings^?
• #widget_settings ⇒ Telnyx::Models::AI::WidgetSettings^?

  Configuration settings for the assistant’s web widget.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, observability_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see AssistantCreateParams for more details.

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, 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

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

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

Parameters:

• instructions (String) —

  System instructions for the assistant. These may be templated with [dynamic vari

• model (String) —

  ID of the model to use. You can use the [Get models API](developers.teln

• name (String)
• 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)
• 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)
• observability_settings (Telnyx::Models::AI::ObservabilityReq) (defaults to: nil)
• privacy_settings (Telnyx::Models::AI::PrivacySettings) (defaults to: nil)
• telephony_settings (Telnyx::Models::AI::TelephonySettings) (defaults to: nil)
• tool_ids (Array<String>) (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::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>) (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.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

#description ⇒ String^?

Returns:

• (String, nil)

# 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)

# 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)

# 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:

• (Array<Symbol, Telnyx::Models::AI::EnabledFeatures>, nil)

# 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)

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

optional :greeting, String

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

Returns:

• (Telnyx::Models::AI::InsightSettings, nil)

# 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)

# 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)

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

optional :llm_api_key_ref, String

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

Returns:

• (Telnyx::Models::AI::MessagingSettings, nil)

# 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)

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

required :model, String

#name ⇒ String

Returns:

• (String)

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

required :name, String

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

Returns:

• (Telnyx::Models::AI::ObservabilityReq, nil)

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

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

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

Returns:

• (Telnyx::Models::AI::PrivacySettings, nil)

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

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

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

Returns:

• (Telnyx::Models::AI::TelephonySettings, nil)

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

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

#tool_ids ⇒ Array<String>^?

Returns:

• (Array<String>, nil)

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

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:

• (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>, nil)

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

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

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

Returns:

• (Telnyx::Models::AI::TranscriptionSettings, nil)

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

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

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

Returns:

• (Telnyx::Models::AI::VoiceSettings, nil)

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

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

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

Configuration settings for the assistant’s web widget.

Returns:

• (Telnyx::Models::AI::WidgetSettings, nil)

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

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