Skip to content

RecommendationTrigger

Source code in docs_src/capo_wisdom/types/recommendation_trigger.py
class RecommendationTrigger(TypedDict, closed=True):
    id: "capo_wisdom.types.uuid.Uuid"
    """<p>The identifier of the recommendation trigger.</p>"""
    type: "capo_wisdom.types.recommendation_trigger_type.RecommendationTriggerType"
    """<p>The type of recommendation trigger.</p>"""
    source: "capo_wisdom.types.recommendation_source_type.RecommendationSourceType"
    """<p>The source of the recommendation trigger.</p> <ul> <li> <p>ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.</p> </li> <li> <p>RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.</p> </li> </ul>"""
    data: "capo_wisdom.types.recommendation_trigger_data.RecommendationTriggerData"
    """<p>A union type containing information related to the trigger.</p>"""
    recommendation_ids: "capo_wisdom.types.recommendation_id_list.RecommendationIdList"
    """<p>The identifiers of the recommendations.</p>"""

data instance-attribute

A union type containing information related to the trigger.

id instance-attribute

id: Uuid

The identifier of the recommendation trigger.

recommendation_ids instance-attribute

recommendation_ids: RecommendationIdList

The identifiers of the recommendations.

source instance-attribute

The source of the recommendation trigger.

  • ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.

  • RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.

type instance-attribute

The type of recommendation trigger.