why_entities, why_records, why_record_in_entity Flags
why_entities, why_records, why_record_in_entity
These are the control flags applicable to:
- C/C++:
Sz_whyEntities,Sz_whyRecords,Sz_whyRecordInEntity - C#:
WhyEntities,WhyRecords,WhyRecordInEntity - Java:
whyEntities,whyRecords,whyRecordInEntity - Python:
why_entities,why_records,why_record_in_entity - sz_command:
why_entities,why_records,why_record_in_entity
These three methods share the same flag group. In addition to SZ_INCLUDE_FEATURE_SCORES
and SZ_INCLUDE_MATCH_KEY_DETAILS
, they support all the get_entity*() flags
.
The default composite flag for each is:
SZ_WHY_ENTITIES_DEFAULT_FLAGS=SZ_INCLUDE_FEATURE_SCORESSZ_WHY_RECORDS_DEFAULT_FLAGS=SZ_INCLUDE_FEATURE_SCORESSZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS=SZ_INCLUDE_FEATURE_SCORES
SZ_WHY_ENTITIES_DEFAULT_FLAGS
The default recommended flags for why_entities. Equivalent to: SZ_INCLUDE_FEATURE_SCORES
.
Click to expand response JSON Click to collapse
{
"WHY_RESULTS": [
{
"ENTITY_ID": 1,
"ENTITY_ID_2": 5,
"MATCH_INFO": {
"WHY_KEY": "+NAME+ADDRESS-DOB",
"WHY_ERRULE_CODE": "CNAME_CFF_DEXCL",
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"CANDIDATE_KEYS": {
"ADDR_KEY": [
{
"FEAT_ID": 6,
"FEAT_DESC": "123|MN||LS FKS"
},
{
"FEAT_ID": 7,
"FEAT_DESC": "123|MN||89132"
}
],
"NAMEADDR_KEY": [
{
"FEAT_ID": 10,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132"
},
{
"FEAT_ID": 11,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS"
}
],
"NAMEREGION_KEY": [
{
"FEAT_ID": 15,
"FEAT_DESC": "RPRT|SM0|POST=89132"
},
{
"FEAT_ID": 16,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
}
],
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"ADDRESS": [
{
"INBOUND_FEAT_ID": 3,
"INBOUND_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"INBOUND_FEAT_USAGE_TYPE": "MAILING",
"CANDIDATE_FEAT_ID": 1373,
"CANDIDATE_FEAT_DESC": "123 Main St, Las Vegas",
"CANDIDATE_FEAT_USAGE_TYPE": "MAILING",
"SCORE": 99,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 99
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FF"
}
],
"DOB": [
{
"INBOUND_FEAT_ID": 2,
"INBOUND_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_ID": 1372,
"CANDIDATE_FEAT_DESC": "3/31/1954",
"SCORE": 59,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 59
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "FMES"
}
],
"NAME": [
{
"INBOUND_FEAT_ID": 1,
"INBOUND_FEAT_DESC": "Robert Smith",
"INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
"CANDIDATE_FEAT_ID": 56,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": 100,
"GNR_GN": 95,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
],
"RECORD_TYPE": [
{
"INBOUND_FEAT_ID": 9,
"INBOUND_FEAT_DESC": "PERSON",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "PERSON",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FVME"
}
]
},
"DISCLOSED_RELATIONS": {}
}
}
],
"ENTITIES": [
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
},
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 5
}
}
]
}
SZ_WHY_RECORDS_DEFAULT_FLAGS
The default recommended flags for why_records. Equivalent to: SZ_INCLUDE_FEATURE_SCORES
.
Click to expand response JSON Click to collapse
{
"WHY_RESULTS": [
{
"INTERNAL_ID": 1,
"ENTITY_ID": 1,
"FOCUS_RECORDS": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001"
}
],
"INTERNAL_ID_2": 2,
"ENTITY_ID_2": 1,
"FOCUS_RECORDS_2": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1002"
}
],
"MATCH_INFO": {
"WHY_KEY": "+NAME+DOB+PHONE",
"WHY_ERRULE_CODE": "CNAME_CFF_CEXCL",
"MATCH_LEVEL_CODE": "RESOLVED",
"CANDIDATE_KEYS": {
"NAMEDATE_KEY": [
{
"FEAT_ID": 12,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211"
},
{
"FEAT_ID": 13,
"FEAT_DESC": "RPRT|SM0|DOB=71211"
}
],
"NAMEPHONE_KEY": [
{
"FEAT_ID": 17,
"FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300"
}
],
"NAMEREGION_KEY": [
{
"FEAT_ID": 16,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
}
],
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
],
"PHONE_KEY": [
{
"FEAT_ID": 8,
"FEAT_DESC": "7029191300"
}
]
},
"FEATURE_SCORES": {
"ADDRESS": [
{
"INBOUND_FEAT_ID": 3,
"INBOUND_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"INBOUND_FEAT_USAGE_TYPE": "MAILING",
"CANDIDATE_FEAT_ID": 20,
"CANDIDATE_FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"CANDIDATE_FEAT_USAGE_TYPE": "HOME",
"SCORE": 42,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 42
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "FF"
}
],
"DOB": [
{
"INBOUND_FEAT_ID": 2,
"INBOUND_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_ID": 19,
"CANDIDATE_FEAT_DESC": "11/12/1978",
"SCORE": 95,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 95
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "FMES"
}
],
"NAME": [
{
"INBOUND_FEAT_ID": 1,
"INBOUND_FEAT_DESC": "Robert Smith",
"INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
"CANDIDATE_FEAT_ID": 18,
"CANDIDATE_FEAT_DESC": "Bob Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": 100,
"GNR_GN": 95,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
],
"PHONE": [
{
"INBOUND_FEAT_ID": 4,
"INBOUND_FEAT_DESC": "702-919-1300",
"INBOUND_FEAT_USAGE_TYPE": "HOME",
"CANDIDATE_FEAT_ID": 4,
"CANDIDATE_FEAT_DESC": "702-919-1300",
"CANDIDATE_FEAT_USAGE_TYPE": "MOBILE",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FF"
}
],
"RECORD_TYPE": [
{
"INBOUND_FEAT_ID": 9,
"INBOUND_FEAT_DESC": "PERSON",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "PERSON",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FVME"
}
]
},
"DISCLOSED_RELATIONS": {}
}
}
],
"ENTITIES": [
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
]
}
SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS
The default recommended flags for why_record_in_entity. Equivalent to: SZ_INCLUDE_FEATURE_SCORES
.
Click to expand response JSON Click to collapse
{
"WHY_RESULTS": [
{
"INTERNAL_ID": 1,
"ENTITY_ID": 1,
"FOCUS_RECORDS": [
{
"DATA_SOURCE": "CUSTOMERS",
"RECORD_ID": "1001"
}
],
"MATCH_INFO": {
"WHY_KEY": "+NAME+DOB+PHONE",
"WHY_ERRULE_CODE": "CNAME_CFF_CEXCL",
"MATCH_LEVEL_CODE": "RESOLVED",
"CANDIDATE_KEYS": {
"DOB": [
{
"FEAT_ID": 2,
"FEAT_DESC": "12/11/1978"
}
],
"NAMEDATE_KEY": [
{
"FEAT_ID": 12,
"FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211"
},
{
"FEAT_ID": 13,
"FEAT_DESC": "RPRT|SM0|DOB=71211"
},
{
"FEAT_ID": 14,
"FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278"
}
],
"NAMEPHONE_KEY": [
{
"FEAT_ID": 17,
"FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300"
}
],
"NAMEREGION_KEY": [
{
"FEAT_ID": 16,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
}
],
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
],
"PHONE_KEY": [
{
"FEAT_ID": 8,
"FEAT_DESC": "7029191300"
}
]
},
"FEATURE_SCORES": {
"ADDRESS": [
{
"INBOUND_FEAT_ID": 3,
"INBOUND_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"INBOUND_FEAT_USAGE_TYPE": "MAILING",
"CANDIDATE_FEAT_ID": 20,
"CANDIDATE_FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
"CANDIDATE_FEAT_USAGE_TYPE": "HOME",
"SCORE": 42,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 42
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "FF"
}
],
"DOB": [
{
"INBOUND_FEAT_ID": 2,
"INBOUND_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_ID": 2,
"CANDIDATE_FEAT_DESC": "12/11/1978",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FMES"
}
],
"NAME": [
{
"INBOUND_FEAT_ID": 1,
"INBOUND_FEAT_DESC": "Robert Smith",
"INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
"CANDIDATE_FEAT_ID": 18,
"CANDIDATE_FEAT_DESC": "Bob Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": 100,
"GNR_GN": 95,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
],
"PHONE": [
{
"INBOUND_FEAT_ID": 4,
"INBOUND_FEAT_DESC": "702-919-1300",
"INBOUND_FEAT_USAGE_TYPE": "HOME",
"CANDIDATE_FEAT_ID": 4,
"CANDIDATE_FEAT_DESC": "702-919-1300",
"CANDIDATE_FEAT_USAGE_TYPE": "MOBILE",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FF"
}
],
"RECORD_TYPE": [
{
"INBOUND_FEAT_ID": 9,
"INBOUND_FEAT_DESC": "PERSON",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "PERSON",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FVME"
}
]
}
}
}
],
"ENTITIES": [
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
}
]
}
SZ_INCLUDE_MATCH_KEY_DETAILS
Adding SZ_INCLUDE_MATCH_KEY_DETAILS to the flags includes a WHY_KEY_DETAILS object in the MATCH_INFO that breaks down the match key into its component CONFIRMATIONS and DENIALS, showing the specific feature comparisons that led to each token in the match key.
This sample response message was generated using SZ_INCLUDE_MATCH_KEY_DETAILS | SZ_INCLUDE_FEATURE_SCORES
with why_entities:
Click to expand response JSON Click to collapse
{
"WHY_RESULTS": [
{
"ENTITY_ID": 1,
"ENTITY_ID_2": 5,
"MATCH_INFO": {
"WHY_KEY": "+NAME+ADDRESS-DOB",
"WHY_KEY_DETAILS": {
"CONFIRMATIONS": [
{
"TOKEN": "NAME",
"FTYPE_CODE": "NAME",
"SCORE_BEHAVIOR": "NAME",
"SOURCE": "/SAME_NAME",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": 100,
"GNR_GN": 95,
"GNR_ON": -1,
"GENERATION_MATCH": -1
},
"INBOUND_FEAT_ID": 1,
"INBOUND_FEAT_DESC": "Robert Smith",
"INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
"CANDIDATE_FEAT_ID": 56,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE_BUCKET": "CLOSE"
},
{
"TOKEN": "ADDRESS",
"FTYPE_CODE": "ADDRESS",
"SCORE_BEHAVIOR": "FF",
"SOURCE": "ADDRESS",
"SCORE": 99,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 99
},
"INBOUND_FEAT_ID": 3,
"INBOUND_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"INBOUND_FEAT_USAGE_TYPE": "MAILING",
"CANDIDATE_FEAT_ID": 1373,
"CANDIDATE_FEAT_DESC": "123 Main St, Las Vegas",
"CANDIDATE_FEAT_USAGE_TYPE": "MAILING",
"SCORE_BUCKET": "SAME"
}
],
"DENIALS": [
{
"TOKEN": "DOB",
"FTYPE_CODE": "DOB",
"SCORE_BEHAVIOR": "FMES",
"SOURCE": "DOB",
"SCORE": 59,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 59
},
"INBOUND_FEAT_ID": 2,
"INBOUND_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_ID": 1372,
"CANDIDATE_FEAT_DESC": "3/31/1954",
"SCORE_BUCKET": "NO_CHANCE"
}
]
},
"WHY_ERRULE_CODE": "CNAME_CFF_DEXCL",
"MATCH_LEVEL_CODE": "POSSIBLY_SAME",
"CANDIDATE_KEYS": {
"ADDR_KEY": [
{
"FEAT_ID": 6,
"FEAT_DESC": "123|MN||LS FKS"
},
{
"FEAT_ID": 7,
"FEAT_DESC": "123|MN||89132"
}
],
"NAMEADDR_KEY": [
{
"FEAT_ID": 10,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132"
},
{
"FEAT_ID": 11,
"FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS"
}
],
"NAMEREGION_KEY": [
{
"FEAT_ID": 15,
"FEAT_DESC": "RPRT|SM0|POST=89132"
},
{
"FEAT_ID": 16,
"FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
}
],
"NAME_KEY": [
{
"FEAT_ID": 5,
"FEAT_DESC": "RPRT|SM0"
}
]
},
"FEATURE_SCORES": {
"ADDRESS": [
{
"INBOUND_FEAT_ID": 3,
"INBOUND_FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
"INBOUND_FEAT_USAGE_TYPE": "MAILING",
"CANDIDATE_FEAT_ID": 1373,
"CANDIDATE_FEAT_DESC": "123 Main St, Las Vegas",
"CANDIDATE_FEAT_USAGE_TYPE": "MAILING",
"SCORE": 99,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 99
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FF"
}
],
"DOB": [
{
"INBOUND_FEAT_ID": 2,
"INBOUND_FEAT_DESC": "12/11/1978",
"CANDIDATE_FEAT_ID": 1372,
"CANDIDATE_FEAT_DESC": "3/31/1954",
"SCORE": 59,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 59
},
"SCORE_BUCKET": "NO_CHANCE",
"SCORE_BEHAVIOR": "FMES"
}
],
"NAME": [
{
"INBOUND_FEAT_ID": 1,
"INBOUND_FEAT_DESC": "Robert Smith",
"INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
"CANDIDATE_FEAT_ID": 56,
"CANDIDATE_FEAT_DESC": "Robbie Smith",
"CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
"SCORE": 97,
"ADDITIONAL_SCORES": {
"GNR_FN": 97,
"GNR_SN": 100,
"GNR_GN": 95,
"GENERATION_MATCH": -1,
"GNR_ON": -1
},
"SCORE_BUCKET": "CLOSE",
"SCORE_BEHAVIOR": "NAME"
}
],
"RECORD_TYPE": [
{
"INBOUND_FEAT_ID": 9,
"INBOUND_FEAT_DESC": "PERSON",
"CANDIDATE_FEAT_ID": 9,
"CANDIDATE_FEAT_DESC": "PERSON",
"SCORE": 100,
"ADDITIONAL_SCORES": {
"FULL_SCORE": 100
},
"SCORE_BUCKET": "SAME",
"SCORE_BEHAVIOR": "FVME"
}
]
},
"DISCLOSED_RELATIONS": {}
}
}
],
"ENTITIES": [
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 1
}
},
{
"RESOLVED_ENTITY": {
"ENTITY_ID": 5
}
}
]
}
If you have any questions, contact Senzing Support. Support is 100% FREE!