Skip to content

NamespaceRuleBasedProperties

Source code in docs_src/capo_entityresolution/types/namespace_rule_based_properties.py
class NamespaceRuleBasedProperties(TypedDict, closed=True):
    rules: NotRequired["capo_entityresolution.types.rule_list.RuleList"]
    """<p> The rules for the ID namespace.</p>"""
    rule_definition_types: NotRequired[
        "capo_entityresolution.types.id_mapping_workflow_rule_definition_type_list.IdMappingWorkflowRuleDefinitionTypeList"
    ]
    """<p> The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.</p>"""
    attribute_matching_model: NotRequired[
        "capo_entityresolution.types.attribute_matching_model.AttributeMatchingModel"
    ]
    """<p>The comparison type. You can either 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 matches the value of <code>BusinessEmail</code> field of Profile B, the two profiles are matched on the <code>Email</code> attribute type. </p>"""
    record_matching_models: NotRequired[
        "capo_entityresolution.types.record_matching_model_list.RecordMatchingModelList"
    ]
    """<p> The type of matching record that is allowed to be used in an ID mapping workflow. </p> <p>If the value is set to <code>ONE_SOURCE_TO_ONE_TARGET</code>, only one record in the source is matched to one record in the target. </p> <p>If the value is set to <code>MANY_SOURCE_TO_ONE_TARGET</code>, all matching records in the source are matched to one record in the target.</p>"""

attribute_matching_model instance-attribute

attribute_matching_model: NotRequired[AttributeMatchingModel]

The comparison type. You can either 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 matches the value of BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

record_matching_models instance-attribute

record_matching_models: NotRequired[RecordMatchingModelList]

The type of matching record that is allowed to be used in an ID mapping workflow.

If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source is matched to one record in the target.

If the value is set to MANY_SOURCE_TO_ONE_TARGET, all matching records in the source are matched to one record in the target.

rule_definition_types instance-attribute

rule_definition_types: NotRequired[IdMappingWorkflowRuleDefinitionTypeList]

The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.

rules instance-attribute

rules: NotRequired[RuleList]

The rules for the ID namespace.