Skip to content

MatchItem

Source code in docs_src/capo_customer_profiles/types/match_item.py 
13
14
15
16
17
18
19
20
21
class MatchItem(TypedDict, closed=True):
    match_id: NotRequired["capo_customer_profiles.types.string1_to255.string1To255"]
    """<p>The unique identifiers for this group of profiles that match.</p>"""
    profile_ids: NotRequired[
        "capo_customer_profiles.types.profile_id_list.ProfileIdList"
    ]
    """<p>A list of identifiers for profiles that match.</p>"""
    confidence_score: NotRequired["capo_customer_profiles.types.double.Double"]
    """<p>A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used an absolute measure of matching quality.</p>"""

confidence_score instance-attribute 

confidence_score: NotRequired[Double]

A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used an absolute measure of matching quality.

match_id instance-attribute 

match_id: NotRequired[string1To255]

The unique identifiers for this group of profiles that match.

profile_ids instance-attribute 

profile_ids: NotRequired[ProfileIdList]

A list of identifiers for profiles that match.