Amazon Connect Service

2026/11/17 - Amazon Connect Service - 4 updated api methods

Changes  Evaluation forms can now adapt to each contact. Questions and sections can be shown or hidden, and single-select answers can be set automatically, based on answers to other questions, contact data (Contact Lens categories, sentiment, agent, queue, contact attributes and more).

CreateEvaluationForm (updated) Link ¶
Changes (request)
{'Items': {'Question': {'Enablement': {'Condition': {'Operands': {'Expression': {'Comparator': {'EQUAL_TO',
                                                                                                'GREATER_THAN',
                                                                                                'GREATER_THAN_OR_EQUAL_TO',
                                                                                                'LESS_THAN',
                                                                                                'LESS_THAN_OR_EQUAL_TO',
                                                                                                'NOT_EQUAL_TO'},
                                                                                 'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                              '| '
                                                                                                              'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                              '| '
                                                                                                              'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                              '| '
                                                                                                              'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                              '| '
                                                                                                              'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                              '| '
                                                                                                              'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_MAX_LATENCY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_SELECTION_ACCURACY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                            'ContactAttributeKey': 'string',
                                                                                            'ContactField': 'CATEGORIES '
                                                                                                            '| '
                                                                                                            'AGENT_ARN '
                                                                                                            '| '
                                                                                                            'QUEUE_ARN '
                                                                                                            '| '
                                                                                                            'ROUTING_PROFILE_ARN '
                                                                                                            '| '
                                                                                                            'CHANNEL '
                                                                                                            '| '
                                                                                                            'INITIATION_METHOD '
                                                                                                            '| '
                                                                                                            'IS_QUEUED '
                                                                                                            '| '
                                                                                                            'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                            '| '
                                                                                                            'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                            '| '
                                                                                                            'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                            '| '
                                                                                                            'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                            '| '
                                                                                                            'NON_TALK_TIME '
                                                                                                            '| '
                                                                                                            'NON_TALK_TIME_PERCENTAGE '
                                                                                                            '| '
                                                                                                            'NUMBER_OF_INTERRUPTIONS '
                                                                                                            '| '
                                                                                                            'CONTACT_DURATION '
                                                                                                            '| '
                                                                                                            'AGENT_INTERACTION_DURATION '
                                                                                                            '| '
                                                                                                            'CUSTOMER_HOLD_TIME '
                                                                                                            '| '
                                                                                                            'LONGEST_HOLD_DURATION '
                                                                                                            '| '
                                                                                                            'NUMBER_OF_HOLDS '
                                                                                                            '| '
                                                                                                            'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                            '| '
                                                                                                            'RECORDING_MEDIA_STREAM_TYPES',
                                                                                            'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                            'SegmentAttributeKey': 'string',
                                                                                            'Type': {'AI_METRICS',
                                                                                                     'CONTACT',
                                                                                                     'EVALUATION_METADATA',
                                                                                                     'FORM_METADATA'}},
                                                                                 'Values': {'BooleanValue': 'boolean',
                                                                                            'DateTimeValue': 'timestamp',
                                                                                            'NumericValue': 'double',
                                                                                            'StringValue': 'string',
                                                                                            'Type': {'BOOLEAN_VALUE',
                                                                                                     'DATETIME_VALUE',
                                                                                                     'NUMERIC_VALUE',
                                                                                                     'STRING_VALUE'}}}}}},
                        'QuestionTypeProperties': {'MultiSelect': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}}}},
                                                   'Numeric': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}},
                                                                              'PropertyValue': {'Label': {'AI_AGENT_MAX_PROMPT_LATENCY',
                                                                                                          'AI_SESSION_COMPLETENESS_SCORE',
                                                                                                          'AI_SESSION_FAITHFULNESS_SCORE',
                                                                                                          'AI_SESSION_GOAL_SUCCESS_RATE',
                                                                                                          'AI_SESSION_SELF_SERVICE_DURATION',
                                                                                                          'AI_TOOL_MAX_LATENCY',
                                                                                                          'AI_TOOL_PARAMETER_ACCURACY',
                                                                                                          'AI_TOOL_SELECTION_ACCURACY',
                                                                                                          'AI_TOOL_UTILIZATION_ACCURACY'}}}},
                                                   'SingleSelect': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}},
                                                                                   'Options': {'AutomationRule': {'Condition': {'Operands': [{'Condition': (),
                                                                                                                                              'Expression': {'Comparator': 'IN '
                                                                                                                                                                           '| '
                                                                                                                                                                           'NOT_IN '
                                                                                                                                                                           '| '
                                                                                                                                                                           'ALL_IN '
                                                                                                                                                                           '| '
                                                                                                                                                                           'EXACT '
                                                                                                                                                                           '| '
                                                                                                                                                                           'GREATER_THAN '
                                                                                                                                                                           '| '
                                                                                                                                                                           'LESS_THAN '
                                                                                                                                                                           '| '
                                                                                                                                                                           'GREATER_THAN_OR_EQUAL_TO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'LESS_THAN_OR_EQUAL_TO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'EQUAL_TO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'NOT_EQUAL_TO',
                                                                                                                                                             'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_TOOL_MAX_LATENCY '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_TOOL_SELECTION_ACCURACY '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                                                                                                        'ContactAttributeKey': 'string',
                                                                                                                                                                        'ContactField': 'CATEGORIES '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'AGENT_ARN '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'QUEUE_ARN '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'ROUTING_PROFILE_ARN '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'CHANNEL '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'INITIATION_METHOD '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'IS_QUEUED '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'NON_TALK_TIME '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'NON_TALK_TIME_PERCENTAGE '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'NUMBER_OF_INTERRUPTIONS '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'CONTACT_DURATION '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'AGENT_INTERACTION_DURATION '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'CUSTOMER_HOLD_TIME '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'LONGEST_HOLD_DURATION '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'NUMBER_OF_HOLDS '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'RECORDING_MEDIA_STREAM_TYPES',
                                                                                                                                                                        'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                                                                                                        'RefId': 'string',
                                                                                                                                                                        'SegmentAttributeKey': 'string',
                                                                                                                                                                        'Type': 'QUESTION_REF_ID '
                                                                                                                                                                                '| '
                                                                                                                                                                                'CONTACT '
                                                                                                                                                                                '| '
                                                                                                                                                                                'EVALUATION_METADATA '
                                                                                                                                                                                '| '
                                                                                                                                                                                'FORM_METADATA '
                                                                                                                                                                                '| '
                                                                                                                                                                                'AI_METRICS'},
                                                                                                                                                             'Values': [{'BooleanValue': 'boolean',
                                                                                                                                                                         'DateTimeValue': 'timestamp',
                                                                                                                                                                         'NumericValue': 'double',
                                                                                                                                                                         'RefId': 'string',
                                                                                                                                                                         'StringValue': 'string',
                                                                                                                                                                         'Type': 'OPTION_REF_ID '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'STRING_VALUE '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'NUMERIC_VALUE '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'BOOLEAN_VALUE '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'DATETIME_VALUE'}]}}],
                                                                                                                                'Operator': 'OR '
                                                                                                                                            '| '
                                                                                                                                            'AND'},
                                                                                                                  'OptionRefId': 'string'}}}},
                                                   'Text': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}}}}}},
           'Section': {'Enablement': {'Action': 'DISABLE | ENABLE',
                                      'Condition': {'Operands': [{'Condition': (),
                                                                  'Expression': {'Comparator': 'IN '
                                                                                               '| '
                                                                                               'NOT_IN '
                                                                                               '| '
                                                                                               'ALL_IN '
                                                                                               '| '
                                                                                               'EXACT '
                                                                                               '| '
                                                                                               'GREATER_THAN '
                                                                                               '| '
                                                                                               'LESS_THAN '
                                                                                               '| '
                                                                                               'GREATER_THAN_OR_EQUAL_TO '
                                                                                               '| '
                                                                                               'LESS_THAN_OR_EQUAL_TO '
                                                                                               '| '
                                                                                               'EQUAL_TO '
                                                                                               '| '
                                                                                               'NOT_EQUAL_TO',
                                                                                 'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                              '| '
                                                                                                              'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                              '| '
                                                                                                              'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                              '| '
                                                                                                              'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                              '| '
                                                                                                              'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                              '| '
                                                                                                              'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_MAX_LATENCY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_SELECTION_ACCURACY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                            'ContactAttributeKey': 'string',
                                                                                            'ContactField': 'CATEGORIES '
                                                                                                            '| '
                                                                                                            'AGENT_ARN '
                                                                                                            '| '
                                                                                                            'QUEUE_ARN '
                                                                                                            '| '
                                                                                                            'ROUTING_PROFILE_ARN '
                                                                                                            '| '
                                                                                                            'CHANNEL '
                                                                                                            '| '
                                                                                                            'INITIATION_METHOD '
                                                                                                            '| '
                                                                                                            'IS_QUEUED '
                                                                                                            '| '
                                                                                                            'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                            '| '
                                                                                                            'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                            '| '
                                                                                                            'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                            '| '
                                                                                                            'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                            '| '
                                                                                                            'NON_TALK_TIME '
                                                                                                            '| '
                                                                                                            'NON_TALK_TIME_PERCENTAGE '
                                                                                                            '| '
                                                                                                            'NUMBER_OF_INTERRUPTIONS '
                                                                                                            '| '
                                                                                                            'CONTACT_DURATION '
                                                                                                            '| '
                                                                                                            'AGENT_INTERACTION_DURATION '
                                                                                                            '| '
                                                                                                            'CUSTOMER_HOLD_TIME '
                                                                                                            '| '
                                                                                                            'LONGEST_HOLD_DURATION '
                                                                                                            '| '
                                                                                                            'NUMBER_OF_HOLDS '
                                                                                                            '| '
                                                                                                            'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                            '| '
                                                                                                            'RECORDING_MEDIA_STREAM_TYPES',
                                                                                            'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                            'RefId': 'string',
                                                                                            'SegmentAttributeKey': 'string',
                                                                                            'Type': 'QUESTION_REF_ID '
                                                                                                    '| '
                                                                                                    'CONTACT '
                                                                                                    '| '
                                                                                                    'EVALUATION_METADATA '
                                                                                                    '| '
                                                                                                    'FORM_METADATA '
                                                                                                    '| '
                                                                                                    'AI_METRICS'},
                                                                                 'Values': [{'BooleanValue': 'boolean',
                                                                                             'DateTimeValue': 'timestamp',
                                                                                             'NumericValue': 'double',
                                                                                             'RefId': 'string',
                                                                                             'StringValue': 'string',
                                                                                             'Type': 'OPTION_REF_ID '
                                                                                                     '| '
                                                                                                     'STRING_VALUE '
                                                                                                     '| '
                                                                                                     'NUMERIC_VALUE '
                                                                                                     '| '
                                                                                                     'BOOLEAN_VALUE '
                                                                                                     '| '
                                                                                                     'DATETIME_VALUE'}]}}],
                                                    'Operator': 'OR | AND'},
                                      'DefaultAction': 'DISABLE | ENABLE'}}}}

Creates an evaluation form in the specified Connect Customer instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

See also: AWS API Documentation

Request Syntax

