Skip to content

GenerateMatchIdInput

Source code in docs_src/capo_entityresolution/types/generate_match_id_input.py 
15
16
17
18
19
20
21
22
23
class GenerateMatchIdInput(TypedDict, closed=True):
    workflow_name: "capo_entityresolution.types.entity_name.EntityName"
    """<p> The name of the rule-based matching workflow.</p>"""
    records: "capo_entityresolution.types.record_list.RecordList"
    """<p> The records to match.</p>"""
    processing_type: NotRequired[
        "capo_entityresolution.types.processing_type.ProcessingType"
    ]
    """<p>The processing mode that determines how Match IDs are generated and results are saved. Each mode provides different levels of accuracy, response time, and completeness of results.</p> <p>If not specified, defaults to <code>CONSISTENT</code>.</p> <p> <code>CONSISTENT</code>: Performs immediate lookup and matching against all existing records, with results saved synchronously. Provides highest accuracy but slower response time.</p> <p> <code>EVENTUAL</code> (shown as <i>Background</i> in the console): Performs initial match ID lookup or generation immediately, with record updates processed asynchronously in the background. Offers faster initial response time, with complete matching results available later in S3. </p> <p> <code>EVENTUAL_NO_LOOKUP</code> (shown as <i>Quick ID generation</i> in the console): Generates new match IDs without checking existing matches, with updates processed asynchronously. Provides fastest response time but should only be used for records known to be unique. </p> <note> <p>Advanced matching workflows don't support the <code>processingType</code> field.</p> </note>"""

processing_type instance-attribute 

processing_type: NotRequired[ProcessingType]

The processing mode that determines how Match IDs are generated and results are saved. Each mode provides different levels of accuracy, response time, and completeness of results.

If not specified, defaults to CONSISTENT.

CONSISTENT: Performs immediate lookup and matching against all existing records, with results saved synchronously. Provides highest accuracy but slower response time.

EVENTUAL (shown as Background in the console): Performs initial match ID lookup or generation immediately, with record updates processed asynchronously in the background. Offers faster initial response time, with complete matching results available later in S3.

EVENTUAL_NO_LOOKUP (shown as Quick ID generation in the console): Generates new match IDs without checking existing matches, with updates processed asynchronously. Provides fastest response time but should only be used for records known to be unique.

Advanced matching workflows don't support the processingType field.

records instance-attribute 

records: RecordList

The records to match.

workflow_name instance-attribute 

workflow_name: EntityName

The name of the rule-based matching workflow.