Class: Telnyx::Models::AI::Assistants::TestCreateParams

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

Overview

See Also:

Defined Under Namespace

Classes: Rubric

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?

Optional detailed description of what this test evaluates and its purpose. Helps team members understand the test’s objectives.

Returns:

  • (String, nil) 


45
 
# File 'lib/telnyx/models/ai/assistants/test_create_params.rb', line 45

optional :description, String

#destination ⇒ String

The target destination for the test conversation. Format depends on the channel: phone number for SMS/voice, webhook URL for web chat, etc.

Returns:

  • (String) 


17
 
# File 'lib/telnyx/models/ai/assistants/test_create_params.rb', line 17

required :destination, String

#instructions ⇒ String

Detailed instructions that define the test scenario and what the assistant should accomplish. This guides the test execution and evaluation.

Returns:

  • (String) 


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

required :instructions, String

#max_duration_seconds ⇒ Integer?

Maximum duration in seconds that the test conversation should run before timing out. If not specified, uses system default timeout.

Returns:

  • (Integer, nil) 


52
 
# File 'lib/telnyx/models/ai/assistants/test_create_params.rb', line 52

optional :max_duration_seconds, Integer

#name ⇒ String

A descriptive name for the assistant test. This will be used to identify the test in the UI and reports.

Returns:

  • (String) 


31
 
# File 'lib/telnyx/models/ai/assistants/test_create_params.rb', line 31

required :name, String

#rubric ⇒ Array<Telnyx::Models::AI::Assistants::TestCreateParams::Rubric>

Evaluation criteria used to assess the assistant’s performance. Each rubric item contains a name and specific criteria for evaluation.

Returns:



38
 
# File 'lib/telnyx/models/ai/assistants/test_create_params.rb', line 38

required :rubric, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::TestCreateParams::Rubric] }

#telnyx_conversation_channel ⇒ Symbol, ...

The communication channel through which the test will be conducted. Determines how the assistant will receive and respond to test messages.

Returns:



59
 
# File 'lib/telnyx/models/ai/assistants/test_create_params.rb', line 59

optional :telnyx_conversation_channel, enum: -> { Telnyx::AI::Assistants::TelnyxConversationChannel }

#test_suite ⇒ String?

Optional test suite name to group related tests together. Useful for organizing tests by feature, team, or release cycle.

Returns:

  • (String, nil) 


66
 
# File 'lib/telnyx/models/ai/assistants/test_create_params.rb', line 66

optional :test_suite, String