client.create_evaluation_form(
    InstanceId='string',
    Title='string',
    Description='string',
    Items=[
        {
            'Section': {
                'Title': 'string',
                'RefId': 'string',
                'Instructions': 'string',
                'Items': {'... recursive ...'},
                'Weight': 123.0,
                'IsExcludedFromScoring': True|False,
                'ScoreThresholds': [
                    {
                        'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                        'MinScorePercentage': 123.0,
                        'MaxScorePercentage': 123.0
                    },
                ],
                'Enablement': {
                    'Condition': {
                        'Operands': [
                            {
                                'Expression': {
                                    'Source': {
                                        'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                        'RefId': 'string',
                                        'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                        'ContactAttributeKey': 'string',
                                        'SegmentAttributeKey': 'string',
                                        'EvaluationMetadataField': 'EVALUATION_TYPE',
                                        'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                    },
                                    'Values': [
                                        {
                                            'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                            'RefId': 'string',
                                            'StringValue': 'string',
                                            'NumericValue': 123.0,
                                            'BooleanValue': True|False,
                                            'DateTimeValue': datetime(2015, 1, 1)
                                        },
                                    ],
                                    'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                },
                                'Condition': {'... recursive ...'}
                            },
                        ],
                        'Operator': 'OR'|'AND'
                    },
                    'Action': 'DISABLE'|'ENABLE',
                    'DefaultAction': 'DISABLE'|'ENABLE'
                }
            },
            'Question': {
                'Title': 'string',
                'Instructions': 'string',
                'RefId': 'string',
                'NotApplicableEnabled': True|False,
                'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
                'QuestionTypeProperties': {
                    'Numeric': {
                        'MinValue': 123,
                        'MaxValue': 123,
                        'Options': [
                            {
                                'MinValue': 123,
                                'MaxValue': 123,
                                'Score': 123,
                                'AutomaticFail': True|False,
                                'AutomaticFailConfiguration': {
                                    'TargetSection': 'string'
                                },
                                'PointsConfiguration': {
                                    'PointValue': 123,
                                    'IsBonus': True|False
                                }
                            },
                        ],
                        'Automation': {
                            'PropertyValue': {
                                'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                            },
                            'AnswerSource': {
                                'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                            }
                        }
                    },
                    'SingleSelect': {
                        'Options': [
                            {
                                'RefId': 'string',
                                'Text': 'string',
                                'Score': 123,
                                'AutomaticFail': True|False,
                                'AutomaticFailConfiguration': {
                                    'TargetSection': 'string'
                                },
                                'PointsConfiguration': {
                                    'PointValue': 123,
                                    'IsBonus': True|False
                                }
                            },
                        ],
                        'DisplayAs': 'DROPDOWN'|'RADIO',
                        'Automation': {
                            'Options': [
                                {
                                    'RuleCategory': {
                                        'Category': 'string',
                                        'Condition': 'PRESENT'|'NOT_PRESENT',
                                        'OptionRefId': 'string'
                                    },
                                    'AutomationRule': {
                                        'Condition': {
                                            'Operands': [
                                                {
                                                    'Expression': {
                                                        'Source': {
                                                            'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                                            'RefId': 'string',
                                                            'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                                            'ContactAttributeKey': 'string',
                                                            'SegmentAttributeKey': 'string',
                                                            'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                            'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                                        },
                                                        'Values': [
                                                            {
                                                                'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                                                'RefId': 'string',
                                                                'StringValue': 'string',
                                                                'NumericValue': 123.0,
                                                                'BooleanValue': True|False,
                                                                'DateTimeValue': datetime(2015, 1, 1)
                                                            },
                                                        ],
                                                        'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                                    },
                                                    'Condition': {'... recursive ...'}
                                                },
                                            ],
                                            'Operator': 'OR'|'AND'
                                        },
                                        'OptionRefId': 'string'
                                    }
                                },
                            ],
                            'DefaultOptionRefId': 'string',
                            'AnswerSource': {
                                'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                            }
                        }
                    },
                    'Text': {
                        'Automation': {
                            'AnswerSource': {
                                'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                            }
                        }
                    },
                    'MultiSelect': {
                        'Options': [
                            {
                                'RefId': 'string',
                                'Text': 'string',
                                'Score': 123,
                                'AutomaticFail': True|False,
                                'AutomaticFailConfiguration': {
                                    'TargetSection': 'string'
                                },
                                'PointsConfiguration': {
                                    'PointValue': 123,
                                    'IsBonus': True|False
                                }
                            },
                        ],
                        'DisplayAs': 'DROPDOWN'|'CHECKBOX',
                        'Automation': {
                            'Options': [
                                {
                                    'RuleCategory': {
                                        'Category': 'string',
                                        'Condition': 'PRESENT'|'NOT_PRESENT',
                                        'OptionRefIds': [
                                            'string',
                                        ]
                                    }
                                },
                            ],
                            'DefaultOptionRefIds': [
                                'string',
                            ],
                            'AnswerSource': {
                                'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                            }
                        }
                    }
                },
                'Enablement': {
                    'Condition': {
                        'Operands': [
                            {
                                'Expression': {
                                    'Source': {
                                        'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                        'RefId': 'string',
                                        'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                        'ContactAttributeKey': 'string',
                                        'SegmentAttributeKey': 'string',
                                        'EvaluationMetadataField': 'EVALUATION_TYPE',
                                        'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                    },
                                    'Values': [
                                        {
                                            'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                            'RefId': 'string',
                                            'StringValue': 'string',
                                            'NumericValue': 123.0,
                                            'BooleanValue': True|False,
                                            'DateTimeValue': datetime(2015, 1, 1)
                                        },
                                    ],
                                    'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                },
                                'Condition': {'... recursive ...'}
                            },
                        ],
                        'Operator': 'OR'|'AND'
                    },
                    'Action': 'DISABLE'|'ENABLE',
                    'DefaultAction': 'DISABLE'|'ENABLE'
                },
                'Weight': 123.0,
                'ScoringConfiguration': {
                    'PointsConfiguration': {
                        'MaxPointValue': 123,
                        'MinPointValue': 123,
                        'IsBonus': True|False
                    },
                    'IsExcludedFromScoring': True|False,
                    'ScoreThresholds': [
                        {
                            'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                            'MinScorePercentage': 123.0,
                            'MaxScorePercentage': 123.0
                        },
                    ]
                },
                'MetricConfiguration': {
                    'MetricType': 'BUSINESS_OUTCOME',
                    'MetricName': 'string'
                }
            }
        },
    ],
    ScoringStrategy={
        'Mode': 'QUESTION_ONLY'|'SECTION_ONLY'|'POINTS_BASED',
        'Status': 'ENABLED'|'DISABLED',
        'ScoreThresholds': [
            {
                'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                'MinScorePercentage': 123.0,
                'MaxScorePercentage': 123.0
            },
        ]
    },
    AutoEvaluationConfiguration={
        'Enabled': True|False
    },
    ClientToken='string',
    AsDraft=True|False,
    Tags={
        'string': 'string'
    },
    ReviewConfiguration={
        'ReviewNotificationRecipients': [
            {
                'Type': 'USER_ID',
                'Value': {
                    'UserId': 'string'
                }
            },
        ],
        'EligibilityDays': 123
    },
    TargetConfiguration={
        'ContactInteractionType': 'AGENT'|'AUTOMATED'|'CUSTOMER'
    },
    LanguageConfiguration={
        'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'|'ms-MY'|'af-ZA'|'sq-AL'|'am-ET'|'ar-AE'|'ar-SA'|'hy-AM'|'eu-ES'|'be-BY'|'bs-BA'|'bg-BG'|'ca-ES'|'ckb-IR'|'ckb-IQ'|'zh-TW'|'hr-HR'|'cs-CZ'|'da-DK'|'nl-BE'|'nl-NL'|'en-AU'|'en-IN'|'en-IE'|'en-NZ'|'en-AB'|'en-SG'|'en-ZA'|'en-GB'|'en-WL'|'fa-IR'|'fa-AF'|'fi-FI'|'fr-BE'|'fr-CA'|'ga-IE'|'gl-ES'|'ka-GE'|'de-AT'|'de-CH'|'el-GR'|'gu-IN'|'ht-HT'|'he-IL'|'hi-IN'|'hu-HU'|'is-IS'|'id-ID'|'jv-ID'|'km-KH'|'kn-IN'|'kk-KZ'|'lo-LA'|'lv-LV'|'lt-LT'|'mk-MK'|'ml-IN'|'mr-IN'|'ne-NP'|'no-NO'|'or-IN'|'ps-AF'|'pl-PL'|'pt-PT'|'pa-IN'|'ro-RO'|'ru-RU'|'sr-RS'|'si-LK'|'sk-SK'|'sl-SI'|'es-MX'|'es-US'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'sv-SE'|'tl-PH'|'ta-IN'|'te-IN'|'th-TH'|'tr-TR'|'uk-UA'|'uz-UZ'|'vi-VN'|'zu-ZA'|'my-MM'|'so-SO'|'yue-HK'|'et-EE'|'hmn'|'lg-UG'|'cy-GB'|'xh-ZA'|'bn-BD'
    },
    AIVersion='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type Title:

string

param Title:

[REQUIRED]

A title of the evaluation form.

type Description:

string

param Description:

The description of the evaluation form.

type Items:

list

param Items:

[REQUIRED]

Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

  • (dict) --

    Information about an item from an evaluation form. The item must be either a section or a question.

    • Section (dict) --

      The information of the section.

      • Title (string) -- [REQUIRED]

        The title of the section.

      • RefId (string) -- [REQUIRED]

        The identifier of the section. An identifier must be unique within the evaluation form.

      • Instructions (string) --

        The instructions of the section.

      • Items (list) --

        The items of the section.

      • Weight (float) --

        The scoring weight of the section.

      • IsExcludedFromScoring (boolean) --

        The flag to exclude the section from scoring.

      • ScoreThresholds (list) --

        The score thresholds for performance categories.

        • (dict) --

          Information about a score threshold for a performance category.

          • PerformanceCategory (string) -- [REQUIRED]

            The performance category name.

          • MinScorePercentage (float) --

            The minimum score percentage for the performance category.

          • MaxScorePercentage (float) --

            The maximum score percentage for the performance category.

      • Enablement (dict) --

        The conditional enablement configuration of the section. Sections use the same enablement model as questions.

        • Condition (dict) -- [REQUIRED]

          A condition for item enablement configuration.

          • Operands (list) -- [REQUIRED]

            Operands of the enablement condition.

            • (dict) --

              An operand of the enablement condition.

              • Expression (dict) --

                An expression of the enablement condition.

                • Source (dict) -- [REQUIRED]

                  A source item of enablement expression.

                  • Type (string) -- [REQUIRED]

                    A type of source item. Valid values:

                    • QUESTION_REF_ID - The answer to another question in the evaluation form.

                    • CONTACT - Data from the evaluated contact.

                    • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                    • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                  • RefId (string) --

                    A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                  • ContactField (string) --

                    The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                  • ContactAttributeKey (string) --

                    The key of the contact attribute to use as the source. Use when Type is CONTACT.

                  • SegmentAttributeKey (string) --

                    The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                  • EvaluationMetadataField (string) --

                    The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                  • AiMetricsField (string) --

                    The AI metrics field to use as the source. Use when Type is AI_METRICS.

                • Values (list) -- [REQUIRED]

                  A list of values from source item.

                  • (dict) --

                    An enablement expression source value. Provide only the value member that matches the specified Type.

                    • Type (string) -- [REQUIRED]

                      A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                    • RefId (string) --

                      A referenceId of the source value. Use when Type is OPTION_REF_ID.

                    • StringValue (string) --

                      A string value to compare against the source. Use when Type is STRING_VALUE.

                    • NumericValue (float) --

                      A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                    • BooleanValue (boolean) --

                      A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                    • DateTimeValue (datetime) --

                      A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                • Comparator (string) -- [REQUIRED]

                  A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

              • Condition (dict) --

                A condition for item enablement.

          • Operator (string) --

            The operator to apply to the operands when more than one operand is provided.

        • Action (string) -- [REQUIRED]

          The enablement action to apply if the condition is satisfied.

        • DefaultAction (string) --

          The enablement action to apply if the condition is not satisfied. This action is also applied when the condition depends on an external source that is still pending or could not be resolved.

    • Question (dict) --

      The information of the question.

      • Title (string) -- [REQUIRED]

        The title of the question.

      • Instructions (string) --

        The instructions of the section.

      • RefId (string) -- [REQUIRED]

        The identifier of the question. An identifier must be unique within the evaluation form.

      • NotApplicableEnabled (boolean) --

        The flag to enable not applicable answers to the question.

      • QuestionType (string) -- [REQUIRED]

        The type of the question.

      • QuestionTypeProperties (dict) --

        The properties of the type of question. Text questions do not have to define question type properties.

        • Numeric (dict) --

          The properties of the numeric question.

          • MinValue (integer) -- [REQUIRED]

            The minimum answer value.

          • MaxValue (integer) -- [REQUIRED]

            The maximum answer value.

          • Options (list) --

            The scoring options of the numeric question.

            • (dict) --

              Information about the option range used for scoring in numeric questions.

              • MinValue (integer) -- [REQUIRED]

                The minimum answer value of the range option.

              • MaxValue (integer) -- [REQUIRED]

                The maximum answer value of the range option.

              • Score (integer) --

                The score assigned to answer values within the range option.

              • AutomaticFail (boolean) --

                The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

              • AutomaticFailConfiguration (dict) --

                A configuration for automatic fail.

                • TargetSection (string) --

                  The referenceId of the target section for auto failure.

              • PointsConfiguration (dict) --

                The points configuration for point-based scoring.

                • PointValue (integer) -- [REQUIRED]

                  The point value assigned to the answer option.

                • IsBonus (boolean) --

                  The flag to mark the option as a bonus option.

          • Automation (dict) --

            The automation properties of the numeric question.

            • PropertyValue (dict) --

              The property value of the automation.

              • Label (string) -- [REQUIRED]

                The property label of the automation.

            • AnswerSource (dict) --

              A source of automation answer for numeric question.

              • SourceType (string) -- [REQUIRED]

                The automation answer source type. Valid values:

                • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                • GEN_AI - The answer is generated by generative AI.

                • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

        • SingleSelect (dict) --

          The properties of the numeric question.

          • Options (list) -- [REQUIRED]

            The answer options of the single select question.

            • (dict) --

              Information about the automation configuration in single select questions.

              • RefId (string) -- [REQUIRED]

                The identifier of the answer option. An identifier must be unique within the question.

              • Text (string) -- [REQUIRED]

                The title of the answer option.

              • Score (integer) --

                The score assigned to the answer option.

              • AutomaticFail (boolean) --

                The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

              • AutomaticFailConfiguration (dict) --

                Whether automatic fail is configured on a single select question.

                • TargetSection (string) --

                  The referenceId of the target section for auto failure.

              • PointsConfiguration (dict) --

                The points configuration for point-based scoring.

                • PointValue (integer) -- [REQUIRED]

                  The point value assigned to the answer option.

                • IsBonus (boolean) --

                  The flag to mark the option as a bonus option.

          • DisplayAs (string) --

            The display mode of the single select question.

          • Automation (dict) --

            The display mode of the single select question.

            • Options (list) --

              The automation options of the single select question.

              • (dict) --

                Information about the automation option of a single select question.

                • RuleCategory (dict) --

                  The automation option based on a rule category for the single select question.

                  • Category (string) -- [REQUIRED]

                    The category name, as defined in Rules. This is equivalent to a conversational analytics rule with the same name: the automation option is applied based on whether that rule matched the contact. For more information about creating rules, see Create rules in the Connect Customer Administrator Guide.

                  • Condition (string) -- [REQUIRED]

                    The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

                  • OptionRefId (string) -- [REQUIRED]

                    The identifier of the answer option.

                • AutomationRule (dict) --

                  The automation option based on a condition for the single select question. Use with the CONDITION answer source type.

                  • Condition (dict) -- [REQUIRED]

                    The condition that must be satisfied for the answer option to be selected. The condition uses the same sources, comparators, and operators as item enablement conditions.

                    • Operands (list) -- [REQUIRED]

                      Operands of the enablement condition.

                      • (dict) --

                        An operand of the enablement condition.

                        • Expression (dict) --

                          An expression of the enablement condition.

                          • Source (dict) -- [REQUIRED]

                            A source item of enablement expression.

                            • Type (string) -- [REQUIRED]

                              A type of source item. Valid values:

                              • QUESTION_REF_ID - The answer to another question in the evaluation form.

                              • CONTACT - Data from the evaluated contact.

                              • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                              • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                            • RefId (string) --

                              A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                            • ContactField (string) --

                              The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                            • ContactAttributeKey (string) --

                              The key of the contact attribute to use as the source. Use when Type is CONTACT.

                            • SegmentAttributeKey (string) --

                              The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                            • EvaluationMetadataField (string) --

                              The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                            • AiMetricsField (string) --

                              The AI metrics field to use as the source. Use when Type is AI_METRICS.

                          • Values (list) -- [REQUIRED]

                            A list of values from source item.

                            • (dict) --

                              An enablement expression source value. Provide only the value member that matches the specified Type.

                              • Type (string) -- [REQUIRED]

                                A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                              • RefId (string) --

                                A referenceId of the source value. Use when Type is OPTION_REF_ID.

                              • StringValue (string) --

                                A string value to compare against the source. Use when Type is STRING_VALUE.

                              • NumericValue (float) --

                                A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                              • BooleanValue (boolean) --

                                A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                              • DateTimeValue (datetime) --

                                A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                          • Comparator (string) -- [REQUIRED]

                            A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

                        • Condition (dict) --

                          A condition for item enablement.

                    • Operator (string) --

                      The operator to apply to the operands when more than one operand is provided.

                  • OptionRefId (string) -- [REQUIRED]

                    The identifier of the answer option to select when the condition is satisfied.

            • DefaultOptionRefId (string) --

              The identifier of the default answer option, when none of the automation options match the criteria.

            • AnswerSource (dict) --

              Automation answer source.

              • SourceType (string) -- [REQUIRED]

                The automation answer source type. Valid values:

                • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                • GEN_AI - The answer is generated by generative AI.

                • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

        • Text (dict) --

          The properties of the text question.

          • Automation (dict) --

            The automation properties of the text question.

            • AnswerSource (dict) --

              Automation answer source.

              • SourceType (string) -- [REQUIRED]

                The automation answer source type. Valid values:

                • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                • GEN_AI - The answer is generated by generative AI.

                • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

        • MultiSelect (dict) --

          Properties for multi-select question types.

          • Options (list) -- [REQUIRED]

            Options available for this multi-select question.

            • (dict) --

              An option for a multi-select question in an evaluation form.

              • RefId (string) -- [REQUIRED]

                Reference identifier for this option.

              • Text (string) -- [REQUIRED]

                Display text for this option.

              • Score (integer) --

                The score assigned to the answer option.

              • AutomaticFail (boolean) --

                The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

              • AutomaticFailConfiguration (dict) --

                Information about automatic fail configuration for an evaluation form.

                • TargetSection (string) --

                  The referenceId of the target section for auto failure.

              • PointsConfiguration (dict) --

                The points configuration for point-based scoring.

                • PointValue (integer) -- [REQUIRED]

                  The point value assigned to the answer option.

                • IsBonus (boolean) --

                  The flag to mark the option as a bonus option.

          • DisplayAs (string) --

            Display format for the multi-select question.

          • Automation (dict) --

            Automation configuration for this multi-select question.

            • Options (list) --

              Automation options for the multi-select question.

              • (dict) --

                An automation option for a multi-select question.

                • RuleCategory (dict) --

                  Rule category configuration for this automation option.

                  • Category (string) -- [REQUIRED]

                    The category name for this automation rule.

                  • Condition (string) -- [REQUIRED]

                    The condition for this automation rule.

                  • OptionRefIds (list) -- [REQUIRED]

                    Reference IDs of options for this automation rule.

                    • (string) --

            • DefaultOptionRefIds (list) --

              Reference IDs of default options.

              • (string) --

            • AnswerSource (dict) --

              Automation answer source.

              • SourceType (string) -- [REQUIRED]

                The automation answer source type. Valid values:

                • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                • GEN_AI - The answer is generated by generative AI.

                • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

      • Enablement (dict) --

        A question conditional enablement.

        • Condition (dict) -- [REQUIRED]

          A condition for item enablement configuration.

          • Operands (list) -- [REQUIRED]

            Operands of the enablement condition.

            • (dict) --

              An operand of the enablement condition.

              • Expression (dict) --

                An expression of the enablement condition.

                • Source (dict) -- [REQUIRED]

                  A source item of enablement expression.

                  • Type (string) -- [REQUIRED]

                    A type of source item. Valid values:

                    • QUESTION_REF_ID - The answer to another question in the evaluation form.

                    • CONTACT - Data from the evaluated contact.

                    • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                    • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                  • RefId (string) --

                    A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                  • ContactField (string) --

                    The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                  • ContactAttributeKey (string) --

                    The key of the contact attribute to use as the source. Use when Type is CONTACT.

                  • SegmentAttributeKey (string) --

                    The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                  • EvaluationMetadataField (string) --

                    The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                  • AiMetricsField (string) --

                    The AI metrics field to use as the source. Use when Type is AI_METRICS.

                • Values (list) -- [REQUIRED]

                  A list of values from source item.

                  • (dict) --

                    An enablement expression source value. Provide only the value member that matches the specified Type.

                    • Type (string) -- [REQUIRED]

                      A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                    • RefId (string) --

                      A referenceId of the source value. Use when Type is OPTION_REF_ID.

                    • StringValue (string) --

                      A string value to compare against the source. Use when Type is STRING_VALUE.

                    • NumericValue (float) --

                      A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                    • BooleanValue (boolean) --

                      A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                    • DateTimeValue (datetime) --

                      A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                • Comparator (string) -- [REQUIRED]

                  A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

              • Condition (dict) --

                A condition for item enablement.

          • Operator (string) --

            The operator to apply to the operands when more than one operand is provided.

        • Action (string) -- [REQUIRED]

          The enablement action to apply if the condition is satisfied.

        • DefaultAction (string) --

          The enablement action to apply if the condition is not satisfied. This action is also applied when the condition depends on an external source that is still pending or could not be resolved.

      • Weight (float) --

        The scoring weight of the section.

      • ScoringConfiguration (dict) --

        The scoring configuration of the question.

        • PointsConfiguration (dict) --

          The points configuration for point-based scoring.

          • MaxPointValue (integer) --

            The maximum point value.

          • MinPointValue (integer) --

            The minimum point value.

          • IsBonus (boolean) --

            The flag to mark the question as a bonus question.

        • IsExcludedFromScoring (boolean) --

          The flag to exclude the question from scoring.

        • ScoreThresholds (list) --

          The score thresholds for performance categories.

          • (dict) --

            Information about a score threshold for a performance category.

            • PerformanceCategory (string) -- [REQUIRED]

              The performance category name.

            • MinScorePercentage (float) --

              The minimum score percentage for the performance category.

            • MaxScorePercentage (float) --

              The maximum score percentage for the performance category.

      • MetricConfiguration (dict) --

        The metric configuration for the question. Use this to associate a business outcome metric with the question.

        • MetricType (string) -- [REQUIRED]

          The type of metric. Currently, only BUSINESS_OUTCOME is supported.

        • MetricName (string) -- [REQUIRED]

          The name of the metric. Valid values are:

          • SALE_SUCCESS – Sale success.

          • CSAT – Customer satisfaction.

          • CHURN_PROPENSITY – Churn propensity.

          • SELF_SERVICE_SUCCESS – Self-service success.

          • PARTIAL_SELF_SERVICE_SUCCESS – Partial self-service success.

type ScoringStrategy:

dict

param ScoringStrategy:

A scoring strategy of the evaluation form.

  • Mode (string) -- [REQUIRED]

    The scoring mode of the evaluation form.

  • Status (string) -- [REQUIRED]

    The scoring status of the evaluation form.

  • ScoreThresholds (list) --

    The score thresholds for performance categories.

    • (dict) --

      Information about a score threshold for a performance category.

      • PerformanceCategory (string) -- [REQUIRED]

        The performance category name.

      • MinScorePercentage (float) --

        The minimum score percentage for the performance category.

      • MaxScorePercentage (float) --

        The maximum score percentage for the performance category.

type AutoEvaluationConfiguration:

dict

param AutoEvaluationConfiguration:

Configuration information about automated evaluations.

  • Enabled (boolean) -- [REQUIRED]

    When automated evaluation is enabled.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

type AsDraft:

boolean

param AsDraft:

A boolean flag indicating whether to create evaluation form in draft state.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

  • (string) --

    • (string) --

type ReviewConfiguration:

dict

param ReviewConfiguration:

Configuration information about evaluation reviews.

  • ReviewNotificationRecipients (list) -- [REQUIRED]

    List of recipients who should be notified when a review is requested.

    • (dict) --

      Information about a recipient who should be notified when an evaluation review is requested.

      • Type (string) -- [REQUIRED]

        The type of notification recipient.

      • Value (dict) -- [REQUIRED]

        The value associated with the notification recipient type.

        • UserId (string) --

          The user identifier for the notification recipient.

  • EligibilityDays (integer) --

    Number of days during which a request for review can be submitted for evaluations created from this form.

type TargetConfiguration:

dict

param TargetConfiguration:

Configuration that specifies the target for the evaluation form.

  • ContactInteractionType (string) -- [REQUIRED]

    The contact interaction type for this evaluation form.

type LanguageConfiguration:

dict

param LanguageConfiguration:

Configuration for language settings of the evaluation form.

  • FormLanguage (string) --

    The language for the evaluation form.

type AIVersion:

string

param AIVersion:

The AI version to use for the evaluation form. This specifies which AI model version is used for automated evaluations.

rtype:

dict

returns:

Response Syntax

{
    'EvaluationFormId': 'string',
    'EvaluationFormArn': 'string'
}

Response Structure

  • (dict) --

    • EvaluationFormId (string) --

      The unique identifier for the evaluation form.

    • EvaluationFormArn (string) --

      The Amazon Resource Name (ARN) for the evaluation form resource.

DescribeContactEvaluation (updated) Link ¶
Changes (response)
{'Evaluation': {'Answers': {'SuggestedAnswers': {'AnalysisType': {'CONDITION'}}},
                'ItemEnablementStatus': {'string': 'ENABLED | DISABLED'},
                'SourceResolutionStatus': 'PENDING | RESOLVED | FAILED',
                'SourceValues': [{'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                               '| '
                                                               'AI_SESSION_SELF_SERVICE_DURATION '
                                                               '| '
                                                               'AI_SESSION_GOAL_SUCCESS_RATE '
                                                               '| '
                                                               'AI_SESSION_COMPLETENESS_SCORE '
                                                               '| '
                                                               'AI_SESSION_FAITHFULNESS_SCORE '
                                                               '| '
                                                               'AI_AGENT_MAX_PROMPT_LATENCY '
                                                               '| '
                                                               'AI_TOOL_MAX_LATENCY '
                                                               '| '
                                                               'AI_TOOL_SELECTION_ACCURACY '
                                                               '| '
                                                               'AI_TOOL_PARAMETER_ACCURACY '
                                                               '| '
                                                               'AI_TOOL_UTILIZATION_ACCURACY',
                                             'ContactAttributeKey': 'string',
                                             'ContactField': 'CATEGORIES | '
                                                             'AGENT_ARN | '
                                                             'QUEUE_ARN | '
                                                             'ROUTING_PROFILE_ARN '
                                                             '| CHANNEL | '
                                                             'INITIATION_METHOD '
                                                             '| IS_QUEUED | '
                                                             'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                             '| '
                                                             'OVERALL_AGENT_SENTIMENT_SCORE '
                                                             '| '
                                                             'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                             '| '
                                                             'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                             '| NON_TALK_TIME '
                                                             '| '
                                                             'NON_TALK_TIME_PERCENTAGE '
                                                             '| '
                                                             'NUMBER_OF_INTERRUPTIONS '
                                                             '| '
                                                             'CONTACT_DURATION '
                                                             '| '
                                                             'AGENT_INTERACTION_DURATION '
                                                             '| '
                                                             'CUSTOMER_HOLD_TIME '
                                                             '| '
                                                             'LONGEST_HOLD_DURATION '
                                                             '| '
                                                             'NUMBER_OF_HOLDS '
                                                             '| '
                                                             'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                             '| '
                                                             'RECORDING_MEDIA_STREAM_TYPES',
                                             'EvaluationMetadataField': 'EVALUATION_TYPE',
                                             'RefId': 'string',
                                             'SegmentAttributeKey': 'string',
                                             'Type': 'QUESTION_REF_ID | '
                                                     'CONTACT | '
                                                     'EVALUATION_METADATA | '
                                                     'FORM_METADATA | '
                                                     'AI_METRICS'},
                                  'Status': 'PENDING | RESOLVED | FAILED',
                                  'Values': [{'BooleanValue': 'boolean',
                                              'DateTimeValue': 'timestamp',
                                              'NumericValue': 'double',
                                              'RefId': 'string',
                                              'StringValue': 'string',
                                              'Type': 'OPTION_REF_ID | '
                                                      'STRING_VALUE | '
                                                      'NUMERIC_VALUE | '
                                                      'BOOLEAN_VALUE | '
                                                      'DATETIME_VALUE'}]}]},
 'EvaluationForm': {'Items': {'Question': {'Enablement': {'Condition': {'Operands': {'Expression': {'Comparator': {'EQUAL_TO',
                                                                                                                   'GREATER_THAN',
                                                                                                                   'GREATER_THAN_OR_EQUAL_TO',
                                                                                                                   'LESS_THAN',
                                                                                                                   'LESS_THAN_OR_EQUAL_TO',
                                                                                                                   'NOT_EQUAL_TO'},
                                                                                                    'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                                                 '| '
                                                                                                                                 'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_MAX_LATENCY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_SELECTION_ACCURACY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                                               'ContactAttributeKey': 'string',
                                                                                                               'ContactField': 'CATEGORIES '
                                                                                                                               '| '
                                                                                                                               'AGENT_ARN '
                                                                                                                               '| '
                                                                                                                               'QUEUE_ARN '
                                                                                                                               '| '
                                                                                                                               'ROUTING_PROFILE_ARN '
                                                                                                                               '| '
                                                                                                                               'CHANNEL '
                                                                                                                               '| '
                                                                                                                               'INITIATION_METHOD '
                                                                                                                               '| '
                                                                                                                               'IS_QUEUED '
                                                                                                                               '| '
                                                                                                                               'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                                               '| '
                                                                                                                               'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                                               '| '
                                                                                                                               'NON_TALK_TIME '
                                                                                                                               '| '
                                                                                                                               'NON_TALK_TIME_PERCENTAGE '
                                                                                                                               '| '
                                                                                                                               'NUMBER_OF_INTERRUPTIONS '
                                                                                                                               '| '
                                                                                                                               'CONTACT_DURATION '
                                                                                                                               '| '
                                                                                                                               'AGENT_INTERACTION_DURATION '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_HOLD_TIME '
                                                                                                                               '| '
                                                                                                                               'LONGEST_HOLD_DURATION '
                                                                                                                               '| '
                                                                                                                               'NUMBER_OF_HOLDS '
                                                                                                                               '| '
                                                                                                                               'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                                               '| '
                                                                                                                               'RECORDING_MEDIA_STREAM_TYPES',
                                                                                                               'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                                               'SegmentAttributeKey': 'string',
                                                                                                               'Type': {'AI_METRICS',
                                                                                                                        'CONTACT',
                                                                                                                        'EVALUATION_METADATA',
                                                                                                                        'FORM_METADATA'}},
                                                                                                    'Values': {'BooleanValue': 'boolean',
                                                                                                               'DateTimeValue': 'timestamp',
                                                                                                               'NumericValue': 'double',
                                                                                                               'StringValue': 'string',
                                                                                                               'Type': {'BOOLEAN_VALUE',
                                                                                                                        'DATETIME_VALUE',
                                                                                                                        'NUMERIC_VALUE',
                                                                                                                        'STRING_VALUE'}}}}}},
                                           'QuestionTypeProperties': {'MultiSelect': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}}}},
                                                                      'Numeric': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}},
                                                                                                 'PropertyValue': {'Label': {'AI_AGENT_MAX_PROMPT_LATENCY',
                                                                                                                             'AI_SESSION_COMPLETENESS_SCORE',
                                                                                                                             'AI_SESSION_FAITHFULNESS_SCORE',
                                                                                                                             'AI_SESSION_GOAL_SUCCESS_RATE',
                                                                                                                             'AI_SESSION_SELF_SERVICE_DURATION',
                                                                                                                             'AI_TOOL_MAX_LATENCY',
                                                                                                                             'AI_TOOL_PARAMETER_ACCURACY',
                                                                                                                             'AI_TOOL_SELECTION_ACCURACY',
                                                                                                                             'AI_TOOL_UTILIZATION_ACCURACY'}}}},
                                                                      'SingleSelect': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}},
                                                                                                      'Options': {'AutomationRule': {'Condition': {'Operands': [{'Condition': (),
                                                                                                                                                                 'Expression': {'Comparator': 'IN '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'NOT_IN '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'ALL_IN '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'EXACT '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'GREATER_THAN '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'LESS_THAN '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'GREATER_THAN_OR_EQUAL_TO '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'LESS_THAN_OR_EQUAL_TO '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'EQUAL_TO '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'NOT_EQUAL_TO',
                                                                                                                                                                                'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_TOOL_MAX_LATENCY '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_TOOL_SELECTION_ACCURACY '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                                                                                                                           'ContactAttributeKey': 'string',
                                                                                                                                                                                           'ContactField': 'CATEGORIES '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'AGENT_ARN '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'QUEUE_ARN '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'ROUTING_PROFILE_ARN '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'CHANNEL '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'INITIATION_METHOD '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'IS_QUEUED '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'NON_TALK_TIME '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'NON_TALK_TIME_PERCENTAGE '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'NUMBER_OF_INTERRUPTIONS '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'CONTACT_DURATION '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'AGENT_INTERACTION_DURATION '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'CUSTOMER_HOLD_TIME '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'LONGEST_HOLD_DURATION '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'NUMBER_OF_HOLDS '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'RECORDING_MEDIA_STREAM_TYPES',
                                                                                                                                                                                           'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                                                                                                                           'RefId': 'string',
                                                                                                                                                                                           'SegmentAttributeKey': 'string',
                                                                                                                                                                                           'Type': 'QUESTION_REF_ID '
                                                                                                                                                                                                   '| '
                                                                                                                                                                                                   'CONTACT '
                                                                                                                                                                                                   '| '
                                                                                                                                                                                                   'EVALUATION_METADATA '
                                                                                                                                                                                                   '| '
                                                                                                                                                                                                   'FORM_METADATA '
                                                                                                                                                                                                   '| '
                                                                                                                                                                                                   'AI_METRICS'},
                                                                                                                                                                                'Values': [{'BooleanValue': 'boolean',
                                                                                                                                                                                            'DateTimeValue': 'timestamp',
                                                                                                                                                                                            'NumericValue': 'double',
                                                                                                                                                                                            'RefId': 'string',
                                                                                                                                                                                            'StringValue': 'string',
                                                                                                                                                                                            'Type': 'OPTION_REF_ID '
                                                                                                                                                                                                    '| '
                                                                                                                                                                                                    'STRING_VALUE '
                                                                                                                                                                                                    '| '
                                                                                                                                                                                                    'NUMERIC_VALUE '
                                                                                                                                                                                                    '| '
                                                                                                                                                                                                    'BOOLEAN_VALUE '
                                                                                                                                                                                                    '| '
                                                                                                                                                                                                    'DATETIME_VALUE'}]}}],
                                                                                                                                                   'Operator': 'OR '
                                                                                                                                                               '| '
                                                                                                                                                               'AND'},
                                                                                                                                     'OptionRefId': 'string'}}}},
                                                                      'Text': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}}}}}},
                              'Section': {'Enablement': {'Action': 'DISABLE | '
                                                                   'ENABLE',
                                                         'Condition': {'Operands': [{'Condition': (),
                                                                                     'Expression': {'Comparator': 'IN '
                                                                                                                  '| '
                                                                                                                  'NOT_IN '
                                                                                                                  '| '
                                                                                                                  'ALL_IN '
                                                                                                                  '| '
                                                                                                                  'EXACT '
                                                                                                                  '| '
                                                                                                                  'GREATER_THAN '
                                                                                                                  '| '
                                                                                                                  'LESS_THAN '
                                                                                                                  '| '
                                                                                                                  'GREATER_THAN_OR_EQUAL_TO '
                                                                                                                  '| '
                                                                                                                  'LESS_THAN_OR_EQUAL_TO '
                                                                                                                  '| '
                                                                                                                  'EQUAL_TO '
                                                                                                                  '| '
                                                                                                                  'NOT_EQUAL_TO',
                                                                                                    'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                                                 '| '
                                                                                                                                 'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_MAX_LATENCY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_SELECTION_ACCURACY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                                               'ContactAttributeKey': 'string',
                                                                                                               'ContactField': 'CATEGORIES '
                                                                                                                               '| '
                                                                                                                               'AGENT_ARN '
                                                                                                                               '| '
                                                                                                                               'QUEUE_ARN '
                                                                                                                               '| '
                                                                                                                               'ROUTING_PROFILE_ARN '
                                                                                                                               '| '
                                                                                                                               'CHANNEL '
                                                                                                                               '| '
                                                                                                                               'INITIATION_METHOD '
                                                                                                                               '| '
                                                                                                                               'IS_QUEUED '
                                                                                                                               '| '
                                                                                                                               'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                                               '| '
                                                                                                                               'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                                               '| '
                                                                                                                               'NON_TALK_TIME '
                                                                                                                               '| '
                                                                                                                               'NON_TALK_TIME_PERCENTAGE '
                                                                                                                               '| '
                                                                                                                               'NUMBER_OF_INTERRUPTIONS '
                                                                                                                               '| '
                                                                                                                               'CONTACT_DURATION '
                                                                                                                               '| '
                                                                                                                               'AGENT_INTERACTION_DURATION '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_HOLD_TIME '
                                                                                                                               '| '
                                                                                                                               'LONGEST_HOLD_DURATION '
                                                                                                                               '| '
                                                                                                                               'NUMBER_OF_HOLDS '
                                                                                                                               '| '
                                                                                                                               'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                                               '| '
                                                                                                                               'RECORDING_MEDIA_STREAM_TYPES',
                                                                                                               'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                                               'RefId': 'string',
                                                                                                               'SegmentAttributeKey': 'string',
                                                                                                               'Type': 'QUESTION_REF_ID '
                                                                                                                       '| '
                                                                                                                       'CONTACT '
                                                                                                                       '| '
                                                                                                                       'EVALUATION_METADATA '
                                                                                                                       '| '
                                                                                                                       'FORM_METADATA '
                                                                                                                       '| '
                                                                                                                       'AI_METRICS'},
                                                                                                    'Values': [{'BooleanValue': 'boolean',
                                                                                                                'DateTimeValue': 'timestamp',
                                                                                                                'NumericValue': 'double',
                                                                                                                'RefId': 'string',
                                                                                                                'StringValue': 'string',
                                                                                                                'Type': 'OPTION_REF_ID '
                                                                                                                        '| '
                                                                                                                        'STRING_VALUE '
                                                                                                                        '| '
                                                                                                                        'NUMERIC_VALUE '
                                                                                                                        '| '
                                                                                                                        'BOOLEAN_VALUE '
                                                                                                                        '| '
                                                                                                                        'DATETIME_VALUE'}]}}],
                                                                       'Operator': 'OR '
                                                                                   '| '
                                                                                   'AND'},
                                                         'DefaultAction': 'DISABLE '
                                                                          '| '
                                                                          'ENABLE'}}}}}

