Skip to content

EvaluationSearchMetadata

Source code in docs_src/capo_connect/types/evaluation_search_metadata.py
class EvaluationSearchMetadata(TypedDict, closed=True):
    contact_id: "capo_connect.types.contact_id.ContactId"
    """<p>The identifier of the contact in this instance of Connect Customer. </p>"""
    evaluator_arn: "capo_connect.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) of the person who evaluated the contact.</p>"""
    contact_agent_id: NotRequired["capo_connect.types.resource_id.ResourceId"]
    """<p>The unique ID of the agent who handled the contact.</p>"""
    calibration_session_id: NotRequired["capo_connect.types.resource_id.ResourceId"]
    """<p>The calibration session ID that this evaluation belongs to.</p>"""
    score_percentage: (
        "capo_connect.types.evaluation_score_percentage.EvaluationScorePercentage"
    )
    """<p>The total evaluation score expressed as a percentage.</p>"""
    score_automatic_fail: "capo_connect.types.boolean.Boolean"
    """<p>The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag is true.</p>"""
    score_not_applicable: "capo_connect.types.boolean.Boolean"
    """<p>The flag to mark the item as not applicable for scoring.</p>"""
    auto_evaluation_enabled: "capo_connect.types.boolean.Boolean"
    """<p>Whether auto-evaluation is enabled.</p>"""
    auto_evaluation_status: NotRequired[
        "capo_connect.types.auto_evaluation_status.AutoEvaluationStatus"
    ]
    """<p>The status of the contact auto evaluation. </p>"""
    acknowledged_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>When the evaluation was acknowledged by the agent.</p>"""
    acknowledged_by: NotRequired["capo_connect.types.arn.ARN"]
    """<p>The agent who acknowledged the evaluation.</p>"""
    acknowledger_comment: NotRequired[
        "capo_connect.types.evaluation_acknowledger_comment_string.EvaluationAcknowledgerCommentString"
    ]
    """<p>The comment from the agent when they acknowledged the evaluation.</p>"""
    sampling_job_id: NotRequired["capo_connect.types.resource_id.ResourceId"]
    """<p>Identifier of the sampling job.</p>"""
    review_id: NotRequired["capo_connect.types.resource_id.ResourceId"]
    """<p>Identifier for the review.</p>"""
    contact_participant_role: NotRequired[
        "capo_connect.types.contact_participant_role.ContactParticipantRole"
    ]
    """<p>Role of a contact participant in the evaluation.</p>"""
    contact_participant_id: NotRequired["capo_connect.types.resource_id.ResourceId"]
    """<p>Identifier for a contact participant in the evaluation.</p>"""
    earned_points: NotRequired["capo_connect.types.integer.Integer"]
    """<p>The points earned for the evaluation.</p>"""
    max_base_point: NotRequired["capo_connect.types.integer.Integer"]
    """<p>The maximum base points possible for the evaluation.</p>"""
    performance_category: NotRequired[
        "capo_connect.types.performance_category_name.PerformanceCategoryName"
    ]
    """<p>The performance category for the evaluation score.</p>"""

acknowledged_by instance-attribute

acknowledged_by: NotRequired[ARN]

The agent who acknowledged the evaluation.

acknowledged_time instance-attribute

acknowledged_time: NotRequired[Timestamp]

When the evaluation was acknowledged by the agent.

acknowledger_comment instance-attribute

acknowledger_comment: NotRequired[EvaluationAcknowledgerCommentString]

The comment from the agent when they acknowledged the evaluation.

auto_evaluation_enabled instance-attribute

auto_evaluation_enabled: Boolean

Whether auto-evaluation is enabled.

auto_evaluation_status instance-attribute

auto_evaluation_status: NotRequired[AutoEvaluationStatus]

The status of the contact auto evaluation.

calibration_session_id instance-attribute

calibration_session_id: NotRequired[ResourceId]

The calibration session ID that this evaluation belongs to.

contact_agent_id instance-attribute

contact_agent_id: NotRequired[ResourceId]

The unique ID of the agent who handled the contact.

contact_id instance-attribute

contact_id: ContactId

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

contact_participant_id instance-attribute

contact_participant_id: NotRequired[ResourceId]

Identifier for a contact participant in the evaluation.

contact_participant_role instance-attribute

contact_participant_role: NotRequired[ContactParticipantRole]

Role of a contact participant in the evaluation.

earned_points instance-attribute

earned_points: NotRequired[Integer]

The points earned for the evaluation.

evaluator_arn instance-attribute

evaluator_arn: ARN

The Amazon Resource Name (ARN) of the person who evaluated the contact.

max_base_point instance-attribute

max_base_point: NotRequired[Integer]

The maximum base points possible for the evaluation.

performance_category instance-attribute

performance_category: NotRequired[PerformanceCategoryName]

The performance category for the evaluation score.

review_id instance-attribute

review_id: NotRequired[ResourceId]

Identifier for the review.

sampling_job_id instance-attribute

sampling_job_id: NotRequired[ResourceId]

Identifier of the sampling job.

score_automatic_fail instance-attribute

score_automatic_fail: Boolean

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

score_not_applicable instance-attribute

score_not_applicable: Boolean

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

score_percentage instance-attribute

score_percentage: EvaluationScorePercentage

The total evaluation score expressed as a percentage.