Skip to content

RuleBasedProperties

Source code in docs_src/capo_entityresolution/types/rule_based_properties.py 
15
16
17
18
19
20
21
22
23
class RuleBasedProperties(TypedDict, closed=True):
    rules: "capo_entityresolution.types.rule_list.RuleList"
    """<p>A list of <code>Rule</code> objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.</p>"""
    attribute_matching_model: (
        "capo_entityresolution.types.attribute_matching_model.AttributeMatchingModel"
    )
    """<p>The comparison type. You can choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the <code>attributeMatchingModel</code>. </p> <p>If you choose <code>ONE_TO_ONE</code>, the system can only match attributes if the sub-types are an exact match. For example, for the <code>Email</code> attribute type, the system will only consider it a match if the value of the <code>Email</code> field of Profile A matches the value of the <code>Email</code> field of Profile B.</p> <p>If you choose <code>MANY_TO_MANY</code>, the system can match attributes across the sub-types of an attribute type. For example, if the value of the <code>Email</code> field of Profile A and the value of <code>BusinessEmail</code> field of Profile B matches, the two profiles are matched on the <code>Email</code> attribute type. </p>"""
    match_purpose: NotRequired["capo_entityresolution.types.match_purpose.MatchPurpose"]
    """<p> An indicator of whether to generate IDs and index the data or not.</p> <p>If you choose <code>IDENTIFIER_GENERATION</code>, the process generates IDs and indexes the data.</p> <p>If you choose <code>INDEXING</code>, the process indexes the data without generating IDs.</p>"""

attribute_matching_model instance-attribute 

attribute_matching_model: AttributeMatchingModel

The comparison type. You can choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email attribute type.

match_purpose instance-attribute 

match_purpose: NotRequired[MatchPurpose]

An indicator of whether to generate IDs and index the data or not.

If you choose IDENTIFIER_GENERATION, the process generates IDs and indexes the data.

If you choose INDEXING, the process indexes the data without generating IDs.

rules instance-attribute 

rules: RuleList

A list of Rule objects, each of which have fields RuleName and MatchingKeys.