Describes a contact evaluation in the specified Connect Customer instance.

See also: AWS API Documentation

Request Syntax

client.describe_contact_evaluation(
    InstanceId='string',
    EvaluationId='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type EvaluationId:

string

param EvaluationId:

[REQUIRED]

A unique identifier for the contact evaluation.

rtype:

dict

returns:

Response Syntax

{
    'Evaluation': {
        'EvaluationId': 'string',
        'EvaluationArn': 'string',
        'Metadata': {
            'ContactId': 'string',
            'EvaluatorArn': 'string',
            'ContactAgentId': 'string',
            'CalibrationSessionId': 'string',
            'Score': {
                'Percentage': 123.0,
                'NotApplicable': True|False,
                'AutomaticFail': True|False,
                'AppliedWeight': 123.0,
                'EarnedPoints': 123,
                'MaxBasePoint': 123,
                'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS'
            },
            'AutoEvaluation': {
                'AutoEvaluationEnabled': True|False,
                'AutoEvaluationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
            },
            'Acknowledgement': {
                'AcknowledgedTime': datetime(2015, 1, 1),
                'AcknowledgedBy': 'string',
                'AcknowledgerComment': 'string'
            },
            'Review': {
                'ReviewId': 'string',
                'RequestedTime': datetime(2015, 1, 1),
                'RequestedBy': 'string',
                'CreatedTime': datetime(2015, 1, 1),
                'CreatedBy': 'string',
                'ReviewRequestComments': [
                    {
                        'Comment': 'string',
                        'CreatedTime': datetime(2015, 1, 1),
                        'CreatedBy': 'string'
                    },
                ]
            },
            'ContactParticipant': {
                'ContactParticipantRole': 'AGENT'|'SYSTEM'|'CUSTOM_BOT'|'CUSTOMER',
                'ContactParticipantId': 'string'
            },
            'SamplingJobId': 'string'
        },
        'Answers': {
            'string': {
                'Value': {
                    'StringValue': 'string',
                    'NumericValue': 123.0,
                    'StringValues': [
                        'string',
                    ],
                    'DateTimeValue': 'string',
                    'NotApplicable': True|False
                },
                'SystemSuggestedValue': {
                    'StringValue': 'string',
                    'NumericValue': 123.0,
                    'StringValues': [
                        'string',
                    ],
                    'DateTimeValue': 'string',
                    'NotApplicable': True|False
                },
                'SuggestedAnswers': [
                    {
                        'Value': {
                            'StringValue': 'string',
                            'NumericValue': 123.0,
                            'StringValues': [
                                'string',
                            ],
                            'DateTimeValue': 'string',
                            'NotApplicable': True|False
                        },
                        'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
                        'Input': {
                            'TranscriptType': 'RAW'|'REDACTED'
                        },
                        'AnalysisType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION',
                        'AnalysisDetails': {
                            'GenAI': {
                                'Justification': 'string',
                                'PointsOfInterest': [
                                    {
                                        'MillisecondOffsets': {
                                            'BeginOffsetMillis': 123
                                        },
                                        'TranscriptSegment': 'string'
                                    },
                                ]
                            },
                            'ContactLens': {
                                'MatchedRuleCategories': [
                                    {
                                        'Category': 'string',
                                        'Condition': 'PRESENT'|'NOT_PRESENT',
                                        'PointsOfInterest': [
                                            {
                                                'MillisecondOffsets': {
                                                    'BeginOffsetMillis': 123
                                                },
                                                'TranscriptSegment': 'string'
                                            },
                                        ]
                                    },
                                ]
                            }
                        }
                    },
                ]
            }
        },
        'Notes': {
            'string': {
                'Value': 'string'
            }
        },
        'Status': 'DRAFT'|'SUBMITTED'|'REVIEW_REQUESTED'|'UNDER_REVIEW',
        'Scores': {
            'string': {
                'Percentage': 123.0,
                'NotApplicable': True|False,
                'AutomaticFail': True|False,
                'AppliedWeight': 123.0,
                'EarnedPoints': 123,
                'MaxBasePoint': 123,
                'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS'
            }
        },
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'EvaluationType': 'STANDARD'|'CALIBRATION',
        'Tags': {
            'string': 'string'
        },
        'ItemEnablementStatus': {
            'string': 'ENABLED'|'DISABLED'
        },
        'SourceResolutionStatus': 'PENDING'|'RESOLVED'|'FAILED',
        'SourceValues': [
            {
                'Source': {
                    'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                    'RefId': 'string',
                    'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                    'ContactAttributeKey': 'string',
                    'SegmentAttributeKey': 'string',
                    'EvaluationMetadataField': 'EVALUATION_TYPE',
                    'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                },
                'Status': 'PENDING'|'RESOLVED'|'FAILED',
                'Values': [
                    {
                        'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                        'RefId': 'string',
                        'StringValue': 'string',
                        'NumericValue': 123.0,
                        'BooleanValue': True|False,
                        'DateTimeValue': datetime(2015, 1, 1)
                    },
                ]
            },
        ]
    },
    'EvaluationForm': {
        'EvaluationFormVersion': 123,
        'EvaluationFormId': 'string',
        'EvaluationFormArn': 'string',
        'Title': 'string',
        'Description': 'string',
        'Items': [
            {
                'Section': {
                    'Title': 'string',
                    'RefId': 'string',
                    'Instructions': 'string',
                    'Items': {'... recursive ...'},
                    'Weight': 123.0,
                    'IsExcludedFromScoring': True|False,
                    'ScoreThresholds': [
                        {
                            'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                            'MinScorePercentage': 123.0,
                            'MaxScorePercentage': 123.0
                        },
                    ],
                    'Enablement': {
                        'Condition': {
                            'Operands': [
                                {
                                    'Expression': {
                                        'Source': {
                                            'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                            'RefId': 'string',
                                            'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                            'ContactAttributeKey': 'string',
                                            'SegmentAttributeKey': 'string',
                                            'EvaluationMetadataField': 'EVALUATION_TYPE',
                                            'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                        },
                                        'Values': [
                                            {
                                                'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                                'RefId': 'string',
                                                'StringValue': 'string',
                                                'NumericValue': 123.0,
                                                'BooleanValue': True|False,
                                                'DateTimeValue': datetime(2015, 1, 1)
                                            },
                                        ],
                                        'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                    },
                                    'Condition': {'... recursive ...'}
                                },
                            ],
                            'Operator': 'OR'|'AND'
                        },
                        'Action': 'DISABLE'|'ENABLE',
                        'DefaultAction': 'DISABLE'|'ENABLE'
                    }
                },
                'Question': {
                    'Title': 'string',
                    'Instructions': 'string',
                    'RefId': 'string',
                    'NotApplicableEnabled': True|False,
                    'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
                    'QuestionTypeProperties': {
                        'Numeric': {
                            'MinValue': 123,
                            'MaxValue': 123,
                            'Options': [
                                {
                                    'MinValue': 123,
                                    'MaxValue': 123,
                                    'Score': 123,
                                    'AutomaticFail': True|False,
                                    'AutomaticFailConfiguration': {
                                        'TargetSection': 'string'
                                    },
                                    'PointsConfiguration': {
                                        'PointValue': 123,
                                        'IsBonus': True|False
                                    }
                                },
                            ],
                            'Automation': {
                                'PropertyValue': {
                                    'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                },
                                'AnswerSource': {
                                    'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                                }
                            }
                        },
                        'SingleSelect': {
                            'Options': [
                                {
                                    'RefId': 'string',
                                    'Text': 'string',
                                    'Score': 123,
                                    'AutomaticFail': True|False,
                                    'AutomaticFailConfiguration': {
                                        'TargetSection': 'string'
                                    },
                                    'PointsConfiguration': {
                                        'PointValue': 123,
                                        'IsBonus': True|False
                                    }
                                },
                            ],
                            'DisplayAs': 'DROPDOWN'|'RADIO',
                            'Automation': {
                                'Options': [
                                    {
                                        'RuleCategory': {
                                            'Category': 'string',
                                            'Condition': 'PRESENT'|'NOT_PRESENT',
                                            'OptionRefId': 'string'
                                        },
                                        'AutomationRule': {
                                            'Condition': {
                                                'Operands': [
                                                    {
                                                        'Expression': {
                                                            'Source': {
                                                                'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                                                'RefId': 'string',
                                                                'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                                                'ContactAttributeKey': 'string',
                                                                'SegmentAttributeKey': 'string',
                                                                'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                                            },
                                                            'Values': [
                                                                {
                                                                    'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                                                    'RefId': 'string',
                                                                    'StringValue': 'string',
                                                                    'NumericValue': 123.0,
                                                                    'BooleanValue': True|False,
                                                                    'DateTimeValue': datetime(2015, 1, 1)
                                                                },
                                                            ],
                                                            'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                                        },
                                                        'Condition': {'... recursive ...'}
                                                    },
                                                ],
                                                'Operator': 'OR'|'AND'
                                            },
                                            'OptionRefId': 'string'
                                        }
                                    },
                                ],
                                'DefaultOptionRefId': 'string',
                                'AnswerSource': {
                                    'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                                }
                            }
                        },
                        'Text': {
                            'Automation': {
                                'AnswerSource': {
                                    'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                                }
                            }
                        },
                        'MultiSelect': {
                            'Options': [
                                {
                                    'RefId': 'string',
                                    'Text': 'string',
                                    'Score': 123,
                                    'AutomaticFail': True|False,
                                    'AutomaticFailConfiguration': {
                                        'TargetSection': 'string'
                                    },
                                    'PointsConfiguration': {
                                        'PointValue': 123,
                                        'IsBonus': True|False
                                    }
                                },
                            ],
                            'DisplayAs': 'DROPDOWN'|'CHECKBOX',
                            'Automation': {
                                'Options': [
                                    {
                                        'RuleCategory': {
                                            'Category': 'string',
                                            'Condition': 'PRESENT'|'NOT_PRESENT',
                                            'OptionRefIds': [
                                                'string',
                                            ]
                                        }
                                    },
                                ],
                                'DefaultOptionRefIds': [
                                    'string',
                                ],
                                'AnswerSource': {
                                    'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                                }
                            }
                        }
                    },
                    'Enablement': {
                        'Condition': {
                            'Operands': [
                                {
                                    'Expression': {
                                        'Source': {
                                            'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                            'RefId': 'string',
                                            'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                            'ContactAttributeKey': 'string',
                                            'SegmentAttributeKey': 'string',
                                            'EvaluationMetadataField': 'EVALUATION_TYPE',
                                            'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                        },
                                        'Values': [
                                            {
                                                'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                                'RefId': 'string',
                                                'StringValue': 'string',
                                                'NumericValue': 123.0,
                                                'BooleanValue': True|False,
                                                'DateTimeValue': datetime(2015, 1, 1)
                                            },
                                        ],
                                        'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                    },
                                    'Condition': {'... recursive ...'}
                                },
                            ],
                            'Operator': 'OR'|'AND'
                        },
                        'Action': 'DISABLE'|'ENABLE',
                        'DefaultAction': 'DISABLE'|'ENABLE'
                    },
                    'Weight': 123.0,
                    'ScoringConfiguration': {
                        'PointsConfiguration': {
                            'MaxPointValue': 123,
                            'MinPointValue': 123,
                            'IsBonus': True|False
                        },
                        'IsExcludedFromScoring': True|False,
                        'ScoreThresholds': [
                            {
                                'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                                'MinScorePercentage': 123.0,
                                'MaxScorePercentage': 123.0
                            },
                        ]
                    },
                    'MetricConfiguration': {
                        'MetricType': 'BUSINESS_OUTCOME',
                        'MetricName': 'string'
                    }
                }
            },
        ],
        'ScoringStrategy': {
            'Mode': 'QUESTION_ONLY'|'SECTION_ONLY'|'POINTS_BASED',
            'Status': 'ENABLED'|'DISABLED',
            'ScoreThresholds': [
                {
                    'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                    'MinScorePercentage': 123.0,
                    'MaxScorePercentage': 123.0
                },
            ]
        },
        'AutoEvaluationConfiguration': {
            'Enabled': True|False
        },
        'TargetConfiguration': {
            'ContactInteractionType': 'AGENT'|'AUTOMATED'|'CUSTOMER'
        },
        'LanguageConfiguration': {
            'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'|'ms-MY'|'af-ZA'|'sq-AL'|'am-ET'|'ar-AE'|'ar-SA'|'hy-AM'|'eu-ES'|'be-BY'|'bs-BA'|'bg-BG'|'ca-ES'|'ckb-IR'|'ckb-IQ'|'zh-TW'|'hr-HR'|'cs-CZ'|'da-DK'|'nl-BE'|'nl-NL'|'en-AU'|'en-IN'|'en-IE'|'en-NZ'|'en-AB'|'en-SG'|'en-ZA'|'en-GB'|'en-WL'|'fa-IR'|'fa-AF'|'fi-FI'|'fr-BE'|'fr-CA'|'ga-IE'|'gl-ES'|'ka-GE'|'de-AT'|'de-CH'|'el-GR'|'gu-IN'|'ht-HT'|'he-IL'|'hi-IN'|'hu-HU'|'is-IS'|'id-ID'|'jv-ID'|'km-KH'|'kn-IN'|'kk-KZ'|'lo-LA'|'lv-LV'|'lt-LT'|'mk-MK'|'ml-IN'|'mr-IN'|'ne-NP'|'no-NO'|'or-IN'|'ps-AF'|'pl-PL'|'pt-PT'|'pa-IN'|'ro-RO'|'ru-RU'|'sr-RS'|'si-LK'|'sk-SK'|'sl-SI'|'es-MX'|'es-US'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'sv-SE'|'tl-PH'|'ta-IN'|'te-IN'|'th-TH'|'tr-TR'|'uk-UA'|'uz-UZ'|'vi-VN'|'zu-ZA'|'my-MM'|'so-SO'|'yue-HK'|'et-EE'|'hmn'|'lg-UG'|'cy-GB'|'xh-ZA'|'bn-BD'
        },
        'ReviewConfiguration': {
            'ReviewNotificationRecipients': [
                {
                    'Type': 'USER_ID',
                    'Value': {
                        'UserId': 'string'
                    }
                },
            ],
            'EligibilityDays': 123
        },
        'AIVersion': 'string'
    }
}

Response Structure

  • (dict) --

    • Evaluation (dict) --

      Information about the evaluation form completed for a specific contact.

      • EvaluationId (string) --

        A unique identifier for the contact evaluation.

      • EvaluationArn (string) --

        The Amazon Resource Name (ARN) for the contact evaluation resource.

      • Metadata (dict) --

        Metadata about the contact evaluation.

        • ContactId (string) --

          The identifier of the contact in this instance of Connect Customer.

        • EvaluatorArn (string) --

          The Amazon Resource Name (ARN) of the user who last updated the evaluation.

        • ContactAgentId (string) --

          The identifier of the agent who performed the contact.

        • CalibrationSessionId (string) --

          The calibration session ID that this evaluation belongs to.

        • Score (dict) --

          The overall score of the contact evaluation.

          • Percentage (float) --

            The score percentage for an item in a contact evaluation.

          • NotApplicable (boolean) --

            The flag to mark the item as not applicable for scoring.

          • AutomaticFail (boolean) --

            The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.

          • AppliedWeight (float) --

            Weight applied to this evaluation score.

          • EarnedPoints (integer) --

            The points earned for the item.

          • MaxBasePoint (integer) --

            The maximum base points possible for the item.

          • PerformanceCategory (string) --

            The performance category for the score.

        • AutoEvaluation (dict) --

          Information related to automated evaluation.

          • AutoEvaluationEnabled (boolean) --

            Whether automated evaluation is enabled.

          • AutoEvaluationStatus (string) --

            The status of the contact auto-evaluation.

        • Acknowledgement (dict) --

          Information related to evaluation acknowledgement.

          • AcknowledgedTime (datetime) --

            When the agent acknowledged the evaluation.

          • AcknowledgedBy (string) --

            The agent who acknowledged the evaluation.

          • AcknowledgerComment (string) --

            A comment from the agent when they confirmed they acknowledged the evaluation.

        • Review (dict) --

          Information about reviews of this evaluation.

          • ReviewId (string) --

            The unique identifier for the evaluation review.

          • RequestedTime (datetime) --

            The timestamp when the evaluation review was requested.

          • RequestedBy (string) --

            The user who requested the evaluation review.

          • CreatedTime (datetime) --

            The timestamp when the evaluation review was created.

          • CreatedBy (string) --

            The user who created the evaluation review.

          • ReviewRequestComments (list) --

            Comments provided when requesting the evaluation review.

            • (dict) --

              A comment provided when requesting an evaluation review.

              • Comment (string) --

                The text content of the review request comment.

              • CreatedTime (datetime) --

                The timestamp when the evaluation review request comment was created.

              • CreatedBy (string) --

                The user who created the evaluation review request comment.

        • ContactParticipant (dict) --

          Information about a contact participant in this evaluation.

          • ContactParticipantRole (string) --

            The role of the contact participant.

          • ContactParticipantId (string) --

            The identifier for the contact participant.

        • SamplingJobId (string) --

          Identifier of the sampling job.

      • Answers (dict) --

        A map of question identifiers to answer value.

        • (string) --

          • (dict) --

            Information about output answers for a contact evaluation.

            • Value (dict) --

              The value for an answer in a contact evaluation.

              • StringValue (string) --

                The string value for an answer in a contact evaluation.

              • NumericValue (float) --

                The numeric value for an answer in a contact evaluation.

              • StringValues (list) --

                String values provided as answers to evaluation questions.

                • (string) --

              • DateTimeValue (string) --

                Date and time value provided as an answer to an evaluation question.

              • NotApplicable (boolean) --

                The flag to mark the question as not applicable.

            • SystemSuggestedValue (dict) --

              The system suggested value for an answer in a contact evaluation.

              • StringValue (string) --

                The string value for an answer in a contact evaluation.

              • NumericValue (float) --

                The numeric value for an answer in a contact evaluation.

              • StringValues (list) --

                String values provided as answers to evaluation questions.

                • (string) --

              • DateTimeValue (string) --

                Date and time value provided as an answer to an evaluation question.

              • NotApplicable (boolean) --

                The flag to mark the question as not applicable.

            • SuggestedAnswers (list) --

              Automation suggested answers for the questions.

              • (dict) --

                The information about the suggested answer for the question.

                • Value (dict) --

                  Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.

                  • StringValue (string) --

                    The string value for an answer in a contact evaluation.

                  • NumericValue (float) --

                    The numeric value for an answer in a contact evaluation.

                  • StringValues (list) --

                    String values provided as answers to evaluation questions.

                    • (string) --

                  • DateTimeValue (string) --

                    Date and time value provided as an answer to an evaluation question.

                  • NotApplicable (boolean) --

                    The flag to mark the question as not applicable.

                • Status (string) --

                  The status of the suggested answer. D

                • Input (dict) --

                  Details about the input used to question automation.

                  • TranscriptType (string) --

                    Transcript type.

                • AnalysisType (string) --

                  Type of analysis used to provide suggested answer. Valid values: CONTACT_LENS_DATA | GEN_AI | CONDITION.

                • AnalysisDetails (dict) --

                  Detailed analysis results.

                  • GenAI (dict) --

                    Analysis results from the generative AI automation for the question.

                    • Justification (string) --

                      Generative AI automation answer justification.

                    • PointsOfInterest (list) --

                      Generative AI automation answer analysis points of interest.

                      • (dict) --

                        Information about the point of interest in transcript provided to evaluation.

                        • MillisecondOffsets (dict) --

                          Offset in milliseconds from the beginning of transcript.

                          • BeginOffsetMillis (integer) --

                            Offset in milliseconds from the beginning of the transcript.

                        • TranscriptSegment (string) --

                          Segment of transcript.

                  • ContactLens (dict) --

                    Analysis results from the Contact Lens automation for the question.

                    • MatchedRuleCategories (list) --

                      A list of match rule categories.

                      • (dict) --

                        The Contact Lens category used by evaluation automation.

                        • Category (string) --

                          A category label.

                        • Condition (string) --

                          An automation condition for a Contact Lens category.

                        • PointsOfInterest (list) --

                          A point of interest in a contact transcript that indicates match of condition.

                          • (dict) --

                            Information about the point of interest in transcript provided to evaluation.

                            • MillisecondOffsets (dict) --

                              Offset in milliseconds from the beginning of transcript.

                              • BeginOffsetMillis (integer) --

                                Offset in milliseconds from the beginning of the transcript.

                            • TranscriptSegment (string) --

                              Segment of transcript.

      • Notes (dict) --

        A map of question identifiers to note value.

        • (string) --

          • (dict) --

            Information about notes for a contact evaluation.

            • Value (string) --

              The note for an item (section or question) in a contact evaluation.

      • Status (string) --

        The status of the contact evaluation.

      • Scores (dict) --

        A map of item (section or question) identifiers to score value.

        • (string) --

          • (dict) --

            Information about scores of a contact evaluation item (section or question).

            • Percentage (float) --

              The score percentage for an item in a contact evaluation.

            • NotApplicable (boolean) --

              The flag to mark the item as not applicable for scoring.

            • AutomaticFail (boolean) --

              The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.

            • AppliedWeight (float) --

              Weight applied to this evaluation score.

            • EarnedPoints (integer) --

              The points earned for the item.

            • MaxBasePoint (integer) --

              The maximum base points possible for the item.

            • PerformanceCategory (string) --

              The performance category for the score.

      • CreatedTime (datetime) --

        The timestamp for when the evaluation was created.

      • LastModifiedTime (datetime) --

        The timestamp for when the evaluation was last updated.

      • EvaluationType (string) --

        Type of the evaluation.

      • Tags (dict) --

        The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

        • (string) --

          • (string) --

      • ItemEnablementStatus (dict) --

        A map of item (section or question) identifiers to their enablement status, computed by the service from each item's conditional enablement configuration. Disabled items are excluded from scoring. Valid values: ENABLED | DISABLED.

        • (string) --

          • (string) --

      • SourceResolutionStatus (string) --

        The aggregate status of resolving the external source data (such as Contact Lens analysis and AI metrics) that is used by conditional enablement in the evaluation. Source data is resolved asynchronously after the evaluation is started. While a source is pending or after it fails to resolve, conditions that depend on it evaluate to the item's DefaultAction. Valid values:

        • PENDING - One or more sources have not been resolved yet. Call DescribeContactEvaluation again to get updated ItemEnablementStatus values.

        • RESOLVED - All sources have been resolved.

        • FAILED - One or more sources could not be resolved. Dependent conditions use the item's DefaultAction.

      • SourceValues (list) --

        The resolved values of the external sources (such as contact data, evaluation metadata, form metadata, and AI metrics) that are used by the conditions in the evaluation form. You can use these values to evaluate the conditions against the current answers without calling DescribeContactEvaluation again.

        • (dict) --

          The resolved value of an external source that is used by the conditions in an evaluation form.

          • Source (dict) --

            The external source, such as contact data, evaluation metadata, form metadata, or AI metrics.

            • Type (string) --

              A type of source item. Valid values:

              • QUESTION_REF_ID - The answer to another question in the evaluation form.

              • CONTACT - Data from the evaluated contact.

              • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

              • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

            • RefId (string) --

              A referenceId of the source item. Use when Type is QUESTION_REF_ID.

            • ContactField (string) --

              The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

            • ContactAttributeKey (string) --

              The key of the contact attribute to use as the source. Use when Type is CONTACT.

            • SegmentAttributeKey (string) --

              The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

            • EvaluationMetadataField (string) --

              The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

            • AiMetricsField (string) --

              The AI metrics field to use as the source. Use when Type is AI_METRICS.

          • Status (string) --

            The status of resolving the source. Valid values:

            • PENDING - The source has not been resolved yet.

            • RESOLVED - The source has been resolved.

            • FAILED - The source could not be resolved.

          • Values (list) --

            The resolved values of the source. Present when Status is RESOLVED. Contains one value for a single-valued source, any number of values for a multi-valued source, and no values when the source is not present on the contact.

            • (dict) --

              An enablement expression source value. Provide only the value member that matches the specified Type.

              • Type (string) --

                A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

              • RefId (string) --

                A referenceId of the source value. Use when Type is OPTION_REF_ID.

              • StringValue (string) --

                A string value to compare against the source. Use when Type is STRING_VALUE.

              • NumericValue (float) --

                A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

              • BooleanValue (boolean) --

                A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

              • DateTimeValue (datetime) --

                A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

    • EvaluationForm (dict) --

      Information about the evaluation form.

      • EvaluationFormVersion (integer) --

        A version of the evaluation form.

      • EvaluationFormId (string) --

        The unique identifier for the evaluation form.

      • EvaluationFormArn (string) --

        The Amazon Resource Name (ARN) for the evaluation form resource.

      • Title (string) --

        A title of the evaluation form.

      • Description (string) --

        The description of the evaluation form.

      • Items (list) --

        Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

        • (dict) --

          Information about an item from an evaluation form. The item must be either a section or a question.

          • Section (dict) --

            The information of the section.

            • Title (string) --

              The title of the section.

            • RefId (string) --

              The identifier of the section. An identifier must be unique within the evaluation form.

            • Instructions (string) --

              The instructions of the section.

            • Items (list) --

              The items of the section.

            • Weight (float) --

              The scoring weight of the section.

            • IsExcludedFromScoring (boolean) --

              The flag to exclude the section from scoring.

            • ScoreThresholds (list) --

              The score thresholds for performance categories.

              • (dict) --

                Information about a score threshold for a performance category.

                • PerformanceCategory (string) --

                  The performance category name.

                • MinScorePercentage (float) --

                  The minimum score percentage for the performance category.

                • MaxScorePercentage (float) --

                  The maximum score percentage for the performance category.

            • Enablement (dict) --

              The conditional enablement configuration of the section. Sections use the same enablement model as questions.

              • Condition (dict) --

                A condition for item enablement configuration.

                • Operands (list) --

                  Operands of the enablement condition.

                  • (dict) --

                    An operand of the enablement condition.

                    • Expression (dict) --

                      An expression of the enablement condition.

                      • Source (dict) --

                        A source item of enablement expression.

                        • Type (string) --

                          A type of source item. Valid values:

                          • QUESTION_REF_ID - The answer to another question in the evaluation form.

                          • CONTACT - Data from the evaluated contact.

                          • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                          • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                        • RefId (string) --

                          A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                        • ContactField (string) --

                          The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                        • ContactAttributeKey (string) --

                          The key of the contact attribute to use as the source. Use when Type is CONTACT.

                        • SegmentAttributeKey (string) --

                          The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                        • EvaluationMetadataField (string) --

                          The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                        • AiMetricsField (string) --

                          The AI metrics field to use as the source. Use when Type is AI_METRICS.

                      • Values (list) --

                        A list of values from source item.

                        • (dict) --

                          An enablement expression source value. Provide only the value member that matches the specified Type.

                          • Type (string) --

                            A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                          • RefId (string) --

                            A referenceId of the source value. Use when Type is OPTION_REF_ID.

                          • StringValue (string) --

                            A string value to compare against the source. Use when Type is STRING_VALUE.

                          • NumericValue (float) --

                            A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                          • BooleanValue (boolean) --

                            A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                          • DateTimeValue (datetime) --

                            A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                      • Comparator (string) --

                        A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

                    • Condition (dict) --

                      A condition for item enablement.

                • Operator (string) --

                  The operator to apply to the operands when more than one operand is provided.

              • Action (string) --

                The enablement action to apply if the condition is satisfied.

              • DefaultAction (string) --

                The enablement action to apply if the condition is not satisfied. This action is also applied when the condition depends on an external source that is still pending or could not be resolved.

          • Question (dict) --

            The information of the question.

            • Title (string) --

              The title of the question.

            • Instructions (string) --

              The instructions of the section.

            • RefId (string) --

              The identifier of the question. An identifier must be unique within the evaluation form.

            • NotApplicableEnabled (boolean) --

              The flag to enable not applicable answers to the question.

            • QuestionType (string) --

              The type of the question.

            • QuestionTypeProperties (dict) --

              The properties of the type of question. Text questions do not have to define question type properties.

              • Numeric (dict) --

                The properties of the numeric question.

                • MinValue (integer) --

                  The minimum answer value.

                • MaxValue (integer) --

                  The maximum answer value.

                • Options (list) --

                  The scoring options of the numeric question.

                  • (dict) --

                    Information about the option range used for scoring in numeric questions.

                    • MinValue (integer) --

                      The minimum answer value of the range option.

                    • MaxValue (integer) --

                      The maximum answer value of the range option.

                    • Score (integer) --

                      The score assigned to answer values within the range option.

                    • AutomaticFail (boolean) --

                      The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                    • AutomaticFailConfiguration (dict) --

                      A configuration for automatic fail.

                      • TargetSection (string) --

                        The referenceId of the target section for auto failure.

                    • PointsConfiguration (dict) --

                      The points configuration for point-based scoring.

                      • PointValue (integer) --

                        The point value assigned to the answer option.

                      • IsBonus (boolean) --

                        The flag to mark the option as a bonus option.

                • Automation (dict) --

                  The automation properties of the numeric question.

                  • PropertyValue (dict) --

                    The property value of the automation.

                    • Label (string) --

                      The property label of the automation.

                  • AnswerSource (dict) --

                    A source of automation answer for numeric question.

                    • SourceType (string) --

                      The automation answer source type. Valid values:

                      • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                      • GEN_AI - The answer is generated by generative AI.

                      • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

              • SingleSelect (dict) --

                The properties of the numeric question.

                • Options (list) --

                  The answer options of the single select question.

                  • (dict) --

                    Information about the automation configuration in single select questions.

                    • RefId (string) --

                      The identifier of the answer option. An identifier must be unique within the question.

                    • Text (string) --

                      The title of the answer option.

                    • Score (integer) --

                      The score assigned to the answer option.

                    • AutomaticFail (boolean) --

                      The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                    • AutomaticFailConfiguration (dict) --

                      Whether automatic fail is configured on a single select question.

                      • TargetSection (string) --

                        The referenceId of the target section for auto failure.

                    • PointsConfiguration (dict) --

                      The points configuration for point-based scoring.

                      • PointValue (integer) --

                        The point value assigned to the answer option.

                      • IsBonus (boolean) --

                        The flag to mark the option as a bonus option.

                • DisplayAs (string) --

                  The display mode of the single select question.

                • Automation (dict) --

                  The display mode of the single select question.

                  • Options (list) --

                    The automation options of the single select question.

                    • (dict) --

                      Information about the automation option of a single select question.

                      • RuleCategory (dict) --

                        The automation option based on a rule category for the single select question.

                        • Category (string) --

                          The category name, as defined in Rules. This is equivalent to a conversational analytics rule with the same name: the automation option is applied based on whether that rule matched the contact. For more information about creating rules, see Create rules in the Connect Customer Administrator Guide.

                        • Condition (string) --

                          The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

                        • OptionRefId (string) --

                          The identifier of the answer option.

                      • AutomationRule (dict) --

                        The automation option based on a condition for the single select question. Use with the CONDITION answer source type.

                        • Condition (dict) --

                          The condition that must be satisfied for the answer option to be selected. The condition uses the same sources, comparators, and operators as item enablement conditions.

                          • Operands (list) --

                            Operands of the enablement condition.

                            • (dict) --

                              An operand of the enablement condition.

                              • Expression (dict) --

                                An expression of the enablement condition.

                                • Source (dict) --

                                  A source item of enablement expression.

                                  • Type (string) --

                                    A type of source item. Valid values:

                                    • QUESTION_REF_ID - The answer to another question in the evaluation form.

                                    • CONTACT - Data from the evaluated contact.

                                    • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                                    • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                                  • RefId (string) --

                                    A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                                  • ContactField (string) --

                                    The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                                  • ContactAttributeKey (string) --

                                    The key of the contact attribute to use as the source. Use when Type is CONTACT.

                                  • SegmentAttributeKey (string) --

                                    The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                                  • EvaluationMetadataField (string) --

                                    The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                                  • AiMetricsField (string) --

                                    The AI metrics field to use as the source. Use when Type is AI_METRICS.

                                • Values (list) --

                                  A list of values from source item.

                                  • (dict) --

                                    An enablement expression source value. Provide only the value member that matches the specified Type.

                                    • Type (string) --

                                      A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                                    • RefId (string) --

                                      A referenceId of the source value. Use when Type is OPTION_REF_ID.

                                    • StringValue (string) --

                                      A string value to compare against the source. Use when Type is STRING_VALUE.

                                    • NumericValue (float) --

                                      A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                                    • BooleanValue (boolean) --

                                      A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                                    • DateTimeValue (datetime) --

                                      A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                                • Comparator (string) --

                                  A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

                              • Condition (dict) --

                                A condition for item enablement.

                          • Operator (string) --

                            The operator to apply to the operands when more than one operand is provided.

                        • OptionRefId (string) --

                          The identifier of the answer option to select when the condition is satisfied.

                  • DefaultOptionRefId (string) --

                    The identifier of the default answer option, when none of the automation options match the criteria.

                  • AnswerSource (dict) --

                    Automation answer source.

                    • SourceType (string) --

                      The automation answer source type. Valid values:

                      • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                      • GEN_AI - The answer is generated by generative AI.

                      • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

              • Text (dict) --

                The properties of the text question.

                • Automation (dict) --

                  The automation properties of the text question.

                  • AnswerSource (dict) --

                    Automation answer source.

                    • SourceType (string) --

                      The automation answer source type. Valid values:

                      • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                      • GEN_AI - The answer is generated by generative AI.

                      • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

              • MultiSelect (dict) --

                Properties for multi-select question types.

                • Options (list) --

                  Options available for this multi-select question.

                  • (dict) --

                    An option for a multi-select question in an evaluation form.

                    • RefId (string) --

                      Reference identifier for this option.

                    • Text (string) --

                      Display text for this option.

                    • Score (integer) --

                      The score assigned to the answer option.

                    • AutomaticFail (boolean) --

                      The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                    • AutomaticFailConfiguration (dict) --

                      Information about automatic fail configuration for an evaluation form.

                      • TargetSection (string) --

                        The referenceId of the target section for auto failure.

                    • PointsConfiguration (dict) --

                      The points configuration for point-based scoring.

                      • PointValue (integer) --

                        The point value assigned to the answer option.

                      • IsBonus (boolean) --

                        The flag to mark the option as a bonus option.

                • DisplayAs (string) --

                  Display format for the multi-select question.

                • Automation (dict) --

                  Automation configuration for this multi-select question.

                  • Options (list) --

                    Automation options for the multi-select question.

                    • (dict) --

                      An automation option for a multi-select question.

                      • RuleCategory (dict) --

                        Rule category configuration for this automation option.

                        • Category (string) --

                          The category name for this automation rule.

                        • Condition (string) --

                          The condition for this automation rule.

                        • OptionRefIds (list) --

                          Reference IDs of options for this automation rule.

                          • (string) --

                  • DefaultOptionRefIds (list) --

                    Reference IDs of default options.

                    • (string) --

                  • AnswerSource (dict) --

                    Automation answer source.

                    • SourceType (string) --

                      The automation answer source type. Valid values:

                      • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                      • GEN_AI - The answer is generated by generative AI.

                      • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

            • Enablement (dict) --

              A question conditional enablement.

              • Condition (dict) --

                A condition for item enablement configuration.

                • Operands (list) --

                  Operands of the enablement condition.

                  • (dict) --

                    An operand of the enablement condition.

                    • Expression (dict) --

                      An expression of the enablement condition.

                      • Source (dict) --

                        A source item of enablement expression.

                        • Type (string) --

                          A type of source item. Valid values:

                          • QUESTION_REF_ID - The answer to another question in the evaluation form.

                          • CONTACT - Data from the evaluated contact.

                          • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                          • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                        • RefId (string) --

                          A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                        • ContactField (string) --

                          The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                        • ContactAttributeKey (string) --

                          The key of the contact attribute to use as the source. Use when Type is CONTACT.

                        • SegmentAttributeKey (string) --

                          The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                        • EvaluationMetadataField (string) --

                          The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                        • AiMetricsField (string) --

                          The AI metrics field to use as the source. Use when Type is AI_METRICS.

                      • Values (list) --

                        A list of values from source item.

                        • (dict) --

                          An enablement expression source value. Provide only the value member that matches the specified Type.

                          • Type (string) --

                            A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                          • RefId (string) --

                            A referenceId of the source value. Use when Type is OPTION_REF_ID.

                          • StringValue (string) --

                            A string value to compare against the source. Use when Type is STRING_VALUE.

                          • NumericValue (float) --

                            A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                          • BooleanValue (boolean) --

                            A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                          • DateTimeValue (datetime) --

                            A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                      • Comparator (string) --

                        A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

                    • Condition (dict) --

                      A condition for item enablement.

                • Operator (string) --

                  The operator to apply to the operands when more than one operand is provided.

              • Action (string) --

                The enablement action to apply if the condition is satisfied.

              • DefaultAction (string) --

                The enablement action to apply if the condition is not satisfied. This action is also applied when the condition depends on an external source that is still pending or could not be resolved.

            • Weight (float) --

              The scoring weight of the section.

            • ScoringConfiguration (dict) --

              The scoring configuration of the question.

              • PointsConfiguration (dict) --

                The points configuration for point-based scoring.

                • MaxPointValue (integer) --

                  The maximum point value.

                • MinPointValue (integer) --

                  The minimum point value.

                • IsBonus (boolean) --

                  The flag to mark the question as a bonus question.

              • IsExcludedFromScoring (boolean) --

                The flag to exclude the question from scoring.

              • ScoreThresholds (list) --

                The score thresholds for performance categories.

                • (dict) --

                  Information about a score threshold for a performance category.

                  • PerformanceCategory (string) --

                    The performance category name.

                  • MinScorePercentage (float) --

                    The minimum score percentage for the performance category.

                  • MaxScorePercentage (float) --

                    The maximum score percentage for the performance category.

            • MetricConfiguration (dict) --

              The metric configuration for the question. Use this to associate a business outcome metric with the question.

              • MetricType (string) --

                The type of metric. Currently, only BUSINESS_OUTCOME is supported.

              • MetricName (string) --

                The name of the metric. Valid values are:

                • SALE_SUCCESS – Sale success.

                • CSAT – Customer satisfaction.

                • CHURN_PROPENSITY – Churn propensity.

                • SELF_SERVICE_SUCCESS – Self-service success.

                • PARTIAL_SELF_SERVICE_SUCCESS – Partial self-service success.

      • ScoringStrategy (dict) --

        A scoring strategy of the evaluation form.

        • Mode (string) --

          The scoring mode of the evaluation form.

        • Status (string) --

          The scoring status of the evaluation form.

        • ScoreThresholds (list) --

          The score thresholds for performance categories.

          • (dict) --

            Information about a score threshold for a performance category.

            • PerformanceCategory (string) --

              The performance category name.

            • MinScorePercentage (float) --

              The minimum score percentage for the performance category.

            • MaxScorePercentage (float) --

              The maximum score percentage for the performance category.

      • AutoEvaluationConfiguration (dict) --

        The configuration of the automated evaluation.

        • Enabled (boolean) --

          When automated evaluation is enabled.

      • TargetConfiguration (dict) --

        Configuration that specifies the target for this evaluation form content.

        • ContactInteractionType (string) --

          The contact interaction type for this evaluation form.

      • LanguageConfiguration (dict) --

        Configuration for language settings of this evaluation form content.

        • FormLanguage (string) --

          The language for the evaluation form.

      • ReviewConfiguration (dict) --

        Configuration for evaluation review settings of this evaluation form content.

        • ReviewNotificationRecipients (list) --

          List of recipients who should be notified when a review is requested.

          • (dict) --

            Information about a recipient who should be notified when an evaluation review is requested.

            • Type (string) --

              The type of notification recipient.

            • Value (dict) --

              The value associated with the notification recipient type.

              • UserId (string) --

                The user identifier for the notification recipient.

        • EligibilityDays (integer) --

          Number of days during which a request for review can be submitted for evaluations created from this form.

      • AIVersion (string) --

        The AI version to use for the evaluation form. This specifies which AI model version is used for automated evaluations.

DescribeEvaluationForm (updated) Link ¶
Changes (response)
{'EvaluationForm': {'Items': {'Question': {'Enablement': {'Condition': {'Operands': {'Expression': {'Comparator': {'EQUAL_TO',
                                                                                                                   'GREATER_THAN',
                                                                                                                   'GREATER_THAN_OR_EQUAL_TO',
                                                                                                                   'LESS_THAN',
                                                                                                                   'LESS_THAN_OR_EQUAL_TO',
                                                                                                                   'NOT_EQUAL_TO'},
                                                                                                    'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                                                 '| '
                                                                                                                                 'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_MAX_LATENCY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_SELECTION_ACCURACY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                                               'ContactAttributeKey': 'string',
                                                                                                               'ContactField': 'CATEGORIES '
                                                                                                                               '| '
                                                                                                                               'AGENT_ARN '
                                                                                                                               '| '
                                                                                                                               'QUEUE_ARN '
                                                                                                                               '| '
                                                                                                                               'ROUTING_PROFILE_ARN '
                                                                                                                               '| '
                                                                                                                               'CHANNEL '
                                                                                                                               '| '
                                                                                                                               'INITIATION_METHOD '
                                                                                                                               '| '
                                                                                                                               'IS_QUEUED '
                                                                                                                               '| '
                                                                                                                               'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                                               '| '
                                                                                                                               'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                                               '| '
                                                                                                                               'NON_TALK_TIME '
                                                                                                                               '| '
                                                                                                                               'NON_TALK_TIME_PERCENTAGE '
                                                                                                                               '| '
                                                                                                                               'NUMBER_OF_INTERRUPTIONS '
                                                                                                                               '| '
                                                                                                                               'CONTACT_DURATION '
                                                                                                                               '| '
                                                                                                                               'AGENT_INTERACTION_DURATION '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_HOLD_TIME '
                                                                                                                               '| '
                                                                                                                               'LONGEST_HOLD_DURATION '
                                                                                                                               '| '
                                                                                                                               'NUMBER_OF_HOLDS '
                                                                                                                               '| '
                                                                                                                               'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                                               '| '
                                                                                                                               'RECORDING_MEDIA_STREAM_TYPES',
                                                                                                               'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                                               'SegmentAttributeKey': 'string',
                                                                                                               'Type': {'AI_METRICS',
                                                                                                                        'CONTACT',
                                                                                                                        'EVALUATION_METADATA',
                                                                                                                        'FORM_METADATA'}},
                                                                                                    'Values': {'BooleanValue': 'boolean',
                                                                                                               'DateTimeValue': 'timestamp',
                                                                                                               'NumericValue': 'double',
                                                                                                               'StringValue': 'string',
                                                                                                               'Type': {'BOOLEAN_VALUE',
                                                                                                                        'DATETIME_VALUE',
                                                                                                                        'NUMERIC_VALUE',
                                                                                                                        'STRING_VALUE'}}}}}},
                                           'QuestionTypeProperties': {'MultiSelect': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}}}},
                                                                      'Numeric': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}},
                                                                                                 'PropertyValue': {'Label': {'AI_AGENT_MAX_PROMPT_LATENCY',
                                                                                                                             'AI_SESSION_COMPLETENESS_SCORE',
                                                                                                                             'AI_SESSION_FAITHFULNESS_SCORE',
                                                                                                                             'AI_SESSION_GOAL_SUCCESS_RATE',
                                                                                                                             'AI_SESSION_SELF_SERVICE_DURATION',
                                                                                                                             'AI_TOOL_MAX_LATENCY',
                                                                                                                             'AI_TOOL_PARAMETER_ACCURACY',
                                                                                                                             'AI_TOOL_SELECTION_ACCURACY',
                                                                                                                             'AI_TOOL_UTILIZATION_ACCURACY'}}}},
                                                                      'SingleSelect': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}},
                                                                                                      'Options': {'AutomationRule': {'Condition': {'Operands': [{'Condition': (),
                                                                                                                                                                 'Expression': {'Comparator': 'IN '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'NOT_IN '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'ALL_IN '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'EXACT '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'GREATER_THAN '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'LESS_THAN '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'GREATER_THAN_OR_EQUAL_TO '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'LESS_THAN_OR_EQUAL_TO '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'EQUAL_TO '
                                                                                                                                                                                              '| '
                                                                                                                                                                                              'NOT_EQUAL_TO',
                                                                                                                                                                                'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_TOOL_MAX_LATENCY '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_TOOL_SELECTION_ACCURACY '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                                                                                                                             '| '
                                                                                                                                                                                                             'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                                                                                                                           'ContactAttributeKey': 'string',
                                                                                                                                                                                           'ContactField': 'CATEGORIES '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'AGENT_ARN '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'QUEUE_ARN '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'ROUTING_PROFILE_ARN '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'CHANNEL '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'INITIATION_METHOD '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'IS_QUEUED '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'NON_TALK_TIME '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'NON_TALK_TIME_PERCENTAGE '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'NUMBER_OF_INTERRUPTIONS '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'CONTACT_DURATION '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'AGENT_INTERACTION_DURATION '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'CUSTOMER_HOLD_TIME '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'LONGEST_HOLD_DURATION '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'NUMBER_OF_HOLDS '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                                                                                                                           '| '
                                                                                                                                                                                                           'RECORDING_MEDIA_STREAM_TYPES',
                                                                                                                                                                                           'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                                                                                                                           'RefId': 'string',
                                                                                                                                                                                           'SegmentAttributeKey': 'string',
                                                                                                                                                                                           'Type': 'QUESTION_REF_ID '
                                                                                                                                                                                                   '| '
                                                                                                                                                                                                   'CONTACT '
                                                                                                                                                                                                   '| '
                                                                                                                                                                                                   'EVALUATION_METADATA '
                                                                                                                                                                                                   '| '
                                                                                                                                                                                                   'FORM_METADATA '
                                                                                                                                                                                                   '| '
                                                                                                                                                                                                   'AI_METRICS'},
                                                                                                                                                                                'Values': [{'BooleanValue': 'boolean',
                                                                                                                                                                                            'DateTimeValue': 'timestamp',
                                                                                                                                                                                            'NumericValue': 'double',
                                                                                                                                                                                            'RefId': 'string',
                                                                                                                                                                                            'StringValue': 'string',
                                                                                                                                                                                            'Type': 'OPTION_REF_ID '
                                                                                                                                                                                                    '| '
                                                                                                                                                                                                    'STRING_VALUE '
                                                                                                                                                                                                    '| '
                                                                                                                                                                                                    'NUMERIC_VALUE '
                                                                                                                                                                                                    '| '
                                                                                                                                                                                                    'BOOLEAN_VALUE '
                                                                                                                                                                                                    '| '
                                                                                                                                                                                                    'DATETIME_VALUE'}]}}],
                                                                                                                                                   'Operator': 'OR '
                                                                                                                                                               '| '
                                                                                                                                                               'AND'},
                                                                                                                                     'OptionRefId': 'string'}}}},
                                                                      'Text': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}}}}}},
                              'Section': {'Enablement': {'Action': 'DISABLE | '
                                                                   'ENABLE',
                                                         'Condition': {'Operands': [{'Condition': (),
                                                                                     'Expression': {'Comparator': 'IN '
                                                                                                                  '| '
                                                                                                                  'NOT_IN '
                                                                                                                  '| '
                                                                                                                  'ALL_IN '
                                                                                                                  '| '
                                                                                                                  'EXACT '
                                                                                                                  '| '
                                                                                                                  'GREATER_THAN '
                                                                                                                  '| '
                                                                                                                  'LESS_THAN '
                                                                                                                  '| '
                                                                                                                  'GREATER_THAN_OR_EQUAL_TO '
                                                                                                                  '| '
                                                                                                                  'LESS_THAN_OR_EQUAL_TO '
                                                                                                                  '| '
                                                                                                                  'EQUAL_TO '
                                                                                                                  '| '
                                                                                                                  'NOT_EQUAL_TO',
                                                                                                    'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                                                 '| '
                                                                                                                                 'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                                                 '| '
                                                                                                                                 'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_MAX_LATENCY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_SELECTION_ACCURACY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                                                 '| '
                                                                                                                                 'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                                               'ContactAttributeKey': 'string',
                                                                                                               'ContactField': 'CATEGORIES '
                                                                                                                               '| '
                                                                                                                               'AGENT_ARN '
                                                                                                                               '| '
                                                                                                                               'QUEUE_ARN '
                                                                                                                               '| '
                                                                                                                               'ROUTING_PROFILE_ARN '
                                                                                                                               '| '
                                                                                                                               'CHANNEL '
                                                                                                                               '| '
                                                                                                                               'INITIATION_METHOD '
                                                                                                                               '| '
                                                                                                                               'IS_QUEUED '
                                                                                                                               '| '
                                                                                                                               'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                                               '| '
                                                                                                                               'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                                               '| '
                                                                                                                               'NON_TALK_TIME '
                                                                                                                               '| '
                                                                                                                               'NON_TALK_TIME_PERCENTAGE '
                                                                                                                               '| '
                                                                                                                               'NUMBER_OF_INTERRUPTIONS '
                                                                                                                               '| '
                                                                                                                               'CONTACT_DURATION '
                                                                                                                               '| '
                                                                                                                               'AGENT_INTERACTION_DURATION '
                                                                                                                               '| '
                                                                                                                               'CUSTOMER_HOLD_TIME '
                                                                                                                               '| '
                                                                                                                               'LONGEST_HOLD_DURATION '
                                                                                                                               '| '
                                                                                                                               'NUMBER_OF_HOLDS '
                                                                                                                               '| '
                                                                                                                               'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                                               '| '
                                                                                                                               'RECORDING_MEDIA_STREAM_TYPES',
                                                                                                               'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                                               'RefId': 'string',
                                                                                                               'SegmentAttributeKey': 'string',
                                                                                                               'Type': 'QUESTION_REF_ID '
                                                                                                                       '| '
                                                                                                                       'CONTACT '
                                                                                                                       '| '
                                                                                                                       'EVALUATION_METADATA '
                                                                                                                       '| '
                                                                                                                       'FORM_METADATA '
                                                                                                                       '| '
                                                                                                                       'AI_METRICS'},
                                                                                                    'Values': [{'BooleanValue': 'boolean',
                                                                                                                'DateTimeValue': 'timestamp',
                                                                                                                'NumericValue': 'double',
                                                                                                                'RefId': 'string',
                                                                                                                'StringValue': 'string',
                                                                                                                'Type': 'OPTION_REF_ID '
                                                                                                                        '| '
                                                                                                                        'STRING_VALUE '
                                                                                                                        '| '
                                                                                                                        'NUMERIC_VALUE '
                                                                                                                        '| '
                                                                                                                        'BOOLEAN_VALUE '
                                                                                                                        '| '
                                                                                                                        'DATETIME_VALUE'}]}}],
                                                                       'Operator': 'OR '
                                                                                   '| '
                                                                                   'AND'},
                                                         'DefaultAction': 'DISABLE '
                                                                          '| '
                                                                          'ENABLE'}}}}}

