Class: Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/assistant_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: AuthenticationMethod

Instance Attribute Summary collapse

Instance Method Summary collapse

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(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil) ⇒ Object

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

Parameters:

  • base_url (String) —

    Base URL for the external LLM endpoint.

  • model (String) —

    Model identifier to use with the external LLM endpoint.

  • authentication_method (Symbol, Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod) (defaults to: nil) —

    Authentication method used when connecting to the external LLM endpoint.

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

    Integration secret identifier for the client certificate used with certificate a

  • forward_metadata (Boolean) (defaults to: nil) —

    When enabled, Telnyx forwards the assistant’s dynamic variables to the external

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

    Integration secret identifier for the external LLM API key.

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

    URL used to retrieve an access token when certificate authentication is enabled.




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

Instance Attribute Details

#authentication_method ⇒ Symbol, ...

Authentication method used when connecting to the external LLM endpoint.

Returns:



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

optional :authentication_method,
enum: -> { Telnyx::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod }

#base_url ⇒ String

Base URL for the external LLM endpoint.

Returns:

  • (String) 


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

required :base_url, String

#certificate_ref ⇒ String?

Integration secret identifier for the client certificate used with certificate authentication.

Returns:

  • (String, nil) 


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

optional :certificate_ref, String

#forward_metadata ⇒ Boolean?

When enabled, Telnyx forwards the assistant’s dynamic variables to the external LLM endpoint. Defaults to false. The chat completion request includes a top-level ‘extra_metadata` object when dynamic variables are available. For example: `“extra_metadata”:{“customer_name”:“Jane”,“account_id”:“acct_789”,“telnyx_agent_target”:“+13125550100”,“telnyx_end_user_target”:“+13125550123”}`.

Returns:

  • (Boolean, nil) 


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

optional :forward_metadata, Telnyx::Internal::Type::Boolean

#llm_api_key_ref ⇒ String?

Integration secret identifier for the external LLM API key.

Returns:

  • (String, nil) 


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

optional :llm_api_key_ref, String

#model ⇒ String

Model identifier to use with the external LLM endpoint.

Returns:

  • (String) 


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

required :model, String

#token_retrieval_url ⇒ String?

URL used to retrieve an access token when certificate authentication is enabled.

Returns:

  • (String, nil) 


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

optional :token_retrieval_url, String