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

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/telnyx/models/ai/assistant_create_params.rb

Instance Attribute Summary

• #allowed_list ⇒ Array<String>^?

  Optional per-assistant allowlist of integration tool names.

• #integration_id ⇒ String

  Catalog integration ID to attach.

Instance Method Summary

• #initialize(instructions:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: 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 Telnyx::Models::AI::AssistantCreateParams for more details.

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:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: 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

• 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_timeout_ms (Integer) (defaults to: nil) —

  Timeout in milliseconds for the dynamic variables webhook. Must be between 1 and

• dynamic_variables_webhook_url (String) (defaults to: nil) —

  If ‘dynamic_variables_webhook_url` is set, Telnyx sends a POST request to this U

• enabled_features (Array<Symbol, Telnyx::Models::AI::EnabledFeatures>) (defaults to: nil)
• external_llm (Telnyx::Models::AI::ExternalLlmReq) (defaults to: nil)
• fallback_config (Telnyx::Models::AI::FallbackConfigReq) (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)
• integrations (Array<Telnyx::Models::AI::AssistantCreateParams::Integration>) (defaults to: nil) —

  Connected integrations attached to the assistant. The catalog of available integ

• interruption_settings (Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings) (defaults to: nil) —

  Settings for interruptions and how the assistant decides the user has finished s

• llm_api_key_ref (String) (defaults to: nil) —

  This is only needed when using third-party inference providers selected by ‘mode

• mcp_servers (Array<Telnyx::Models::AI::AssistantCreateParams::McpServer>) (defaults to: nil) —

  MCP servers attached to the assistant. Create MCP servers with ‘/ai/mcp_servers`

• messaging_settings (Telnyx::Models::AI::MessagingSettings) (defaults to: nil)
• model (String) (defaults to: nil) —

  ID of the model to use when ‘external_llm` is not set. You can use the [Get mode

• observability_settings (Telnyx::Models::AI::ObservabilityReq) (defaults to: nil)
• post_conversation_settings (Telnyx::Models::AI::PostConversationSettingsReq) (defaults to: nil) —

  Configuration for post-conversation processing. When enabled, the assistant rece

• privacy_settings (Telnyx::Models::AI::PrivacySettings) (defaults to: nil)
• tags (Array<String>) (defaults to: nil) —

  Tags associated with the assistant. Tags can also be managed with the assistant

• telephony_settings (Telnyx::Models::AI::TelephonySettings) (defaults to: nil)
• tool_ids (Array<String>) (defaults to: nil) —

  IDs of shared tools to attach to the assistant. New integrations should prefer ‘

• 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) —

  Deprecated for new integrations. Inline tool definitions available to the assist

• 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 266

class Integration < Telnyx::Internal::Type::BaseModel
  # @!attribute integration_id
  #   Catalog integration ID to attach. This is the `id` from the integrations catalog
  #   at `/ai/integrations` (the same value also appears as `integration_id` on
  #   entries returned by `/ai/integrations/connections`). It is **not** the
  #   connection-level `id` from `/ai/integrations/connections`.
  #
  #   @return [String]
  required :integration_id, String

  # @!attribute allowed_list
  #   Optional per-assistant allowlist of integration tool names. When omitted or
  #   empty, all tools allowed by the connected integration are available to the
  #   assistant.
  #
  #   @return [Array<String>, nil]
  optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]

  # @!method initialize(integration_id:, allowed_list: nil)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::AI::AssistantCreateParams::Integration} for more details.
  #
  #   Reference to a connected integration attached to an assistant. Discover
  #   available integrations with `/ai/integrations` and connected integrations with
  #   `/ai/integrations/connections`.
  #
  #   @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
  #
  #   @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
end

Instance Attribute Details

#allowed_list ⇒ Array<String>^?

Optional per-assistant allowlist of integration tool names. When omitted or empty, all tools allowed by the connected integration are available to the assistant.

Returns:

• (Array<String>, nil)

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

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

#integration_id ⇒ String

Catalog integration ID to attach. This is the ‘id` from the integrations catalog at `/ai/integrations` (the same value also appears as `integration_id` on entries returned by `/ai/integrations/connections`). It is not the connection-level `id` from `/ai/integrations/connections`.

Returns:

• (String)

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

required :integration_id, String