Describes an evaluation form in the specified Connect Customer instance. If the version property is not provided, the latest version of the evaluation form is described.

See also: AWS API Documentation

Request Syntax

client.describe_evaluation_form(
    InstanceId='string',
    EvaluationFormId='string',
    EvaluationFormVersion=123
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type EvaluationFormId:

string

param EvaluationFormId:

[REQUIRED]

A unique identifier for the contact evaluation.

type EvaluationFormVersion:

integer

param EvaluationFormVersion:

A version of the evaluation form.

rtype:

dict

returns:

Response Syntax

{
    'EvaluationForm': {
        'EvaluationFormId': 'string',
        'EvaluationFormVersion': 123,
        'Locked': True|False,
        'EvaluationFormArn': 'string',
        'Title': 'string',
        'Description': 'string',
        'Status': 'DRAFT'|'ACTIVE',
        'Items': [
            {
                'Section': {
                    'Title': 'string',
                    'RefId': 'string',
                    'Instructions': 'string',
                    'Items': {'... recursive ...'},
                    'Weight': 123.0,
                    'IsExcludedFromScoring': True|False,
                    'ScoreThresholds': [
                        {
                            'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                            'MinScorePercentage': 123.0,
                            'MaxScorePercentage': 123.0
                        },
                    ],
                    'Enablement': {
                        'Condition': {
                            'Operands': [
                                {
                                    'Expression': {
                                        'Source': {
                                            'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                            'RefId': 'string',
                                            'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                            'ContactAttributeKey': 'string',
                                            'SegmentAttributeKey': 'string',
                                            'EvaluationMetadataField': 'EVALUATION_TYPE',
                                            'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                        },
                                        'Values': [
                                            {
                                                'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                                'RefId': 'string',
                                                'StringValue': 'string',
                                                'NumericValue': 123.0,
                                                'BooleanValue': True|False,
                                                'DateTimeValue': datetime(2015, 1, 1)
                                            },
                                        ],
                                        'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                    },
                                    'Condition': {'... recursive ...'}
                                },
                            ],
                            'Operator': 'OR'|'AND'
                        },
                        'Action': 'DISABLE'|'ENABLE',
                        'DefaultAction': 'DISABLE'|'ENABLE'
                    }
                },
                'Question': {
                    'Title': 'string',
                    'Instructions': 'string',
                    'RefId': 'string',
                    'NotApplicableEnabled': True|False,
                    'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
                    'QuestionTypeProperties': {
                        'Numeric': {
                            'MinValue': 123,
                            'MaxValue': 123,
                            'Options': [
                                {
                                    'MinValue': 123,
                                    'MaxValue': 123,
                                    'Score': 123,
                                    'AutomaticFail': True|False,
                                    'AutomaticFailConfiguration': {
                                        'TargetSection': 'string'
                                    },
                                    'PointsConfiguration': {
                                        'PointValue': 123,
                                        'IsBonus': True|False
                                    }
                                },
                            ],
                            'Automation': {
                                'PropertyValue': {
                                    'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                },
                                'AnswerSource': {
                                    'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                                }
                            }
                        },
                        'SingleSelect': {
                            'Options': [
                                {
                                    'RefId': 'string',
                                    'Text': 'string',
                                    'Score': 123,
                                    'AutomaticFail': True|False,
                                    'AutomaticFailConfiguration': {
                                        'TargetSection': 'string'
                                    },
                                    'PointsConfiguration': {
                                        'PointValue': 123,
                                        'IsBonus': True|False
                                    }
                                },
                            ],
                            'DisplayAs': 'DROPDOWN'|'RADIO',
                            'Automation': {
                                'Options': [
                                    {
                                        'RuleCategory': {
                                            'Category': 'string',
                                            'Condition': 'PRESENT'|'NOT_PRESENT',
                                            'OptionRefId': 'string'
                                        },
                                        'AutomationRule': {
                                            'Condition': {
                                                'Operands': [
                                                    {
                                                        'Expression': {
                                                            'Source': {
                                                                'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                                                'RefId': 'string',
                                                                'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                                                'ContactAttributeKey': 'string',
                                                                'SegmentAttributeKey': 'string',
                                                                'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                                            },
                                                            'Values': [
                                                                {
                                                                    'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                                                    'RefId': 'string',
                                                                    'StringValue': 'string',
                                                                    'NumericValue': 123.0,
                                                                    'BooleanValue': True|False,
                                                                    'DateTimeValue': datetime(2015, 1, 1)
                                                                },
                                                            ],
                                                            'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                                        },
                                                        'Condition': {'... recursive ...'}
                                                    },
                                                ],
                                                'Operator': 'OR'|'AND'
                                            },
                                            'OptionRefId': 'string'
                                        }
                                    },
                                ],
                                'DefaultOptionRefId': 'string',
                                'AnswerSource': {
                                    'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                                }
                            }
                        },
                        'Text': {
                            'Automation': {
                                'AnswerSource': {
                                    'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                                }
                            }
                        },
                        'MultiSelect': {
                            'Options': [
                                {
                                    'RefId': 'string',
                                    'Text': 'string',
                                    'Score': 123,
                                    'AutomaticFail': True|False,
                                    'AutomaticFailConfiguration': {
                                        'TargetSection': 'string'
                                    },
                                    'PointsConfiguration': {
                                        'PointValue': 123,
                                        'IsBonus': True|False
                                    }
                                },
                            ],
                            'DisplayAs': 'DROPDOWN'|'CHECKBOX',
                            'Automation': {
                                'Options': [
                                    {
                                        'RuleCategory': {
                                            'Category': 'string',
                                            'Condition': 'PRESENT'|'NOT_PRESENT',
                                            'OptionRefIds': [
                                                'string',
                                            ]
                                        }
                                    },
                                ],
                                'DefaultOptionRefIds': [
                                    'string',
                                ],
                                'AnswerSource': {
                                    'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                                }
                            }
                        }
                    },
                    'Enablement': {
                        'Condition': {
                            'Operands': [
                                {
                                    'Expression': {
                                        'Source': {
                                            'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                            'RefId': 'string',
                                            'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                            'ContactAttributeKey': 'string',
                                            'SegmentAttributeKey': 'string',
                                            'EvaluationMetadataField': 'EVALUATION_TYPE',
                                            'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                        },
                                        'Values': [
                                            {
                                                'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                                'RefId': 'string',
                                                'StringValue': 'string',
                                                'NumericValue': 123.0,
                                                'BooleanValue': True|False,
                                                'DateTimeValue': datetime(2015, 1, 1)
                                            },
                                        ],
                                        'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                    },
                                    'Condition': {'... recursive ...'}
                                },
                            ],
                            'Operator': 'OR'|'AND'
                        },
                        'Action': 'DISABLE'|'ENABLE',
                        'DefaultAction': 'DISABLE'|'ENABLE'
                    },
                    'Weight': 123.0,
                    'ScoringConfiguration': {
                        'PointsConfiguration': {
                            'MaxPointValue': 123,
                            'MinPointValue': 123,
                            'IsBonus': True|False
                        },
                        'IsExcludedFromScoring': True|False,
                        'ScoreThresholds': [
                            {
                                'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                                'MinScorePercentage': 123.0,
                                'MaxScorePercentage': 123.0
                            },
                        ]
                    },
                    'MetricConfiguration': {
                        'MetricType': 'BUSINESS_OUTCOME',
                        'MetricName': 'string'
                    }
                }
            },
        ],
        'ScoringStrategy': {
            'Mode': 'QUESTION_ONLY'|'SECTION_ONLY'|'POINTS_BASED',
            'Status': 'ENABLED'|'DISABLED',
            'ScoreThresholds': [
                {
                    'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                    'MinScorePercentage': 123.0,
                    'MaxScorePercentage': 123.0
                },
            ]
        },
        'CreatedTime': datetime(2015, 1, 1),
        'CreatedBy': 'string',
        'LastModifiedTime': datetime(2015, 1, 1),
        'LastModifiedBy': 'string',
        'AutoEvaluationConfiguration': {
            'Enabled': True|False
        },
        'ReviewConfiguration': {
            'ReviewNotificationRecipients': [
                {
                    'Type': 'USER_ID',
                    'Value': {
                        'UserId': 'string'
                    }
                },
            ],
            'EligibilityDays': 123
        },
        'Tags': {
            'string': 'string'
        },
        'TargetConfiguration': {
            'ContactInteractionType': 'AGENT'|'AUTOMATED'|'CUSTOMER'
        },
        'LanguageConfiguration': {
            'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'|'ms-MY'|'af-ZA'|'sq-AL'|'am-ET'|'ar-AE'|'ar-SA'|'hy-AM'|'eu-ES'|'be-BY'|'bs-BA'|'bg-BG'|'ca-ES'|'ckb-IR'|'ckb-IQ'|'zh-TW'|'hr-HR'|'cs-CZ'|'da-DK'|'nl-BE'|'nl-NL'|'en-AU'|'en-IN'|'en-IE'|'en-NZ'|'en-AB'|'en-SG'|'en-ZA'|'en-GB'|'en-WL'|'fa-IR'|'fa-AF'|'fi-FI'|'fr-BE'|'fr-CA'|'ga-IE'|'gl-ES'|'ka-GE'|'de-AT'|'de-CH'|'el-GR'|'gu-IN'|'ht-HT'|'he-IL'|'hi-IN'|'hu-HU'|'is-IS'|'id-ID'|'jv-ID'|'km-KH'|'kn-IN'|'kk-KZ'|'lo-LA'|'lv-LV'|'lt-LT'|'mk-MK'|'ml-IN'|'mr-IN'|'ne-NP'|'no-NO'|'or-IN'|'ps-AF'|'pl-PL'|'pt-PT'|'pa-IN'|'ro-RO'|'ru-RU'|'sr-RS'|'si-LK'|'sk-SK'|'sl-SI'|'es-MX'|'es-US'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'sv-SE'|'tl-PH'|'ta-IN'|'te-IN'|'th-TH'|'tr-TR'|'uk-UA'|'uz-UZ'|'vi-VN'|'zu-ZA'|'my-MM'|'so-SO'|'yue-HK'|'et-EE'|'hmn'|'lg-UG'|'cy-GB'|'xh-ZA'|'bn-BD'
        },
        'LatestValidationStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
        'LastValidationTime': datetime(2015, 1, 1),
        'AIVersion': 'string'
    }
}

Response Structure

  • (dict) --

    • EvaluationForm (dict) --

      Information about the evaluation form.

      • EvaluationFormId (string) --

        The unique identifier for the evaluation form.

      • EvaluationFormVersion (integer) --

        A version of the evaluation form.

      • Locked (boolean) --

        The flag indicating whether the evaluation form is locked for changes.

      • EvaluationFormArn (string) --

        The Amazon Resource Name (ARN) for the evaluation form resource.

      • Title (string) --

        A title of the evaluation form.

      • Description (string) --

        The description of the evaluation form.

      • Status (string) --

        The status of the evaluation form.

      • Items (list) --

        Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

        • (dict) --

          Information about an item from an evaluation form. The item must be either a section or a question.

          • Section (dict) --

            The information of the section.

            • Title (string) --

              The title of the section.

            • RefId (string) --

              The identifier of the section. An identifier must be unique within the evaluation form.

            • Instructions (string) --

              The instructions of the section.

            • Items (list) --

              The items of the section.

            • Weight (float) --

              The scoring weight of the section.

            • IsExcludedFromScoring (boolean) --

              The flag to exclude the section from scoring.

            • ScoreThresholds (list) --

              The score thresholds for performance categories.

              • (dict) --

                Information about a score threshold for a performance category.

                • PerformanceCategory (string) --

                  The performance category name.

                • MinScorePercentage (float) --

                  The minimum score percentage for the performance category.

                • MaxScorePercentage (float) --

                  The maximum score percentage for the performance category.

            • Enablement (dict) --

              The conditional enablement configuration of the section. Sections use the same enablement model as questions.

              • Condition (dict) --

                A condition for item enablement configuration.

                • Operands (list) --

                  Operands of the enablement condition.

                  • (dict) --

                    An operand of the enablement condition.

                    • Expression (dict) --

                      An expression of the enablement condition.

                      • Source (dict) --

                        A source item of enablement expression.

                        • Type (string) --

                          A type of source item. Valid values:

                          • QUESTION_REF_ID - The answer to another question in the evaluation form.

                          • CONTACT - Data from the evaluated contact.

                          • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                          • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                        • RefId (string) --

                          A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                        • ContactField (string) --

                          The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                        • ContactAttributeKey (string) --

                          The key of the contact attribute to use as the source. Use when Type is CONTACT.

                        • SegmentAttributeKey (string) --

                          The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                        • EvaluationMetadataField (string) --

                          The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                        • AiMetricsField (string) --

                          The AI metrics field to use as the source. Use when Type is AI_METRICS.

                      • Values (list) --

                        A list of values from source item.

                        • (dict) --

                          An enablement expression source value. Provide only the value member that matches the specified Type.

                          • Type (string) --

                            A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                          • RefId (string) --

                            A referenceId of the source value. Use when Type is OPTION_REF_ID.

                          • StringValue (string) --

                            A string value to compare against the source. Use when Type is STRING_VALUE.

                          • NumericValue (float) --

                            A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                          • BooleanValue (boolean) --

                            A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                          • DateTimeValue (datetime) --

                            A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                      • Comparator (string) --

                        A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

                    • Condition (dict) --

                      A condition for item enablement.

                • Operator (string) --

                  The operator to apply to the operands when more than one operand is provided.

              • Action (string) --

                The enablement action to apply if the condition is satisfied.

              • DefaultAction (string) --

                The enablement action to apply if the condition is not satisfied. This action is also applied when the condition depends on an external source that is still pending or could not be resolved.

          • Question (dict) --

            The information of the question.

            • Title (string) --

              The title of the question.

            • Instructions (string) --

              The instructions of the section.

            • RefId (string) --

              The identifier of the question. An identifier must be unique within the evaluation form.

            • NotApplicableEnabled (boolean) --

              The flag to enable not applicable answers to the question.

            • QuestionType (string) --

              The type of the question.

            • QuestionTypeProperties (dict) --

              The properties of the type of question. Text questions do not have to define question type properties.

              • Numeric (dict) --

                The properties of the numeric question.

                • MinValue (integer) --

                  The minimum answer value.

                • MaxValue (integer) --

                  The maximum answer value.

                • Options (list) --

                  The scoring options of the numeric question.

                  • (dict) --

                    Information about the option range used for scoring in numeric questions.

                    • MinValue (integer) --

                      The minimum answer value of the range option.

                    • MaxValue (integer) --

                      The maximum answer value of the range option.

                    • Score (integer) --

                      The score assigned to answer values within the range option.

                    • AutomaticFail (boolean) --

                      The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                    • AutomaticFailConfiguration (dict) --

                      A configuration for automatic fail.

                      • TargetSection (string) --

                        The referenceId of the target section for auto failure.

                    • PointsConfiguration (dict) --

                      The points configuration for point-based scoring.

                      • PointValue (integer) --

                        The point value assigned to the answer option.

                      • IsBonus (boolean) --

                        The flag to mark the option as a bonus option.

                • Automation (dict) --

                  The automation properties of the numeric question.

                  • PropertyValue (dict) --

                    The property value of the automation.

                    • Label (string) --

                      The property label of the automation.

                  • AnswerSource (dict) --

                    A source of automation answer for numeric question.

                    • SourceType (string) --

                      The automation answer source type. Valid values:

                      • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                      • GEN_AI - The answer is generated by generative AI.

                      • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

              • SingleSelect (dict) --

                The properties of the numeric question.

                • Options (list) --

                  The answer options of the single select question.

                  • (dict) --

                    Information about the automation configuration in single select questions.

                    • RefId (string) --

                      The identifier of the answer option. An identifier must be unique within the question.

                    • Text (string) --

                      The title of the answer option.

                    • Score (integer) --

                      The score assigned to the answer option.

                    • AutomaticFail (boolean) --

                      The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                    • AutomaticFailConfiguration (dict) --

                      Whether automatic fail is configured on a single select question.

                      • TargetSection (string) --

                        The referenceId of the target section for auto failure.

                    • PointsConfiguration (dict) --

                      The points configuration for point-based scoring.

                      • PointValue (integer) --

                        The point value assigned to the answer option.

                      • IsBonus (boolean) --

                        The flag to mark the option as a bonus option.

                • DisplayAs (string) --

                  The display mode of the single select question.

                • Automation (dict) --

                  The display mode of the single select question.

                  • Options (list) --

                    The automation options of the single select question.

                    • (dict) --

                      Information about the automation option of a single select question.

                      • RuleCategory (dict) --

                        The automation option based on a rule category for the single select question.

                        • Category (string) --

                          The category name, as defined in Rules. This is equivalent to a conversational analytics rule with the same name: the automation option is applied based on whether that rule matched the contact. For more information about creating rules, see Create rules in the Connect Customer Administrator Guide.

                        • Condition (string) --

                          The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

                        • OptionRefId (string) --

                          The identifier of the answer option.

                      • AutomationRule (dict) --

                        The automation option based on a condition for the single select question. Use with the CONDITION answer source type.

                        • Condition (dict) --

                          The condition that must be satisfied for the answer option to be selected. The condition uses the same sources, comparators, and operators as item enablement conditions.

                          • Operands (list) --

                            Operands of the enablement condition.

                            • (dict) --

                              An operand of the enablement condition.

                              • Expression (dict) --

                                An expression of the enablement condition.

                                • Source (dict) --

                                  A source item of enablement expression.

                                  • Type (string) --

                                    A type of source item. Valid values:

                                    • QUESTION_REF_ID - The answer to another question in the evaluation form.

                                    • CONTACT - Data from the evaluated contact.

                                    • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                                    • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                                  • RefId (string) --

                                    A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                                  • ContactField (string) --

                                    The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                                  • ContactAttributeKey (string) --

                                    The key of the contact attribute to use as the source. Use when Type is CONTACT.

                                  • SegmentAttributeKey (string) --

                                    The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                                  • EvaluationMetadataField (string) --

                                    The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                                  • AiMetricsField (string) --

                                    The AI metrics field to use as the source. Use when Type is AI_METRICS.

                                • Values (list) --

                                  A list of values from source item.

                                  • (dict) --

                                    An enablement expression source value. Provide only the value member that matches the specified Type.

                                    • Type (string) --

                                      A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                                    • RefId (string) --

                                      A referenceId of the source value. Use when Type is OPTION_REF_ID.

                                    • StringValue (string) --

                                      A string value to compare against the source. Use when Type is STRING_VALUE.

                                    • NumericValue (float) --

                                      A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                                    • BooleanValue (boolean) --

                                      A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                                    • DateTimeValue (datetime) --

                                      A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                                • Comparator (string) --

                                  A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

                              • Condition (dict) --

                                A condition for item enablement.

                          • Operator (string) --

                            The operator to apply to the operands when more than one operand is provided.

                        • OptionRefId (string) --

                          The identifier of the answer option to select when the condition is satisfied.

                  • DefaultOptionRefId (string) --

                    The identifier of the default answer option, when none of the automation options match the criteria.

                  • AnswerSource (dict) --

                    Automation answer source.

                    • SourceType (string) --

                      The automation answer source type. Valid values:

                      • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                      • GEN_AI - The answer is generated by generative AI.

                      • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

              • Text (dict) --

                The properties of the text question.

                • Automation (dict) --

                  The automation properties of the text question.

                  • AnswerSource (dict) --

                    Automation answer source.

                    • SourceType (string) --

                      The automation answer source type. Valid values:

                      • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                      • GEN_AI - The answer is generated by generative AI.

                      • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

              • MultiSelect (dict) --

                Properties for multi-select question types.

                • Options (list) --

                  Options available for this multi-select question.

                  • (dict) --

                    An option for a multi-select question in an evaluation form.

                    • RefId (string) --

                      Reference identifier for this option.

                    • Text (string) --

                      Display text for this option.

                    • Score (integer) --

                      The score assigned to the answer option.

                    • AutomaticFail (boolean) --

                      The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

                    • AutomaticFailConfiguration (dict) --

                      Information about automatic fail configuration for an evaluation form.

                      • TargetSection (string) --

                        The referenceId of the target section for auto failure.

                    • PointsConfiguration (dict) --

                      The points configuration for point-based scoring.

                      • PointValue (integer) --

                        The point value assigned to the answer option.

                      • IsBonus (boolean) --

                        The flag to mark the option as a bonus option.

                • DisplayAs (string) --

                  Display format for the multi-select question.

                • Automation (dict) --

                  Automation configuration for this multi-select question.

                  • Options (list) --

                    Automation options for the multi-select question.

                    • (dict) --

                      An automation option for a multi-select question.

                      • RuleCategory (dict) --

                        Rule category configuration for this automation option.

                        • Category (string) --

                          The category name for this automation rule.

                        • Condition (string) --

                          The condition for this automation rule.

                        • OptionRefIds (list) --

                          Reference IDs of options for this automation rule.

                          • (string) --

                  • DefaultOptionRefIds (list) --

                    Reference IDs of default options.

                    • (string) --

                  • AnswerSource (dict) --

                    Automation answer source.

                    • SourceType (string) --

                      The automation answer source type. Valid values:

                      • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                      • GEN_AI - The answer is generated by generative AI.

                      • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

            • Enablement (dict) --

              A question conditional enablement.

              • Condition (dict) --

                A condition for item enablement configuration.

                • Operands (list) --

                  Operands of the enablement condition.

                  • (dict) --

                    An operand of the enablement condition.

                    • Expression (dict) --

                      An expression of the enablement condition.

                      • Source (dict) --

                        A source item of enablement expression.

                        • Type (string) --

                          A type of source item. Valid values:

                          • QUESTION_REF_ID - The answer to another question in the evaluation form.

                          • CONTACT - Data from the evaluated contact.

                          • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                          • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                        • RefId (string) --

                          A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                        • ContactField (string) --

                          The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                        • ContactAttributeKey (string) --

                          The key of the contact attribute to use as the source. Use when Type is CONTACT.

                        • SegmentAttributeKey (string) --

                          The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                        • EvaluationMetadataField (string) --

                          The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                        • AiMetricsField (string) --

                          The AI metrics field to use as the source. Use when Type is AI_METRICS.

                      • Values (list) --

                        A list of values from source item.

                        • (dict) --

                          An enablement expression source value. Provide only the value member that matches the specified Type.

                          • Type (string) --

                            A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                          • RefId (string) --

                            A referenceId of the source value. Use when Type is OPTION_REF_ID.

                          • StringValue (string) --

                            A string value to compare against the source. Use when Type is STRING_VALUE.

                          • NumericValue (float) --

                            A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                          • BooleanValue (boolean) --

                            A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                          • DateTimeValue (datetime) --

                            A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                      • Comparator (string) --

                        A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

                    • Condition (dict) --

                      A condition for item enablement.

                • Operator (string) --

                  The operator to apply to the operands when more than one operand is provided.

              • Action (string) --

                The enablement action to apply if the condition is satisfied.

              • DefaultAction (string) --

                The enablement action to apply if the condition is not satisfied. This action is also applied when the condition depends on an external source that is still pending or could not be resolved.

            • Weight (float) --

              The scoring weight of the section.

            • ScoringConfiguration (dict) --

              The scoring configuration of the question.

              • PointsConfiguration (dict) --

                The points configuration for point-based scoring.

                • MaxPointValue (integer) --

                  The maximum point value.

                • MinPointValue (integer) --

                  The minimum point value.

                • IsBonus (boolean) --

                  The flag to mark the question as a bonus question.

              • IsExcludedFromScoring (boolean) --

                The flag to exclude the question from scoring.

              • ScoreThresholds (list) --

                The score thresholds for performance categories.

                • (dict) --

                  Information about a score threshold for a performance category.

                  • PerformanceCategory (string) --

                    The performance category name.

                  • MinScorePercentage (float) --

                    The minimum score percentage for the performance category.

                  • MaxScorePercentage (float) --

                    The maximum score percentage for the performance category.

            • MetricConfiguration (dict) --

              The metric configuration for the question. Use this to associate a business outcome metric with the question.

              • MetricType (string) --

                The type of metric. Currently, only BUSINESS_OUTCOME is supported.

              • MetricName (string) --

                The name of the metric. Valid values are:

                • SALE_SUCCESS – Sale success.

                • CSAT – Customer satisfaction.

                • CHURN_PROPENSITY – Churn propensity.

                • SELF_SERVICE_SUCCESS – Self-service success.

                • PARTIAL_SELF_SERVICE_SUCCESS – Partial self-service success.

      • ScoringStrategy (dict) --

        A scoring strategy of the evaluation form.

        • Mode (string) --

          The scoring mode of the evaluation form.

        • Status (string) --

          The scoring status of the evaluation form.

        • ScoreThresholds (list) --

          The score thresholds for performance categories.

          • (dict) --

            Information about a score threshold for a performance category.

            • PerformanceCategory (string) --

              The performance category name.

            • MinScorePercentage (float) --

              The minimum score percentage for the performance category.

            • MaxScorePercentage (float) --

              The maximum score percentage for the performance category.

      • CreatedTime (datetime) --

        The timestamp for when the evaluation form was created.

      • CreatedBy (string) --

        The Amazon Resource Name (ARN) of the user who created the evaluation form.

      • LastModifiedTime (datetime) --

        The timestamp for when the evaluation form was last updated.

      • LastModifiedBy (string) --

        The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

      • AutoEvaluationConfiguration (dict) --

        The automatic evaluation configuration of an evaluation form.

        • Enabled (boolean) --

          When automated evaluation is enabled.

      • ReviewConfiguration (dict) --

        Configuration for evaluation review settings of this evaluation form.

        • ReviewNotificationRecipients (list) --

          List of recipients who should be notified when a review is requested.

          • (dict) --

            Information about a recipient who should be notified when an evaluation review is requested.

            • Type (string) --

              The type of notification recipient.

            • Value (dict) --

              The value associated with the notification recipient type.

              • UserId (string) --

                The user identifier for the notification recipient.

        • EligibilityDays (integer) --

          Number of days during which a request for review can be submitted for evaluations created from this form.

      • Tags (dict) --

        The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

        • (string) --

          • (string) --

      • TargetConfiguration (dict) --

        Configuration that specifies the target for this evaluation form.

        • ContactInteractionType (string) --

          The contact interaction type for this evaluation form.

      • LanguageConfiguration (dict) --

        Configuration for language settings of this evaluation form.

        • FormLanguage (string) --

          The language for the evaluation form.

      • LatestValidationStatus (string) --

        The status of the most recent validation run for this evaluation form. Valid values: IN_PROGRESS, COMPLETED, FAILED.

      • LastValidationTime (datetime) --

        The timestamp when the most recent validation was started for this evaluation form.

      • AIVersion (string) --

        The AI version to use for the evaluation form. This specifies which AI model version is used for automated evaluations.

UpdateEvaluationForm (updated) Link ¶
Changes (request)
{'Items': {'Question': {'Enablement': {'Condition': {'Operands': {'Expression': {'Comparator': {'EQUAL_TO',
                                                                                                'GREATER_THAN',
                                                                                                'GREATER_THAN_OR_EQUAL_TO',
                                                                                                'LESS_THAN',
                                                                                                'LESS_THAN_OR_EQUAL_TO',
                                                                                                'NOT_EQUAL_TO'},
                                                                                 'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                              '| '
                                                                                                              'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                              '| '
                                                                                                              'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                              '| '
                                                                                                              'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                              '| '
                                                                                                              'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                              '| '
                                                                                                              'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_MAX_LATENCY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_SELECTION_ACCURACY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                            'ContactAttributeKey': 'string',
                                                                                            'ContactField': 'CATEGORIES '
                                                                                                            '| '
                                                                                                            'AGENT_ARN '
                                                                                                            '| '
                                                                                                            'QUEUE_ARN '
                                                                                                            '| '
                                                                                                            'ROUTING_PROFILE_ARN '
                                                                                                            '| '
                                                                                                            'CHANNEL '
                                                                                                            '| '
                                                                                                            'INITIATION_METHOD '
                                                                                                            '| '
                                                                                                            'IS_QUEUED '
                                                                                                            '| '
                                                                                                            'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                            '| '
                                                                                                            'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                            '| '
                                                                                                            'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                            '| '
                                                                                                            'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                            '| '
                                                                                                            'NON_TALK_TIME '
                                                                                                            '| '
                                                                                                            'NON_TALK_TIME_PERCENTAGE '
                                                                                                            '| '
                                                                                                            'NUMBER_OF_INTERRUPTIONS '
                                                                                                            '| '
                                                                                                            'CONTACT_DURATION '
                                                                                                            '| '
                                                                                                            'AGENT_INTERACTION_DURATION '
                                                                                                            '| '
                                                                                                            'CUSTOMER_HOLD_TIME '
                                                                                                            '| '
                                                                                                            'LONGEST_HOLD_DURATION '
                                                                                                            '| '
                                                                                                            'NUMBER_OF_HOLDS '
                                                                                                            '| '
                                                                                                            'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                            '| '
                                                                                                            'RECORDING_MEDIA_STREAM_TYPES',
                                                                                            'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                            'SegmentAttributeKey': 'string',
                                                                                            'Type': {'AI_METRICS',
                                                                                                     'CONTACT',
                                                                                                     'EVALUATION_METADATA',
                                                                                                     'FORM_METADATA'}},
                                                                                 'Values': {'BooleanValue': 'boolean',
                                                                                            'DateTimeValue': 'timestamp',
                                                                                            'NumericValue': 'double',
                                                                                            'StringValue': 'string',
                                                                                            'Type': {'BOOLEAN_VALUE',
                                                                                                     'DATETIME_VALUE',
                                                                                                     'NUMERIC_VALUE',
                                                                                                     'STRING_VALUE'}}}}}},
                        'QuestionTypeProperties': {'MultiSelect': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}}}},
                                                   'Numeric': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}},
                                                                              'PropertyValue': {'Label': {'AI_AGENT_MAX_PROMPT_LATENCY',
                                                                                                          'AI_SESSION_COMPLETENESS_SCORE',
                                                                                                          'AI_SESSION_FAITHFULNESS_SCORE',
                                                                                                          'AI_SESSION_GOAL_SUCCESS_RATE',
                                                                                                          'AI_SESSION_SELF_SERVICE_DURATION',
                                                                                                          'AI_TOOL_MAX_LATENCY',
                                                                                                          'AI_TOOL_PARAMETER_ACCURACY',
                                                                                                          'AI_TOOL_SELECTION_ACCURACY',
                                                                                                          'AI_TOOL_UTILIZATION_ACCURACY'}}}},
                                                   'SingleSelect': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}},
                                                                                   'Options': {'AutomationRule': {'Condition': {'Operands': [{'Condition': (),
                                                                                                                                              'Expression': {'Comparator': 'IN '
                                                                                                                                                                           '| '
                                                                                                                                                                           'NOT_IN '
                                                                                                                                                                           '| '
                                                                                                                                                                           'ALL_IN '
                                                                                                                                                                           '| '
                                                                                                                                                                           'EXACT '
                                                                                                                                                                           '| '
                                                                                                                                                                           'GREATER_THAN '
                                                                                                                                                                           '| '
                                                                                                                                                                           'LESS_THAN '
                                                                                                                                                                           '| '
                                                                                                                                                                           'GREATER_THAN_OR_EQUAL_TO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'LESS_THAN_OR_EQUAL_TO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'EQUAL_TO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'NOT_EQUAL_TO',
                                                                                                                                                             'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_TOOL_MAX_LATENCY '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_TOOL_SELECTION_ACCURACY '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                                                                                                          '| '
                                                                                                                                                                                          'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                                                                                                        'ContactAttributeKey': 'string',
                                                                                                                                                                        'ContactField': 'CATEGORIES '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'AGENT_ARN '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'QUEUE_ARN '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'ROUTING_PROFILE_ARN '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'CHANNEL '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'INITIATION_METHOD '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'IS_QUEUED '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'NON_TALK_TIME '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'NON_TALK_TIME_PERCENTAGE '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'NUMBER_OF_INTERRUPTIONS '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'CONTACT_DURATION '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'AGENT_INTERACTION_DURATION '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'CUSTOMER_HOLD_TIME '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'LONGEST_HOLD_DURATION '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'NUMBER_OF_HOLDS '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                                                                                                        '| '
                                                                                                                                                                                        'RECORDING_MEDIA_STREAM_TYPES',
                                                                                                                                                                        'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                                                                                                        'RefId': 'string',
                                                                                                                                                                        'SegmentAttributeKey': 'string',
                                                                                                                                                                        'Type': 'QUESTION_REF_ID '
                                                                                                                                                                                '| '
                                                                                                                                                                                'CONTACT '
                                                                                                                                                                                '| '
                                                                                                                                                                                'EVALUATION_METADATA '
                                                                                                                                                                                '| '
                                                                                                                                                                                'FORM_METADATA '
                                                                                                                                                                                '| '
                                                                                                                                                                                'AI_METRICS'},
                                                                                                                                                             'Values': [{'BooleanValue': 'boolean',
                                                                                                                                                                         'DateTimeValue': 'timestamp',
                                                                                                                                                                         'NumericValue': 'double',
                                                                                                                                                                         'RefId': 'string',
                                                                                                                                                                         'StringValue': 'string',
                                                                                                                                                                         'Type': 'OPTION_REF_ID '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'STRING_VALUE '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'NUMERIC_VALUE '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'BOOLEAN_VALUE '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'DATETIME_VALUE'}]}}],
                                                                                                                                'Operator': 'OR '
                                                                                                                                            '| '
                                                                                                                                            'AND'},
                                                                                                                  'OptionRefId': 'string'}}}},
                                                   'Text': {'Automation': {'AnswerSource': {'SourceType': {'CONDITION'}}}}}},
           'Section': {'Enablement': {'Action': 'DISABLE | ENABLE',
                                      'Condition': {'Operands': [{'Condition': (),
                                                                  'Expression': {'Comparator': 'IN '
                                                                                               '| '
                                                                                               'NOT_IN '
                                                                                               '| '
                                                                                               'ALL_IN '
                                                                                               '| '
                                                                                               'EXACT '
                                                                                               '| '
                                                                                               'GREATER_THAN '
                                                                                               '| '
                                                                                               'LESS_THAN '
                                                                                               '| '
                                                                                               'GREATER_THAN_OR_EQUAL_TO '
                                                                                               '| '
                                                                                               'LESS_THAN_OR_EQUAL_TO '
                                                                                               '| '
                                                                                               'EQUAL_TO '
                                                                                               '| '
                                                                                               'NOT_EQUAL_TO',
                                                                                 'Source': {'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF '
                                                                                                              '| '
                                                                                                              'AI_SESSION_SELF_SERVICE_DURATION '
                                                                                                              '| '
                                                                                                              'AI_SESSION_GOAL_SUCCESS_RATE '
                                                                                                              '| '
                                                                                                              'AI_SESSION_COMPLETENESS_SCORE '
                                                                                                              '| '
                                                                                                              'AI_SESSION_FAITHFULNESS_SCORE '
                                                                                                              '| '
                                                                                                              'AI_AGENT_MAX_PROMPT_LATENCY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_MAX_LATENCY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_SELECTION_ACCURACY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_PARAMETER_ACCURACY '
                                                                                                              '| '
                                                                                                              'AI_TOOL_UTILIZATION_ACCURACY',
                                                                                            'ContactAttributeKey': 'string',
                                                                                            'ContactField': 'CATEGORIES '
                                                                                                            '| '
                                                                                                            'AGENT_ARN '
                                                                                                            '| '
                                                                                                            'QUEUE_ARN '
                                                                                                            '| '
                                                                                                            'ROUTING_PROFILE_ARN '
                                                                                                            '| '
                                                                                                            'CHANNEL '
                                                                                                            '| '
                                                                                                            'INITIATION_METHOD '
                                                                                                            '| '
                                                                                                            'IS_QUEUED '
                                                                                                            '| '
                                                                                                            'OVERALL_CUSTOMER_SENTIMENT_SCORE '
                                                                                                            '| '
                                                                                                            'OVERALL_AGENT_SENTIMENT_SCORE '
                                                                                                            '| '
                                                                                                            'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT '
                                                                                                            '| '
                                                                                                            'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT '
                                                                                                            '| '
                                                                                                            'NON_TALK_TIME '
                                                                                                            '| '
                                                                                                            'NON_TALK_TIME_PERCENTAGE '
                                                                                                            '| '
                                                                                                            'NUMBER_OF_INTERRUPTIONS '
                                                                                                            '| '
                                                                                                            'CONTACT_DURATION '
                                                                                                            '| '
                                                                                                            'AGENT_INTERACTION_DURATION '
                                                                                                            '| '
                                                                                                            'CUSTOMER_HOLD_TIME '
                                                                                                            '| '
                                                                                                            'LONGEST_HOLD_DURATION '
                                                                                                            '| '
                                                                                                            'NUMBER_OF_HOLDS '
                                                                                                            '| '
                                                                                                            'AGENT_INTERACTION_AND_HOLD_DURATION '
                                                                                                            '| '
                                                                                                            'RECORDING_MEDIA_STREAM_TYPES',
                                                                                            'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                                                            'RefId': 'string',
                                                                                            'SegmentAttributeKey': 'string',
                                                                                            'Type': 'QUESTION_REF_ID '
                                                                                                    '| '
                                                                                                    'CONTACT '
                                                                                                    '| '
                                                                                                    'EVALUATION_METADATA '
                                                                                                    '| '
                                                                                                    'FORM_METADATA '
                                                                                                    '| '
                                                                                                    'AI_METRICS'},
                                                                                 'Values': [{'BooleanValue': 'boolean',
                                                                                             'DateTimeValue': 'timestamp',
                                                                                             'NumericValue': 'double',
                                                                                             'RefId': 'string',
                                                                                             'StringValue': 'string',
                                                                                             'Type': 'OPTION_REF_ID '
                                                                                                     '| '
                                                                                                     'STRING_VALUE '
                                                                                                     '| '
                                                                                                     'NUMERIC_VALUE '
                                                                                                     '| '
                                                                                                     'BOOLEAN_VALUE '
                                                                                                     '| '
                                                                                                     'DATETIME_VALUE'}]}}],
                                                    'Operator': 'OR | AND'},
                                      'DefaultAction': 'DISABLE | ENABLE'}}}}

Updates details about a specific evaluation form version in the specified Connect Customer instance. Question and section identifiers cannot be duplicated within the same evaluation form.

This operation does not support partial updates. Instead it does a full update of evaluation form content.

See also: AWS API Documentation

Request Syntax

client.update_evaluation_form(
    InstanceId='string',
    EvaluationFormId='string',
    EvaluationFormVersion=123,
    CreateNewVersion=True|False,
    Title='string',
    Description='string',
    Items=[
        {
            'Section': {
                'Title': 'string',
                'RefId': 'string',
                'Instructions': 'string',
                'Items': {'... recursive ...'},
                'Weight': 123.0,
                'IsExcludedFromScoring': True|False,
                'ScoreThresholds': [
                    {
                        'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                        'MinScorePercentage': 123.0,
                        'MaxScorePercentage': 123.0
                    },
                ],
                'Enablement': {
                    'Condition': {
                        'Operands': [
                            {
                                'Expression': {
                                    'Source': {
                                        'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                        'RefId': 'string',
                                        'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                        'ContactAttributeKey': 'string',
                                        'SegmentAttributeKey': 'string',
                                        'EvaluationMetadataField': 'EVALUATION_TYPE',
                                        'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                    },
                                    'Values': [
                                        {
                                            'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                            'RefId': 'string',
                                            'StringValue': 'string',
                                            'NumericValue': 123.0,
                                            'BooleanValue': True|False,
                                            'DateTimeValue': datetime(2015, 1, 1)
                                        },
                                    ],
                                    'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                },
                                'Condition': {'... recursive ...'}
                            },
                        ],
                        'Operator': 'OR'|'AND'
                    },
                    'Action': 'DISABLE'|'ENABLE',
                    'DefaultAction': 'DISABLE'|'ENABLE'
                }
            },
            'Question': {
                'Title': 'string',
                'Instructions': 'string',
                'RefId': 'string',
                'NotApplicableEnabled': True|False,
                'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
                'QuestionTypeProperties': {
                    'Numeric': {
                        'MinValue': 123,
                        'MaxValue': 123,
                        'Options': [
                            {
                                'MinValue': 123,
                                'MaxValue': 123,
                                'Score': 123,
                                'AutomaticFail': True|False,
                                'AutomaticFailConfiguration': {
                                    'TargetSection': 'string'
                                },
                                'PointsConfiguration': {
                                    'PointValue': 123,
                                    'IsBonus': True|False
                                }
                            },
                        ],
                        'Automation': {
                            'PropertyValue': {
                                'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                            },
                            'AnswerSource': {
                                'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                            }
                        }
                    },
                    'SingleSelect': {
                        'Options': [
                            {
                                'RefId': 'string',
                                'Text': 'string',
                                'Score': 123,
                                'AutomaticFail': True|False,
                                'AutomaticFailConfiguration': {
                                    'TargetSection': 'string'
                                },
                                'PointsConfiguration': {
                                    'PointValue': 123,
                                    'IsBonus': True|False
                                }
                            },
                        ],
                        'DisplayAs': 'DROPDOWN'|'RADIO',
                        'Automation': {
                            'Options': [
                                {
                                    'RuleCategory': {
                                        'Category': 'string',
                                        'Condition': 'PRESENT'|'NOT_PRESENT',
                                        'OptionRefId': 'string'
                                    },
                                    'AutomationRule': {
                                        'Condition': {
                                            'Operands': [
                                                {
                                                    'Expression': {
                                                        'Source': {
                                                            'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                                            'RefId': 'string',
                                                            'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                                            'ContactAttributeKey': 'string',
                                                            'SegmentAttributeKey': 'string',
                                                            'EvaluationMetadataField': 'EVALUATION_TYPE',
                                                            'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                                        },
                                                        'Values': [
                                                            {
                                                                'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                                                'RefId': 'string',
                                                                'StringValue': 'string',
                                                                'NumericValue': 123.0,
                                                                'BooleanValue': True|False,
                                                                'DateTimeValue': datetime(2015, 1, 1)
                                                            },
                                                        ],
                                                        'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                                    },
                                                    'Condition': {'... recursive ...'}
                                                },
                                            ],
                                            'Operator': 'OR'|'AND'
                                        },
                                        'OptionRefId': 'string'
                                    }
                                },
                            ],
                            'DefaultOptionRefId': 'string',
                            'AnswerSource': {
                                'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                            }
                        }
                    },
                    'Text': {
                        'Automation': {
                            'AnswerSource': {
                                'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                            }
                        }
                    },
                    'MultiSelect': {
                        'Options': [
                            {
                                'RefId': 'string',
                                'Text': 'string',
                                'Score': 123,
                                'AutomaticFail': True|False,
                                'AutomaticFailConfiguration': {
                                    'TargetSection': 'string'
                                },
                                'PointsConfiguration': {
                                    'PointValue': 123,
                                    'IsBonus': True|False
                                }
                            },
                        ],
                        'DisplayAs': 'DROPDOWN'|'CHECKBOX',
                        'Automation': {
                            'Options': [
                                {
                                    'RuleCategory': {
                                        'Category': 'string',
                                        'Condition': 'PRESENT'|'NOT_PRESENT',
                                        'OptionRefIds': [
                                            'string',
                                        ]
                                    }
                                },
                            ],
                            'DefaultOptionRefIds': [
                                'string',
                            ],
                            'AnswerSource': {
                                'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'|'CONDITION'
                            }
                        }
                    }
                },
                'Enablement': {
                    'Condition': {
                        'Operands': [
                            {
                                'Expression': {
                                    'Source': {
                                        'Type': 'QUESTION_REF_ID'|'CONTACT'|'EVALUATION_METADATA'|'FORM_METADATA'|'AI_METRICS',
                                        'RefId': 'string',
                                        'ContactField': 'CATEGORIES'|'AGENT_ARN'|'QUEUE_ARN'|'ROUTING_PROFILE_ARN'|'CHANNEL'|'INITIATION_METHOD'|'IS_QUEUED'|'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'|'RECORDING_MEDIA_STREAM_TYPES',
                                        'ContactAttributeKey': 'string',
                                        'SegmentAttributeKey': 'string',
                                        'EvaluationMetadataField': 'EVALUATION_TYPE',
                                        'AiMetricsField': 'AI_SESSION_IS_HANDED_OFF'|'AI_SESSION_SELF_SERVICE_DURATION'|'AI_SESSION_GOAL_SUCCESS_RATE'|'AI_SESSION_COMPLETENESS_SCORE'|'AI_SESSION_FAITHFULNESS_SCORE'|'AI_AGENT_MAX_PROMPT_LATENCY'|'AI_TOOL_MAX_LATENCY'|'AI_TOOL_SELECTION_ACCURACY'|'AI_TOOL_PARAMETER_ACCURACY'|'AI_TOOL_UTILIZATION_ACCURACY'
                                    },
                                    'Values': [
                                        {
                                            'Type': 'OPTION_REF_ID'|'STRING_VALUE'|'NUMERIC_VALUE'|'BOOLEAN_VALUE'|'DATETIME_VALUE',
                                            'RefId': 'string',
                                            'StringValue': 'string',
                                            'NumericValue': 123.0,
                                            'BooleanValue': True|False,
                                            'DateTimeValue': datetime(2015, 1, 1)
                                        },
                                    ],
                                    'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'|'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'NOT_EQUAL_TO'
                                },
                                'Condition': {'... recursive ...'}
                            },
                        ],
                        'Operator': 'OR'|'AND'
                    },
                    'Action': 'DISABLE'|'ENABLE',
                    'DefaultAction': 'DISABLE'|'ENABLE'
                },
                'Weight': 123.0,
                'ScoringConfiguration': {
                    'PointsConfiguration': {
                        'MaxPointValue': 123,
                        'MinPointValue': 123,
                        'IsBonus': True|False
                    },
                    'IsExcludedFromScoring': True|False,
                    'ScoreThresholds': [
                        {
                            'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                            'MinScorePercentage': 123.0,
                            'MaxScorePercentage': 123.0
                        },
                    ]
                },
                'MetricConfiguration': {
                    'MetricType': 'BUSINESS_OUTCOME',
                    'MetricName': 'string'
                }
            }
        },
    ],
    ScoringStrategy={
        'Mode': 'QUESTION_ONLY'|'SECTION_ONLY'|'POINTS_BASED',
        'Status': 'ENABLED'|'DISABLED',
        'ScoreThresholds': [
            {
                'PerformanceCategory': 'NEEDS_IMPROVEMENT'|'EXCEEDS_EXPECTATIONS',
                'MinScorePercentage': 123.0,
                'MaxScorePercentage': 123.0
            },
        ]
    },
    AutoEvaluationConfiguration={
        'Enabled': True|False
    },
    ReviewConfiguration={
        'ReviewNotificationRecipients': [
            {
                'Type': 'USER_ID',
                'Value': {
                    'UserId': 'string'
                }
            },
        ],
        'EligibilityDays': 123
    },
    AsDraft=True|False,
    ClientToken='string',
    TargetConfiguration={
        'ContactInteractionType': 'AGENT'|'AUTOMATED'|'CUSTOMER'
    },
    LanguageConfiguration={
        'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'|'ja-JP'|'ko-KR'|'zh-CN'|'ms-MY'|'af-ZA'|'sq-AL'|'am-ET'|'ar-AE'|'ar-SA'|'hy-AM'|'eu-ES'|'be-BY'|'bs-BA'|'bg-BG'|'ca-ES'|'ckb-IR'|'ckb-IQ'|'zh-TW'|'hr-HR'|'cs-CZ'|'da-DK'|'nl-BE'|'nl-NL'|'en-AU'|'en-IN'|'en-IE'|'en-NZ'|'en-AB'|'en-SG'|'en-ZA'|'en-GB'|'en-WL'|'fa-IR'|'fa-AF'|'fi-FI'|'fr-BE'|'fr-CA'|'ga-IE'|'gl-ES'|'ka-GE'|'de-AT'|'de-CH'|'el-GR'|'gu-IN'|'ht-HT'|'he-IL'|'hi-IN'|'hu-HU'|'is-IS'|'id-ID'|'jv-ID'|'km-KH'|'kn-IN'|'kk-KZ'|'lo-LA'|'lv-LV'|'lt-LT'|'mk-MK'|'ml-IN'|'mr-IN'|'ne-NP'|'no-NO'|'or-IN'|'ps-AF'|'pl-PL'|'pt-PT'|'pa-IN'|'ro-RO'|'ru-RU'|'sr-RS'|'si-LK'|'sk-SK'|'sl-SI'|'es-MX'|'es-US'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'sv-SE'|'tl-PH'|'ta-IN'|'te-IN'|'th-TH'|'tr-TR'|'uk-UA'|'uz-UZ'|'vi-VN'|'zu-ZA'|'my-MM'|'so-SO'|'yue-HK'|'et-EE'|'hmn'|'lg-UG'|'cy-GB'|'xh-ZA'|'bn-BD'
    },
    AIVersion='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type EvaluationFormId:

string

param EvaluationFormId:

[REQUIRED]

The unique identifier for the evaluation form.

type EvaluationFormVersion:

integer

param EvaluationFormVersion:

[REQUIRED]

A version of the evaluation form to update.

type CreateNewVersion:

boolean

param CreateNewVersion:

A flag indicating whether the operation must create a new version.

type Title:

string

param Title:

[REQUIRED]

A title of the evaluation form.

type Description:

string

param Description:

The description of the evaluation form.

type Items:

list

param Items:

[REQUIRED]

Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

  • (dict) --

    Information about an item from an evaluation form. The item must be either a section or a question.

    • Section (dict) --

      The information of the section.

      • Title (string) -- [REQUIRED]

        The title of the section.

      • RefId (string) -- [REQUIRED]

        The identifier of the section. An identifier must be unique within the evaluation form.

      • Instructions (string) --

        The instructions of the section.

      • Items (list) --

        The items of the section.

      • Weight (float) --

        The scoring weight of the section.

      • IsExcludedFromScoring (boolean) --

        The flag to exclude the section from scoring.

      • ScoreThresholds (list) --

        The score thresholds for performance categories.

        • (dict) --

          Information about a score threshold for a performance category.

          • PerformanceCategory (string) -- [REQUIRED]

            The performance category name.

          • MinScorePercentage (float) --

            The minimum score percentage for the performance category.

          • MaxScorePercentage (float) --

            The maximum score percentage for the performance category.

      • Enablement (dict) --

        The conditional enablement configuration of the section. Sections use the same enablement model as questions.

        • Condition (dict) -- [REQUIRED]

          A condition for item enablement configuration.

          • Operands (list) -- [REQUIRED]

            Operands of the enablement condition.

            • (dict) --

              An operand of the enablement condition.

              • Expression (dict) --

                An expression of the enablement condition.

                • Source (dict) -- [REQUIRED]

                  A source item of enablement expression.

                  • Type (string) -- [REQUIRED]

                    A type of source item. Valid values:

                    • QUESTION_REF_ID - The answer to another question in the evaluation form.

                    • CONTACT - Data from the evaluated contact.

                    • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                    • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                  • RefId (string) --

                    A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                  • ContactField (string) --

                    The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                  • ContactAttributeKey (string) --

                    The key of the contact attribute to use as the source. Use when Type is CONTACT.

                  • SegmentAttributeKey (string) --

                    The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                  • EvaluationMetadataField (string) --

                    The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                  • AiMetricsField (string) --

                    The AI metrics field to use as the source. Use when Type is AI_METRICS.

                • Values (list) -- [REQUIRED]

                  A list of values from source item.

                  • (dict) --

                    An enablement expression source value. Provide only the value member that matches the specified Type.

                    • Type (string) -- [REQUIRED]

                      A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                    • RefId (string) --

                      A referenceId of the source value. Use when Type is OPTION_REF_ID.

                    • StringValue (string) --

                      A string value to compare against the source. Use when Type is STRING_VALUE.

                    • NumericValue (float) --

                      A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                    • BooleanValue (boolean) --

                      A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                    • DateTimeValue (datetime) --

                      A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                • Comparator (string) -- [REQUIRED]

                  A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

              • Condition (dict) --

                A condition for item enablement.

          • Operator (string) --

            The operator to apply to the operands when more than one operand is provided.

        • Action (string) -- [REQUIRED]

          The enablement action to apply if the condition is satisfied.

        • DefaultAction (string) --

          The enablement action to apply if the condition is not satisfied. This action is also applied when the condition depends on an external source that is still pending or could not be resolved.

    • Question (dict) --

      The information of the question.

      • Title (string) -- [REQUIRED]

        The title of the question.

      • Instructions (string) --

        The instructions of the section.

      • RefId (string) -- [REQUIRED]

        The identifier of the question. An identifier must be unique within the evaluation form.

      • NotApplicableEnabled (boolean) --

        The flag to enable not applicable answers to the question.

      • QuestionType (string) -- [REQUIRED]

        The type of the question.

      • QuestionTypeProperties (dict) --

        The properties of the type of question. Text questions do not have to define question type properties.

        • Numeric (dict) --

          The properties of the numeric question.

          • MinValue (integer) -- [REQUIRED]

            The minimum answer value.

          • MaxValue (integer) -- [REQUIRED]

            The maximum answer value.

          • Options (list) --

            The scoring options of the numeric question.

            • (dict) --

              Information about the option range used for scoring in numeric questions.

              • MinValue (integer) -- [REQUIRED]

                The minimum answer value of the range option.

              • MaxValue (integer) -- [REQUIRED]

                The maximum answer value of the range option.

              • Score (integer) --

                The score assigned to answer values within the range option.

              • AutomaticFail (boolean) --

                The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

              • AutomaticFailConfiguration (dict) --

                A configuration for automatic fail.

                • TargetSection (string) --

                  The referenceId of the target section for auto failure.

              • PointsConfiguration (dict) --

                The points configuration for point-based scoring.

                • PointValue (integer) -- [REQUIRED]

                  The point value assigned to the answer option.

                • IsBonus (boolean) --

                  The flag to mark the option as a bonus option.

          • Automation (dict) --

            The automation properties of the numeric question.

            • PropertyValue (dict) --

              The property value of the automation.

              • Label (string) -- [REQUIRED]

                The property label of the automation.

            • AnswerSource (dict) --

              A source of automation answer for numeric question.

              • SourceType (string) -- [REQUIRED]

                The automation answer source type. Valid values:

                • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                • GEN_AI - The answer is generated by generative AI.

                • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

        • SingleSelect (dict) --

          The properties of the numeric question.

          • Options (list) -- [REQUIRED]

            The answer options of the single select question.

            • (dict) --

              Information about the automation configuration in single select questions.

              • RefId (string) -- [REQUIRED]

                The identifier of the answer option. An identifier must be unique within the question.

              • Text (string) -- [REQUIRED]

                The title of the answer option.

              • Score (integer) --

                The score assigned to the answer option.

              • AutomaticFail (boolean) --

                The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

              • AutomaticFailConfiguration (dict) --

                Whether automatic fail is configured on a single select question.

                • TargetSection (string) --

                  The referenceId of the target section for auto failure.

              • PointsConfiguration (dict) --

                The points configuration for point-based scoring.

                • PointValue (integer) -- [REQUIRED]

                  The point value assigned to the answer option.

                • IsBonus (boolean) --

                  The flag to mark the option as a bonus option.

          • DisplayAs (string) --

            The display mode of the single select question.

          • Automation (dict) --

            The display mode of the single select question.

            • Options (list) --

              The automation options of the single select question.

              • (dict) --

                Information about the automation option of a single select question.

                • RuleCategory (dict) --

                  The automation option based on a rule category for the single select question.

                  • Category (string) -- [REQUIRED]

                    The category name, as defined in Rules. This is equivalent to a conversational analytics rule with the same name: the automation option is applied based on whether that rule matched the contact. For more information about creating rules, see Create rules in the Connect Customer Administrator Guide.

                  • Condition (string) -- [REQUIRED]

                    The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.

                  • OptionRefId (string) -- [REQUIRED]

                    The identifier of the answer option.

                • AutomationRule (dict) --

                  The automation option based on a condition for the single select question. Use with the CONDITION answer source type.

                  • Condition (dict) -- [REQUIRED]

                    The condition that must be satisfied for the answer option to be selected. The condition uses the same sources, comparators, and operators as item enablement conditions.

                    • Operands (list) -- [REQUIRED]

                      Operands of the enablement condition.

                      • (dict) --

                        An operand of the enablement condition.

                        • Expression (dict) --

                          An expression of the enablement condition.

                          • Source (dict) -- [REQUIRED]

                            A source item of enablement expression.

                            • Type (string) -- [REQUIRED]

                              A type of source item. Valid values:

                              • QUESTION_REF_ID - The answer to another question in the evaluation form.

                              • CONTACT - Data from the evaluated contact.

                              • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                              • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                            • RefId (string) --

                              A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                            • ContactField (string) --

                              The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                            • ContactAttributeKey (string) --

                              The key of the contact attribute to use as the source. Use when Type is CONTACT.

                            • SegmentAttributeKey (string) --

                              The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                            • EvaluationMetadataField (string) --

                              The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                            • AiMetricsField (string) --

                              The AI metrics field to use as the source. Use when Type is AI_METRICS.

                          • Values (list) -- [REQUIRED]

                            A list of values from source item.

                            • (dict) --

                              An enablement expression source value. Provide only the value member that matches the specified Type.

                              • Type (string) -- [REQUIRED]

                                A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                              • RefId (string) --

                                A referenceId of the source value. Use when Type is OPTION_REF_ID.

                              • StringValue (string) --

                                A string value to compare against the source. Use when Type is STRING_VALUE.

                              • NumericValue (float) --

                                A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                              • BooleanValue (boolean) --

                                A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                              • DateTimeValue (datetime) --

                                A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                          • Comparator (string) -- [REQUIRED]

                            A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

                        • Condition (dict) --

                          A condition for item enablement.

                    • Operator (string) --

                      The operator to apply to the operands when more than one operand is provided.

                  • OptionRefId (string) -- [REQUIRED]

                    The identifier of the answer option to select when the condition is satisfied.

            • DefaultOptionRefId (string) --

              The identifier of the default answer option, when none of the automation options match the criteria.

            • AnswerSource (dict) --

              Automation answer source.

              • SourceType (string) -- [REQUIRED]

                The automation answer source type. Valid values:

                • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                • GEN_AI - The answer is generated by generative AI.

                • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

        • Text (dict) --

          The properties of the text question.

          • Automation (dict) --

            The automation properties of the text question.

            • AnswerSource (dict) --

              Automation answer source.

              • SourceType (string) -- [REQUIRED]

                The automation answer source type. Valid values:

                • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                • GEN_AI - The answer is generated by generative AI.

                • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

        • MultiSelect (dict) --

          Properties for multi-select question types.

          • Options (list) -- [REQUIRED]

            Options available for this multi-select question.

            • (dict) --

              An option for a multi-select question in an evaluation form.

              • RefId (string) -- [REQUIRED]

                Reference identifier for this option.

              • Text (string) -- [REQUIRED]

                Display text for this option.

              • Score (integer) --

                The score assigned to the answer option.

              • AutomaticFail (boolean) --

                The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.

              • AutomaticFailConfiguration (dict) --

                Information about automatic fail configuration for an evaluation form.

                • TargetSection (string) --

                  The referenceId of the target section for auto failure.

              • PointsConfiguration (dict) --

                The points configuration for point-based scoring.

                • PointValue (integer) -- [REQUIRED]

                  The point value assigned to the answer option.

                • IsBonus (boolean) --

                  The flag to mark the option as a bonus option.

          • DisplayAs (string) --

            Display format for the multi-select question.

          • Automation (dict) --

            Automation configuration for this multi-select question.

            • Options (list) --

              Automation options for the multi-select question.

              • (dict) --

                An automation option for a multi-select question.

                • RuleCategory (dict) --

                  Rule category configuration for this automation option.

                  • Category (string) -- [REQUIRED]

                    The category name for this automation rule.

                  • Condition (string) -- [REQUIRED]

                    The condition for this automation rule.

                  • OptionRefIds (list) -- [REQUIRED]

                    Reference IDs of options for this automation rule.

                    • (string) --

            • DefaultOptionRefIds (list) --

              Reference IDs of default options.

              • (string) --

            • AnswerSource (dict) --

              Automation answer source.

              • SourceType (string) -- [REQUIRED]

                The automation answer source type. Valid values:

                • CONTACT_LENS_DATA - The answer is based on Contact Lens data, such as rule categories and metrics.

                • GEN_AI - The answer is generated by generative AI.

                • CONDITION - The answer is determined by evaluating the conditions defined in the automation rules of the question.

      • Enablement (dict) --

        A question conditional enablement.

        • Condition (dict) -- [REQUIRED]

          A condition for item enablement configuration.

          • Operands (list) -- [REQUIRED]

            Operands of the enablement condition.

            • (dict) --

              An operand of the enablement condition.

              • Expression (dict) --

                An expression of the enablement condition.

                • Source (dict) -- [REQUIRED]

                  A source item of enablement expression.

                  • Type (string) -- [REQUIRED]

                    A type of source item. Valid values:

                    • QUESTION_REF_ID - The answer to another question in the evaluation form.

                    • CONTACT - Data from the evaluated contact.

                    • EVALUATION_METADATA - Metadata of the evaluation, such as the evaluation type.

                    • AI_METRICS - Metrics about AI agents, AI sessions, and AI tools on the contact.

                  • RefId (string) --

                    A referenceId of the source item. Use when Type is QUESTION_REF_ID.

                  • ContactField (string) --

                    The contact field to use as the source, such as CHANNEL, QUEUE_ARN, OVERALL_CUSTOMER_SENTIMENT_SCORE, or RECORDING_MEDIA_STREAM_TYPES. Use when Type is CONTACT.

                  • ContactAttributeKey (string) --

                    The key of the contact attribute to use as the source. Use when Type is CONTACT.

                  • SegmentAttributeKey (string) --

                    The key of the contact segment attribute to use as the source. Use when Type is CONTACT.

                  • EvaluationMetadataField (string) --

                    The evaluation metadata field to use as the source. Use when Type is EVALUATION_METADATA.

                  • AiMetricsField (string) --

                    The AI metrics field to use as the source. Use when Type is AI_METRICS.

                • Values (list) -- [REQUIRED]

                  A list of values from source item.

                  • (dict) --

                    An enablement expression source value. Provide only the value member that matches the specified Type.

                    • Type (string) -- [REQUIRED]

                      A type of source item value. Valid values: OPTION_REF_ID | STRING_VALUE | NUMERIC_VALUE | BOOLEAN_VALUE | DATETIME_VALUE.

                    • RefId (string) --

                      A referenceId of the source value. Use when Type is OPTION_REF_ID.

                    • StringValue (string) --

                      A string value to compare against the source. Use when Type is STRING_VALUE.

                    • NumericValue (float) --

                      A numeric value to compare against the source. Use when Type is NUMERIC_VALUE.

                    • BooleanValue (boolean) --

                      A Boolean value to compare against the source. Use when Type is BOOLEAN_VALUE.

                    • DateTimeValue (datetime) --

                      A date and time value to compare against the source. Use when Type is DATETIME_VALUE.

                • Comparator (string) -- [REQUIRED]

                  A comparator to be used against a list of values. IN, NOT_IN, ALL_IN, and EXACT compare sets of values. GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, and LESS_THAN_OR_EQUAL_TO compare a single numeric or date and time value. EQUAL_TO and NOT_EQUAL_TO compare a single value.

              • Condition (dict) --

                A condition for item enablement.

          • Operator (string) --

            The operator to apply to the operands when more than one operand is provided.

        • Action (string) -- [REQUIRED]

          The enablement action to apply if the condition is satisfied.

        • DefaultAction (string) --

          The enablement action to apply if the condition is not satisfied. This action is also applied when the condition depends on an external source that is still pending or could not be resolved.

      • Weight (float) --

        The scoring weight of the section.

      • ScoringConfiguration (dict) --

        The scoring configuration of the question.

        • PointsConfiguration (dict) --

          The points configuration for point-based scoring.

          • MaxPointValue (integer) --

            The maximum point value.

          • MinPointValue (integer) --

            The minimum point value.

          • IsBonus (boolean) --

            The flag to mark the question as a bonus question.

        • IsExcludedFromScoring (boolean) --

          The flag to exclude the question from scoring.

        • ScoreThresholds (list) --

          The score thresholds for performance categories.

          • (dict) --

            Information about a score threshold for a performance category.

            • PerformanceCategory (string) -- [REQUIRED]

              The performance category name.

            • MinScorePercentage (float) --

              The minimum score percentage for the performance category.

            • MaxScorePercentage (float) --

              The maximum score percentage for the performance category.

      • MetricConfiguration (dict) --

        The metric configuration for the question. Use this to associate a business outcome metric with the question.

        • MetricType (string) -- [REQUIRED]

          The type of metric. Currently, only BUSINESS_OUTCOME is supported.

        • MetricName (string) -- [REQUIRED]

          The name of the metric. Valid values are:

          • SALE_SUCCESS – Sale success.

          • CSAT – Customer satisfaction.

          • CHURN_PROPENSITY – Churn propensity.

          • SELF_SERVICE_SUCCESS – Self-service success.

          • PARTIAL_SELF_SERVICE_SUCCESS – Partial self-service success.

type ScoringStrategy:

dict

param ScoringStrategy:

A scoring strategy of the evaluation form.

  • Mode (string) -- [REQUIRED]

    The scoring mode of the evaluation form.

  • Status (string) -- [REQUIRED]

    The scoring status of the evaluation form.

  • ScoreThresholds (list) --

    The score thresholds for performance categories.

    • (dict) --

      Information about a score threshold for a performance category.

      • PerformanceCategory (string) -- [REQUIRED]

        The performance category name.

      • MinScorePercentage (float) --

        The minimum score percentage for the performance category.

      • MaxScorePercentage (float) --

        The maximum score percentage for the performance category.

type AutoEvaluationConfiguration:

dict

param AutoEvaluationConfiguration:

Whether automated evaluations are enabled.

  • Enabled (boolean) -- [REQUIRED]

    When automated evaluation is enabled.

type ReviewConfiguration:

dict

param ReviewConfiguration:

Configuration for evaluation review settings of the evaluation form.

  • ReviewNotificationRecipients (list) -- [REQUIRED]

    List of recipients who should be notified when a review is requested.

    • (dict) --

      Information about a recipient who should be notified when an evaluation review is requested.

      • Type (string) -- [REQUIRED]

        The type of notification recipient.

      • Value (dict) -- [REQUIRED]

        The value associated with the notification recipient type.

        • UserId (string) --

          The user identifier for the notification recipient.

  • EligibilityDays (integer) --

    Number of days during which a request for review can be submitted for evaluations created from this form.

type AsDraft:

boolean

param AsDraft:

A boolean flag indicating whether to update evaluation form to draft state.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

type TargetConfiguration:

dict

param TargetConfiguration:

Configuration that specifies the target for the evaluation form.

  • ContactInteractionType (string) -- [REQUIRED]

    The contact interaction type for this evaluation form.

type LanguageConfiguration:

dict

param LanguageConfiguration:

Configuration for language settings of the evaluation form.

  • FormLanguage (string) --

    The language for the evaluation form.

type AIVersion:

string

param AIVersion:

The AI version to use for the evaluation form. This specifies which AI model version is used for automated evaluations.

rtype:

dict

returns:

Response Syntax

{
    'EvaluationFormId': 'string',
    'EvaluationFormArn': 'string',
    'EvaluationFormVersion': 123
}

Response Structure

  • (dict) --

    • EvaluationFormId (string) --

      The unique identifier for the evaluation form.

    • EvaluationFormArn (string) --

      The Amazon Resource Name (ARN) for the contact evaluation resource.

    • EvaluationFormVersion (integer) --

      The version of the updated evaluation form resource.