senzing_grpc

The senzing_grpc Python package has 5 major modules / classes. Senzing objects are created using an Abstract Factory Pattern.

Senzing classes

Module	Class	Creation
szconfig	SzConfigGrpc	sz_config = sz_abstract_factory.create_config()
szconfigmanager	SzConfigManagerGrpc	sz_configmanager = sz_abstract_factory.create_configmanager()
szdiagnostic	SzDiagnosticGrpc	sz_diagnostic = sz_abstract_factory.create_diagnostic()
szengine	SzEngineGrpc	sz_engine = sz_abstract_factory.create_engine()
szproduct	SzProductGrpc	sz_product = sz_abstract_factory.create_product()

For the full implementation of the documentation examples, visit the source code on GitHub.

szabstractfactory

senzing_grpc.szabstractfactory.SzAbstractFactoryGrpc is a gRPC implementation of the senzing.szabstractfactory.SzAbstractFactory interface.

class senzing_grpc.szabstractfactory.SzAbstractFactoryGrpc(grpc_channel: Channel)

Bases: SzAbstractFactory

SzAbstractFactory module is a factory pattern for accessing Senzing over gRPC.

create_configmanager() → SzConfigManager

The create_configmanager method creates a new implementation of an SzConfigManager object.

Args:

Returns:

A new implementation.

Return type:

SzConfigManager

Raises:

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// No output from this example.

create_diagnostic() → SzDiagnostic

The create_diagnostic method creates a new implementation of an SzDiagnostic object.

Args:

Returns:

A new implementation.

Return type:

SzDiagnostic

Raises:

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_diagnostic = sz_abstract_factory.create_diagnostic()
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// No output from this example.

create_engine() → SzEngine

The create_engine method creates a new implementation of an SzEngine object.

Args:

Returns:

A new implementation.

Return type:

SzEngine

Raises:

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// No output from this example.

create_product() → SzProduct

The create_product method creates a new implementation of an SzProduct object.

Args:

Returns:

A new implementation.

Return type:

SzProduct

Raises:

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_product = sz_abstract_factory.create_product()
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// No output from this example.

reinitialize(config_id: int) → None

The reinitialize method reinitializes the Senzing objects using a specific configuration identifier. A list of available configuration identifiers can be retrieved using szconfigmanager.get_configs.

Parameters:

config_id (int) – The configuration ID used for the initialization

Raises:

• TypeError – Incorrect datatype of input parameter.

• szexception.SzError – config_id does not exist.

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    # Using get_active_config_id for demonstrations purposes.
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    config_id = sz_engine.get_active_config_id()
    sz_abstract_factory.reinitialize(config_id)
except SzError as err:
    print(f"\nERROR: {err}\n")

class senzing_grpc.szabstractfactory.SzAbstractFactoryParametersGrpc

Bases: TypedDict

SzAbstractFactoryParameters is used to create a dictionary that can be unpacked when creating an SzAbstractFactory.

grpc_channel: Channel

szconfig

senzing_grpc.szconfig.SzConfigGrpc is a gRPC implementation of the senzing.szconfig.SzConfig interface.

class senzing_grpc.szconfig.SzConfigGrpc(grpc_channel: Channel)

Bases: SzConfig

SzConfig module access library over gRPC.

add_data_source(data_source_code: str) → str

The add_data_source method adds a data source to an existing in-memory configuration.

Parameters:

data_source_code (str) – Name of data source code to add.

Returns:

A string containing a JSON document listing the newly created data source.

Return type:

str

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

data_source_code = "NAME_OF_DATASOURCE"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    sz_config = sz_configmanager.create_config_from_template()
    result = sz_config.add_data_source(data_source_code)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "DSRC_ID": 1001
}

delete_data_source(data_source_code: str) → str

The delete_data_source method removes a data source from an existing in-memory configuration.

Parameters:

data_source_code (str) – Name of data source code to delete.

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

data_source_code = "TEST"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    sz_config = sz_configmanager.create_config_from_template()
    result = sz_config.delete_data_source(data_source_code)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// No output from this example.

export() → str

The export method creates a JSON string representation of the Senzing SzConfig object.

Args:

Returns:

A string containing a JSON Document representation of the Senzing SzConfig object.

Return type:

str

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    sz_config = sz_configmanager.create_config_from_template()
    config_definition = sz_config.export()
    print(f"\n{config_definition}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted and pruned for easier reading.
// To view a complete configuration, visit /opt/senzing/er/resources/templates/g2config.json

{
    "G2_CONFIG": {
        "CFG_ATTR": [],
        "CFG_CFBOM": [],
        "CFG_CFCALL": [],
        "CFG_CFRTN": [],
        "CFG_CFUNC": [],
        "CFG_DFBOM": [],
        "CFG_DFCALL": [],
        "CFG_DFUNC": [],
        "CFG_DSRC": [],
        "CFG_DSRC_INTEREST": [],
        "CFG_ECLASS": [],
        "CFG_EFBOM": [],
        "CFG_EFCALL": [],
        "CFG_EFUNC": [],
        "CFG_ERFRAG": [],
        "CFG_ERRULE": [],
        "CFG_ETYPE": [],
        "CFG_FBOM": [],
        "CFG_FBOVR": [],
        "CFG_FCLASS": [],
        "CFG_FELEM": [],
        "CFG_FTYPE": [],
        "CFG_GENERIC_THRESHOLD": [],
        "CFG_GPLAN": [],
        "CFG_LENS": [],
        "CFG_LENSRL": [],
        "CFG_RCLASS": [],
        "CFG_RTYPE": [],
        "CFG_SFCALL": [],
        "CFG_SFUNC": [],
        "SYS_OOM": [],
        "CONFIG_BASE_VERSION": {
            "VERSION": "4.0.0",
            "BUILD_VERSION": "4.0.0.00000",
            "BUILD_DATE": "2025-01-01",
            "BUILD_NUMBER": "00000",
            "COMPATIBILITY_VERSION": {
                "CONFIG_VERSION": "11"
            }
        }
    }
}

get_data_sources() → str

The get_data_sources method returns a JSON document of data sources contained in an in-memory configuration.

Args:

Returns:

A string containing a JSON document listing all of the data sources.

Return type:

str

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    sz_config = sz_configmanager.create_config_from_template()
    result = sz_config.get_data_sources()
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "DATA_SOURCES": [
        {
            "DSRC_ID": 1,
            "DSRC_CODE": "TEST"
        },
        {
            "DSRC_ID": 2,
            "DSRC_CODE": "SEARCH"
        }
    ]
}

help(method_name: str = '') → str

Return the help for a particular message.

Parameters:

method_name (str) – The name of the method. (e.g. “init”). If empty, a list of methods and descriptions is returned.

Returns:

The Help information about the requested method

Return type:

str

import_config_definition(config_definition: str) → None

Set the internal JSON document.

Parameters:

config_definition (str) – A Senzing configuration JSON document.

import_template() → None

Retrieves a Senzing configuration from the default template. The default template is the Senzing configuration JSON document file, g2config.json, located in the PIPELINE.RESOURCEPATH path.

initialize(instance_name: str, settings: str | Dict[Any, Any], verbose_logging: int = 0) → None

Null function in the sz-sdk-python-grpc implementation.

verify_config_definition(config_definition: str) → bool

Determine if configuration definition is valid.

Parameters:

config_definition (str) – A Senzing configuration JSON document.

szconfigmanager

senzing_grpc.szconfigmanager.SzConfigManagerGrpc is a gRPC implementation of the senzing.szconfigmanager.SzConfigManager interface.

class senzing_grpc.szconfigmanager.SzConfigManagerGrpc(grpc_channel: Channel)

Bases: SzConfigManager

SzConfigManager module access library over gRPC.

create_config_from_config_id(config_id: int) → SzConfig

The create_config_from_config_id method creates an in-memory Senzing configuration from a specific Senzing configuration stored in the Senzing database.

Parameters:

config_id (int) – The configuration identifier of the desired Senzing configuration to retrieve.

Returns:

Represents an in-memory Senzing configuration that can be modified.

Return type:

SzConfig

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    config_id = sz_configmanager.get_default_config_id()
    sz_config = sz_configmanager.create_config_from_config_id(config_id)
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted and pruned for easier reading.

{
    "G2_CONFIG": {
        "CFG_ATTR": [
            {
                "ATTR_ID": 1001,
                "ATTR_CODE": "DATA_SOURCE",
                "ATTR_CLASS": "OBSERVATION",
                "FTYPE_CODE": null,
                "FELEM_CODE": null,
                "FELEM_REQ": "Yes",
                "DEFAULT_VALUE": null,
                "INTERNAL": "No"
            }
        ],
        "CFG_CFBOM": [
            {
                "CFCALL_ID": 1,
                "FTYPE_ID": 1,
                "FELEM_ID": 2,
                "EXEC_ORDER": 1
            }
        ],
        "CFG_CFCALL": [
            {
                "CFCALL_ID": 1,
                "FTYPE_ID": 1,
                "CFUNC_ID": 2
            }
        ],
        "CFG_CFRTN": [
            {
                "CFRTN_ID": 1,
                "CFUNC_ID": 1,
                "FTYPE_ID": 0,
                "CFUNC_RTNVAL": "FULL_SCORE",
                "EXEC_ORDER": 1,
                "SAME_SCORE": 100,
                "CLOSE_SCORE": 90,
                "LIKELY_SCORE": 80,
                "PLAUSIBLE_SCORE": 70,
                "UN_LIKELY_SCORE": 60
            }
        ],
        "CFG_CFUNC": [
            {
                "CFUNC_ID": 1,
                "CFUNC_CODE": "STR_COMP",
                "CFUNC_DESC": "String comparison",
                "CONNECT_STR": "g2StringComp",
                "ANON_SUPPORT": "Yes",
                "LANGUAGE": null
            }
        ],
        "CFG_DFBOM": [
            {
                "DFCALL_ID": 1,
                "FTYPE_ID": 1,
                "FELEM_ID": 2,
                "EXEC_ORDER": 1
            }
        ],
        "CFG_DFCALL": [
            {
                "DFCALL_ID": 1,
                "FTYPE_ID": 1,
                "DFUNC_ID": 5
            }
        ],
        "CFG_DFUNC": [
            {
                "DFUNC_ID": 1,
                "DFUNC_CODE": "FELEM_STRICT_SUBSET",
                "DFUNC_DESC": "Strict subset of felems",
                "CONNECT_STR": "g2StrictSubsetFelems",
                "ANON_SUPPORT": "Yes",
                "LANGUAGE": null
            }
        ],
        "CFG_DSRC": [
            {
                "DSRC_ID": 1,
                "DSRC_CODE": "TEST",
                "DSRC_DESC": "Test",
                "RETENTION_LEVEL": "Remember"
            }
        ],
        "CFG_DSRC_INTEREST": [],
        "CFG_EFBOM": [
            {
                "EFCALL_ID": 1,
                "FTYPE_ID": 6,
                "FELEM_ID": 60,
                "EXEC_ORDER": 1,
                "FELEM_REQ": "Yes"
            }
        ],
        "CFG_EFCALL": [
            {
                "EFCALL_ID": 1,
                "FTYPE_ID": 6,
                "FELEM_ID": -1,
                "EFUNC_ID": 4,
                "EXEC_ORDER": 1,
                "EFEAT_FTYPE_ID": -1,
                "IS_VIRTUAL": "No"
            }
        ],
        "CFG_EFUNC": [
            {
                "EFUNC_ID": 1,
                "EFUNC_CODE": "EXPRESS_BOM",
                "EFUNC_DESC": "General BOM Hasher",
                "CONNECT_STR": "g2GenericHasher",
                "LANGUAGE": null
            }
        ],
        "CFG_ERFRAG": [
            {
                "ERFRAG_ID": 11,
                "ERFRAG_CODE": "SAME_NAME",
                "ERFRAG_DESC": "SAME_NAME",
                "ERFRAG_SOURCE": "./FRAGMENT[./GNR_SAME_NAME>0]",
                "ERFRAG_DEPENDS": "301"
            }
        ],
        "CFG_ERRULE": [
            {
                "ERRULE_ID": 100,
                "ERRULE_CODE": "SAME_A1",
                "RESOLVE": "Yes",
                "RELATE": "No",
                "RTYPE_ID": 1,
                "QUAL_ERFRAG_CODE": "SAME_A1",
                "DISQ_ERFRAG_CODE": null,
                "ERRULE_TIER": 10
            }
        ],
        "CFG_FBOM": [
            {
                "FTYPE_ID": 1,
                "FELEM_ID": 2,
                "EXEC_ORDER": 1,
                "DISPLAY_LEVEL": 1,
                "DISPLAY_DELIM": null,
                "DERIVED": "No"
            }
        ],
        "CFG_FBOVR": [
            {
                "FTYPE_ID": 5,
                "UTYPE_CODE": "BUSINESS",
                "FTYPE_FREQ": "FF",
                "FTYPE_EXCL": "Yes",
                "FTYPE_STAB": "No"
            }
        ],
        "CFG_FCLASS": [
            {
                "FCLASS_ID": 1,
                "FCLASS_CODE": "NAME"
            }
        ],
        "CFG_FELEM": [
            {
                "FELEM_ID": 2,
                "FELEM_CODE": "FULL_NAME",
                "FELEM_DESC": "Full name",
                "DATA_TYPE": "string"
            }
        ],
        "CFG_FTYPE": [
            {
                "FTYPE_ID": 1,
                "FTYPE_CODE": "NAME",
                "FTYPE_DESC": "Name",
                "FCLASS_ID": 1,
                "FTYPE_FREQ": "NAME",
                "FTYPE_EXCL": "No",
                "FTYPE_STAB": "No",
                "PERSIST_HISTORY": "Yes",
                "USED_FOR_CAND": "No",
                "DERIVED": "No",
                "RTYPE_ID": 0,
                "ANONYMIZE": "No",
                "VERSION": 2,
                "SHOW_IN_MATCH_KEY": "Yes"
            }
        ],
        "CFG_GENERIC_THRESHOLD": [
            {
                "GPLAN_ID": 1,
                "BEHAVIOR": "NAME",
                "FTYPE_ID": 0,
                "CANDIDATE_CAP": 10,
                "SCORING_CAP": -1,
                "SEND_TO_REDO": "Yes"
            }
        ],
        "CFG_GPLAN": [
            {
                "GPLAN_ID": 1,
                "GPLAN_CODE": "INGEST",
                "GPLAN_DESC": "Standard Ingestion"
            }
        ],
        "CFG_RCLASS": [
            {
                "RCLASS_ID": 1,
                "RCLASS_CODE": "DERIVED",
                "RCLASS_DESC": "Derived",
                "IS_DISCLOSED": "No"
            }
        ],
        "CFG_RTYPE": [
            {
                "RTYPE_ID": 1,
                "RTYPE_CODE": "RESOLVED",
                "RTYPE_DESC": "Resolved",
                "RCLASS_ID": 1,
                "BREAK_RES": "No"
            }
        ],
        "CFG_SFCALL": [
            {
                "SFCALL_ID": 1,
                "FTYPE_ID": 1,
                "FELEM_ID": -1,
                "SFUNC_ID": 1,
                "EXEC_ORDER": 1
            }
        ],
        "CFG_SFUNC": [
            {
                "SFUNC_ID": 1,
                "SFUNC_CODE": "PARSE_NAME",
                "SFUNC_DESC": "Parse name",
                "CONNECT_STR": "g2ParseName",
                "LANGUAGE": null
            }
        ],
        "SYS_OOM": [
            {
                "OOM_TYPE": "RF",
                "OOM_LEVEL": "SYSDEFAULT",
                "FTYPE_ID": 0,
                "THRESH1_CNT": 100,
                "THRESH1_OOM": 10,
                "NEXT_THRESH": 1000
            }
        ],
        "SETTINGS": {
            "METAPHONE_VERSION": 3
        },
        "CONFIG_BASE_VERSION": {
            "VERSION": "4.0.0",
            "BUILD_VERSION": "4.0.0.00000",
            "BUILD_DATE": "2025-01-01",
            "BUILD_NUMBER": "00000",
            "COMPATIBILITY_VERSION": {
                "CONFIG_VERSION": "11"
            }
        }
    }
}

create_config_from_string(config_definition: str) → SzConfig

The create_config_from_string method creates an in-memory Senzing configuration from the given Senzing configuration JSON document.

Parameters:

config_definition (str) – The Senzing configuration JSON document.

Returns:

Represents an in-memory Senzing configuration that can be modified.

Return type:

SzConfig

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import json

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

config_definition = json.dumps({"G2_CONFIG": {}})

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    sz_config = sz_configmanager.create_config_from_string(config_definition)
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

create_config_from_template() → SzConfig

The create_config_from_template method creates an in-memory Senzing configuration from the template Senzing configuration JSON document located at PIPELINE.RESOURCEPATH/templates/g2config.json

Parameters:

config_definition (str) – The Senzing configuration JSON document.

Returns:

Represents an in-memory Senzing configuration that can be modified.

Return type:

SzConfig

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    sz_config = sz_configmanager.create_config_from_template()
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

get_configs() → str

The get_configs method retrieves a list of Senzing configurations from the Senzing database.

Returns:

A JSON document containing Senzing configurations.

Return type:

str

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    config_list = sz_configmanager.get_configs()
    print(f"\n{config_list}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "CONFIGS": [
        {
            "CONFIG_ID": 41320074,
            "CONFIG_COMMENTS": "Default Senzing configuration",
            "SYS_CREATE_DT": "YYYY-MM-DD HH:MM:SS.mmm"
        },
        {
            "CONFIG_ID": 490826130,
            "CONFIG_COMMENTS": "Test",
            "SYS_CREATE_DT": "YYYY-MM-DD HH:MM:SS.mmm"
        }
    ]
}

get_default_config_id() → int

The get_default_config_id method retrieves from the Senzing database the configuration identifier of the default Senzing configuration.

Returns:

A configuration identifier which identifies the current configuration in use.

Return type:

int

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    config_id = sz_configmanager.get_default_config_id()
    print(f"\n{config_id}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

692503001

help(method_name: str = '') → str

Return the help for a particular message.

Parameters:

method_name (str) – The name of the method. (e.g. “init”). If empty, a list of methods and descriptions is returned.

Returns:

The Help information about the requested method

Return type:

str

initialize(instance_name: str, settings: str | Dict[Any, Any], verbose_logging: int = 0) → None

Null function in the sz-sdk-python-grpc implementation.

register_config(config_definition: str, config_comment: str) → int

The register_config method adds a Senzing configuration JSON document to the Senzing database.

Parameters:

• config_definition (str) – The Senzing configuration JSON document.

• config_comment (str) – free-form string of comments describing the configuration document.

Returns:

A configuration identifier.

Return type:

int

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

config_comment = "Just an empty example"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    sz_config = sz_configmanager.create_config_from_template()
    config_definition = sz_config.export()
    config_id = sz_configmanager.register_config(config_definition, config_comment)
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// No output from this example.

replace_default_config_id(current_default_config_id: int, new_default_config_id: int) → None

The replace_default_config_id method replaces the old configuration identifier with a new configuration identifier in the Senzing database. It is like a “compare-and-swap” instruction to serialize concurrent editing of configuration. If current_default_config_id is no longer the “current configuration identifier”, the operation will fail. To simply set the default configuration ID, use set_default_config_id.

Parameters:

• current_default_config_id (int) – The configuration identifier to replace.

• new_default_config_id (int) – The configuration identifier to use as the default.

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import time

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

config_comment = "Just an example"
data_source_code = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()
    sz_config = sz_configmanager.create_config_from_template()
    current_default_config_id = sz_configmanager.get_default_config_id()

    # Create a new config.

    sz_config = sz_configmanager.create_config_from_config_id(current_default_config_id)
    sz_config.add_data_source(data_source_code)

    # Persist the new config.

    config_definition = sz_config.export()
    new_default_config_id = sz_configmanager.register_config(config_definition, config_comment)

    # Replace default config id.

    sz_configmanager.replace_default_config_id(current_default_config_id, new_default_config_id)
except SzError as err:
    print(f"\nERROR: {err}\n")

set_default_config(config_definition: str, config_comment: str) → int

The set_default_config method replaces the current default Senzing configuration in the Senzing database. To serialize modifying of the configuration identifier, see replace_default_config_id.

Parameters:

• config_definition (str) – The Senzing configuration JSON document.

• config_comment (str) – free-form string of comments describing the configuration document.

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import time

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

config_comment = "Just an example"
data_source_code = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()

    # Create a new config.

    sz_config = sz_configmanager.create_config_from_template()
    sz_config.add_data_source(data_source_code)

    # Persist the new default config.

    config_definition = sz_config.export()
    config_id = sz_configmanager.set_default_config(config_definition, config_comment)
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

set_default_config_id(config_id: int) → None

The set_default_config_id method replaces and sets a new configuration identifier in the Senzing database. To serialize modifying of the configuration identifier, see replace_default_config_id.

Parameters:

config_id (int) – The configuration identifier of the Senzing Engine configuration to use as the default.

Raises:

TypeError – Incorrect datatype of input parameter.

Example:

import time

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

config_comment = "Just an example"
data_source_code = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_configmanager = sz_abstract_factory.create_configmanager()

    # Create a new config.

    sz_config = sz_configmanager.create_config_from_template()
    sz_config.add_data_source(data_source_code)

    # Persist the new config.

    config_definition = sz_config.export()
    new_default_config_id = sz_configmanager.register_config(config_definition, config_comment)

    # Set default config id.

    sz_configmanager.set_default_config_id(new_default_config_id)
except SzError as err:
    print(f"\nERROR: {err}\n")

szdiagnostic

senzing_grpc.szdiagnostic.SzDiagnosticGrpc is a gRPC implementation of the senzing.szdiagnostic.SzDiagnostic interface.

class senzing_grpc.szdiagnostic.SzDiagnosticGrpc(grpc_channel: Channel)

Bases: SzDiagnostic

SzDiagnostic module access library over gRPC.

check_datastore_performance(seconds_to_run: int) → str

The check_datastore_performance method performs inserts to determine rate of insertion.

Parameters:

seconds_to_run (int) – Duration of the test in seconds.

Returns:

A string containing a JSON document.

Return type:

str

Raises:

• TypeError – Incorrect datatype of input parameter.

• szexception.SzError –

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

seconds_to_run = 3

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_diagnostic = sz_abstract_factory.create_diagnostic()
    result = sz_diagnostic.check_datastore_performance(seconds_to_run)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "numRecordsInserted": 0,
    "insertTime": 0
}

get_datastore_info() → str

The get_datastore_info method returns a JSON document with details of the datastore currently in use by Senzing.

Raises:

szexception.SzError –

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_diagnostic = sz_abstract_factory.create_diagnostic()
    result = sz_diagnostic.get_datastore_info()
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "dataStores": [
        {
            "id": "CORE",
            "type": "sqlite3",
            "location": "/tmp/sqlite/G2C.db"
        }
    ]
}

get_feature(feature_id: int) → str

TODO: Add get_feature()

help(method_name: str = '') → str

Return the help for a particular message.

Parameters:

method_name (str) – The name of the method. (e.g. “init”). If empty, a list of methods and descriptions is returned.

Returns:

The Help information about the requested method

Return type:

str

initialize(instance_name: str, settings: str | Dict[Any, Any], config_id: int | None = None, verbose_logging: int = 0) → None

Null function in the sz-sdk-python-grpc implementation.

purge_repository() → None

Null function in the sz-sdk-python-grpc implementation.

reinitialize(config_id: int) → None

szengine

senzing_grpc.szengine.SzEngineGrpc is a gRPC implementation of the senzing.szengine.SzEngine interface.

class senzing_grpc.szengine.SzEngineGrpc(grpc_channel: Channel)

Bases: SzEngine

Sz engine module access library over gRPC.

add_record(data_source_code: str, record_id: str, record_definition: str, flags: int = 0) → str

The add_record method adds a record into the Senzing repository. Can be called as many times as desired and from multiple threads at the same time.

Parameters:

• data_source_code (str) – Identifies the provenance of the data.

• record_id (str) – The unique identifier within the records of the same data source.

• record_definition (str) – A JSON document containing the record to be added to the Senzing repository.

• flags (int, optional) – Flags used to control information returned. Defaults to 0.

Returns:

If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty string.

Return type:

str

Raises:

Example:

import json

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

data_source_code = "TEST"
flags = SzEngineFlags.SZ_WITH_INFO
record_definition = json.dumps(
    {
        "RECORD_TYPE": "PERSON",
        "PRIMARY_NAME_LAST": "Smith",
        "PRIMARY_NAME_FIRST": "Robert",
        "DATE_OF_BIRTH": "12/11/1978",
        "ADDR_TYPE": "MAILING",
        "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132",
        "PHONE_TYPE": "HOME",
        "PHONE_NUMBER": "702-919-1300",
        "EMAIL_ADDRESS": "bsmith@work.com",
        "DATE": "1/2/18",
        "STATUS": "Active",
        "AMOUNT": "100",
    }
)
record_id = "1"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.add_record(data_source_code, record_id, record_definition, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "DATA_SOURCE": "TEST",
    "RECORD_ID": "1",
    "AFFECTED_ENTITIES": [
        {
            "ENTITY_ID": 1
        },
        {
            "ENTITY_ID": 35
        }
    ],
    "INTERESTING_ENTITIES": {
        "ENTITIES": []
    }
}

close_export(export_handle: int) → None

The close_export method closes the exported document created by export_json_entity_report. It is part of the export_json_entity_report, fetch_next, close_export lifecycle of a list of sized entities.

Parameters:

export_handle (int) – A handle created by export_json_entity_report or export_csv_entity_report.

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

flags = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    export_handle = sz_engine.export_json_entity_report(flags)
    while True:
        fragment = sz_engine.fetch_next(export_handle)
        if not fragment:
            break
        print(fragment, end="")
    sz_engine.close_export(export_handle)
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

{"RESOLVED_ENTITY":{"ENTITY_ID":1,"ENTITY_NAME":"","FEATURES":{},"RECORD_SUMMARY":[{"DATA_SOURCE":"TEST","RECORD_COUNT":1}],"RECORDS":[{"DATA_SOURCE":"TEST","RECORD_ID":"2","INTERNAL_ID":1,"MATCH_KEY":"","MATCH_LEVEL_CODE":"","ERRULE_CODE":"","FIRST_SEEN_DT":"2024-10-25T17:38:57Z","LAST_SEEN_DT":"2024-10-25T17:38:57Z"}]},"RELATED_ENTITIES":[]}
{"RESOLVED_ENTITY":{"ENTITY_ID":35,"ENTITY_NAME":"Robert Smith","FEATURES":{"ADDRESS":[{"FEAT_DESC":"1515 Adela Lane Las Vegas NV 89111","LIB_FEAT_ID":22,"USAGE_TYPE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"1515 Adela Lane Las Vegas NV 89111","LIB_FEAT_ID":22}]},{"FEAT_DESC":"123 Main Street, Las Vegas NV 89132","LIB_FEAT_ID":3,"USAGE_TYPE":"MAILING","FEAT_DESC_VALUES":[{"FEAT_DESC":"123 Main Street, Las Vegas NV 89132","LIB_FEAT_ID":3}]}],"DOB":[{"FEAT_DESC":"12/11/1978","LIB_FEAT_ID":2,"FEAT_DESC_VALUES":[{"FEAT_DESC":"12/11/1978","LIB_FEAT_ID":2},{"FEAT_DESC":"11/12/1978","LIB_FEAT_ID":21}]}],"EMAIL":[{"FEAT_DESC":"bsmith@work.com","LIB_FEAT_ID":5,"FEAT_DESC_VALUES":[{"FEAT_DESC":"bsmith@work.com","LIB_FEAT_ID":5}]}],"NAME":[{"FEAT_DESC":"Robert Smith","LIB_FEAT_ID":1,"USAGE_TYPE":"PRIMARY","FEAT_DESC_VALUES":[{"FEAT_DESC":"Robert Smith","LIB_FEAT_ID":1},{"FEAT_DESC":"Bob J Smith","LIB_FEAT_ID":38},{"FEAT_DESC":"Bob Smith","LIB_FEAT_ID":20}]}],"PHONE":[{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4,"USAGE_TYPE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4}]},{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4,"USAGE_TYPE":"MOBILE","FEAT_DESC_VALUES":[{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4}]}],"RECORD_TYPE":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10,"FEAT_DESC_VALUES":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10}]}]},"RECORD_SUMMARY":[{"DATA_SOURCE":"CUSTOMERS","RECORD_COUNT":3}],"RECORDS":[{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1001","INTERNAL_ID":35,"MATCH_KEY":"","MATCH_LEVEL_CODE":"","ERRULE_CODE":"","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"},{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1002","INTERNAL_ID":36,"MATCH_KEY":"+NAME+DOB+PHONE","MATCH_LEVEL_CODE":"RESOLVED","ERRULE_CODE":"CNAME_CFF_CEXCL","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"},{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1003","INTERNAL_ID":37,"MATCH_KEY":"+NAME+DOB+EMAIL","MATCH_LEVEL_CODE":"RESOLVED","ERRULE_CODE":"SF1_PNAME_CSTAB","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"}]},"RELATED_ENTITIES":[]}
{"RESOLVED_ENTITY":{"ENTITY_ID":38,"ENTITY_NAME":"Edward Kusha","FEATURES":{"ADDRESS":[{"FEAT_DESC":"1304 Poppy Hills Dr Blacklick OH 43004","LIB_FEAT_ID":46,"USAGE_TYPE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"1304 Poppy Hills Dr Blacklick OH 43004","LIB_FEAT_ID":46}]}],"DOB":[{"FEAT_DESC":"3/1/1970","LIB_FEAT_ID":45,"FEAT_DESC_VALUES":[{"FEAT_DESC":"3/1/1970","LIB_FEAT_ID":45}]}],"EMAIL":[{"FEAT_DESC":"Kusha123@hmail.com","LIB_FEAT_ID":48,"FEAT_DESC_VALUES":[{"FEAT_DESC":"Kusha123@hmail.com","LIB_FEAT_ID":48}]}],"NAME":[{"FEAT_DESC":"Edward Kusha","LIB_FEAT_ID":44,"USAGE_TYPE":"PRIMARY","FEAT_DESC_VALUES":[{"FEAT_DESC":"Edward Kusha","LIB_FEAT_ID":44}]}],"RECORD_TYPE":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10,"FEAT_DESC_VALUES":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10}]}],"SSN":[{"FEAT_DESC":"294-66-9999","LIB_FEAT_ID":47,"FEAT_DESC_VALUES":[{"FEAT_DESC":"294-66-9999","LIB_FEAT_ID":47}]}]},"RECORD_SUMMARY":[{"DATA_SOURCE":"CUSTOMERS","RECORD_COUNT":1}],"RECORDS":[{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1009","INTERNAL_ID":38,"MATCH_KEY":"","MATCH_LEVEL_CODE":"","ERRULE_CODE":"","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"}]},"RELATED_ENTITIES":[]}

count_redo_records() → int

The count_redo_records method returns the number of records in need of redo-ing.

Returns:

The number of redo records in Senzing’s redo queue.

Return type:

int

Raises:

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.count_redo_records()
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

2

delete_record(data_source_code: str, record_id: str, flags: int = 0) → str

The delete_record method deletes a record from the Senzing repository. Can be called as many times as desired and from multiple threads at the same time.

Parameters:

• data_source_code (str) – Identifies the provenance of the data.

• record_id (str) – The unique identifier within the records of the same data source.

• flags (int, optional) – Flags used to control information returned. Defaults to 0.

Returns:

If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty string.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

data_source_code = "TEST"
flags = SzEngineFlags.SZ_WITH_INFO
record_id = "1"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.delete_record(data_source_code, record_id, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "DATA_SOURCE": "TEST",
    "RECORD_ID": "1",
    "AFFECTED_ENTITIES": [
        {
            "ENTITY_ID": 35
        }
    ],
    "INTERESTING_ENTITIES": {
        "ENTITIES": []
    }
}

export_csv_entity_report(csv_column_list: str, flags: int = <SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS: 3734497>) → int

Warning: export_csv_entity_report is not recommended for large systems as it does not scale. It is recommended larger systems implement real-time replication to a data warehouse.

The export_csv_entity_report method initializes a cursor over a document of exported entities. It is part of the export_csv_entity_report, fetch_next, close_export lifecycle of a list of entities to export.

Available CSV columns: RESOLVED_ENTITY_ID, RESOLVED_ENTITY_NAME, RELATED_ENTITY_ID, MATCH_LEVEL,

MATCH_LEVEL_CODE, MATCH_KEY, MATCH_KEY_DETAILS,I S_DISCLOSED, IS_AMBIGUOUS, DATA_SOURCE, RECORD_ID, JSON_DATA, FIRST_SEEN_DT, LAST_SEEN_DT, UNMAPPED_DATA, ERRULE_CODE, RELATED_ENTITY_NAME

Suggested CSV columns: RESOLVED_ENTITY_ID, RELATED_ENTITY_ID, RESOLVED_ENTITY_NAME, MATCH_LEVEL,

MATCH_KEY, DATA_SOURCE, RECORD_ID

Parameters:

• csv_column_list (str) – A comma-separated list of column names for the CSV export.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS.

Returns:

A handle that identifies the document to be scrolled through using fetch_next.

Return type:

int

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

csv_column_list = (
    "RESOLVED_ENTITY_ID,RELATED_ENTITY_ID,RESOLVED_ENTITY_NAME,MATCH_LEVEL,MATCH_KEY,DATA_SOURCE,RECORD_ID"
)
flags = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    export_handle = sz_engine.export_csv_entity_report(csv_column_list, flags)
    while True:
        fragment = sz_engine.fetch_next(export_handle)
        if not fragment:
            break
        print(fragment, end="")
    sz_engine.close_export(export_handle)
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

RESOLVED_ENTITY_ID,RESOLVED_ENTITY_NAME,RELATED_ENTITY_ID,MATCH_LEVEL,MATCH_KEY,DATA_SOURCE,RECORD_ID
1,"",0,0,"","TEST","2"
35,"Robert Smith",0,0,"","CUSTOMERS","1001"
35,"Robert Smith",0,1,"+NAME+DOB+PHONE","CUSTOMERS","1002"
35,"Robert Smith",0,1,"+NAME+DOB+EMAIL","CUSTOMERS","1003"
38,"Edward Kusha",0,0,"","CUSTOMERS","1009"

export_csv_entity_report_iterator(csv_column_list: str, flags: int = <SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS: 3734497>) → Iterable[str]

TODO: Add method docstring to export_csv_entity_report_iterator.

export_json_entity_report(flags: int = <SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS: 3734497>) → int

Warning: export_json_entity_report is not recommended for large systems as it does not scale. It is recommended larger systems implement real-time replication to a data warehouse.

The export_json_entity_report method initializes a cursor over a document of exported entities. It is part of the export_json_entity_report, fetch_next, close_export lifecycle of a list of entities to export.

Parameters:

flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS.

Returns:

A handle that identifies the document to be scrolled through using fetch_next.

Return type:

int

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

flags = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    export_handle = sz_engine.export_json_entity_report(flags)
    while True:
        fragment = sz_engine.fetch_next(export_handle)
        if not fragment:
            break
        print(fragment, end="")
    sz_engine.close_export(export_handle)
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

{"RESOLVED_ENTITY":{"ENTITY_ID":1,"ENTITY_NAME":"","FEATURES":{},"RECORD_SUMMARY":[{"DATA_SOURCE":"TEST","RECORD_COUNT":1}],"RECORDS":[{"DATA_SOURCE":"TEST","RECORD_ID":"2","INTERNAL_ID":1,"MATCH_KEY":"","MATCH_LEVEL_CODE":"","ERRULE_CODE":"","FIRST_SEEN_DT":"2024-10-25T17:38:57Z","LAST_SEEN_DT":"2024-10-25T17:38:57Z"}]},"RELATED_ENTITIES":[]}
{"RESOLVED_ENTITY":{"ENTITY_ID":35,"ENTITY_NAME":"Robert Smith","FEATURES":{"ADDRESS":[{"FEAT_DESC":"1515 Adela Lane Las Vegas NV 89111","LIB_FEAT_ID":22,"USAGE_TYPE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"1515 Adela Lane Las Vegas NV 89111","LIB_FEAT_ID":22}]},{"FEAT_DESC":"123 Main Street, Las Vegas NV 89132","LIB_FEAT_ID":3,"USAGE_TYPE":"MAILING","FEAT_DESC_VALUES":[{"FEAT_DESC":"123 Main Street, Las Vegas NV 89132","LIB_FEAT_ID":3}]}],"DOB":[{"FEAT_DESC":"12/11/1978","LIB_FEAT_ID":2,"FEAT_DESC_VALUES":[{"FEAT_DESC":"12/11/1978","LIB_FEAT_ID":2},{"FEAT_DESC":"11/12/1978","LIB_FEAT_ID":21}]}],"EMAIL":[{"FEAT_DESC":"bsmith@work.com","LIB_FEAT_ID":5,"FEAT_DESC_VALUES":[{"FEAT_DESC":"bsmith@work.com","LIB_FEAT_ID":5}]}],"NAME":[{"FEAT_DESC":"Robert Smith","LIB_FEAT_ID":1,"USAGE_TYPE":"PRIMARY","FEAT_DESC_VALUES":[{"FEAT_DESC":"Robert Smith","LIB_FEAT_ID":1},{"FEAT_DESC":"Bob J Smith","LIB_FEAT_ID":38},{"FEAT_DESC":"Bob Smith","LIB_FEAT_ID":20}]}],"PHONE":[{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4,"USAGE_TYPE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4}]},{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4,"USAGE_TYPE":"MOBILE","FEAT_DESC_VALUES":[{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4}]}],"RECORD_TYPE":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10,"FEAT_DESC_VALUES":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10}]}]},"RECORD_SUMMARY":[{"DATA_SOURCE":"CUSTOMERS","RECORD_COUNT":3}],"RECORDS":[{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1001","INTERNAL_ID":35,"MATCH_KEY":"","MATCH_LEVEL_CODE":"","ERRULE_CODE":"","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"},{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1002","INTERNAL_ID":36,"MATCH_KEY":"+NAME+DOB+PHONE","MATCH_LEVEL_CODE":"RESOLVED","ERRULE_CODE":"CNAME_CFF_CEXCL","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"},{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1003","INTERNAL_ID":37,"MATCH_KEY":"+NAME+DOB+EMAIL","MATCH_LEVEL_CODE":"RESOLVED","ERRULE_CODE":"SF1_PNAME_CSTAB","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"}]},"RELATED_ENTITIES":[]}
{"RESOLVED_ENTITY":{"ENTITY_ID":38,"ENTITY_NAME":"Edward Kusha","FEATURES":{"ADDRESS":[{"FEAT_DESC":"1304 Poppy Hills Dr Blacklick OH 43004","LIB_FEAT_ID":46,"USAGE_TYPE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"1304 Poppy Hills Dr Blacklick OH 43004","LIB_FEAT_ID":46}]}],"DOB":[{"FEAT_DESC":"3/1/1970","LIB_FEAT_ID":45,"FEAT_DESC_VALUES":[{"FEAT_DESC":"3/1/1970","LIB_FEAT_ID":45}]}],"EMAIL":[{"FEAT_DESC":"Kusha123@hmail.com","LIB_FEAT_ID":48,"FEAT_DESC_VALUES":[{"FEAT_DESC":"Kusha123@hmail.com","LIB_FEAT_ID":48}]}],"NAME":[{"FEAT_DESC":"Edward Kusha","LIB_FEAT_ID":44,"USAGE_TYPE":"PRIMARY","FEAT_DESC_VALUES":[{"FEAT_DESC":"Edward Kusha","LIB_FEAT_ID":44}]}],"RECORD_TYPE":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10,"FEAT_DESC_VALUES":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10}]}],"SSN":[{"FEAT_DESC":"294-66-9999","LIB_FEAT_ID":47,"FEAT_DESC_VALUES":[{"FEAT_DESC":"294-66-9999","LIB_FEAT_ID":47}]}]},"RECORD_SUMMARY":[{"DATA_SOURCE":"CUSTOMERS","RECORD_COUNT":1}],"RECORDS":[{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1009","INTERNAL_ID":38,"MATCH_KEY":"","MATCH_LEVEL_CODE":"","ERRULE_CODE":"","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"}]},"RELATED_ENTITIES":[]}

export_json_entity_report_iterator(flags: int = <SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS: 3734497>) → Iterable[str]

TODO: Add method docstring to export_json_entity_report_iterator.

fetch_next(export_handle: int) → str

The fetch_next method is used to scroll through an exported document one entity at a time. Successive calls of fetch_next will export successive rows of entity data until there is no more. It is part of the export_json_entity_report or export_json_entity_report, fetch_next, close_export lifecycle of a list of exported entities.

Parameters:

export_handle (int) – A handle created by export_json_entity_report or export_json_entity_report.

Returns:

TODO:

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

flags = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    export_handle = sz_engine.export_json_entity_report(flags)
    while True:
        fragment = sz_engine.fetch_next(export_handle)
        if not fragment:
            break
        print(fragment, end="")
    sz_engine.close_export(export_handle)
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

{"RESOLVED_ENTITY":{"ENTITY_ID":1,"ENTITY_NAME":"","FEATURES":{},"RECORD_SUMMARY":[{"DATA_SOURCE":"TEST","RECORD_COUNT":1}],"RECORDS":[{"DATA_SOURCE":"TEST","RECORD_ID":"2","INTERNAL_ID":1,"MATCH_KEY":"","MATCH_LEVEL_CODE":"","ERRULE_CODE":"","FIRST_SEEN_DT":"2024-10-25T17:38:57Z","LAST_SEEN_DT":"2024-10-25T17:38:57Z"}]},"RELATED_ENTITIES":[]}
{"RESOLVED_ENTITY":{"ENTITY_ID":35,"ENTITY_NAME":"Robert Smith","FEATURES":{"ADDRESS":[{"FEAT_DESC":"1515 Adela Lane Las Vegas NV 89111","LIB_FEAT_ID":22,"USAGE_TYPE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"1515 Adela Lane Las Vegas NV 89111","LIB_FEAT_ID":22}]},{"FEAT_DESC":"123 Main Street, Las Vegas NV 89132","LIB_FEAT_ID":3,"USAGE_TYPE":"MAILING","FEAT_DESC_VALUES":[{"FEAT_DESC":"123 Main Street, Las Vegas NV 89132","LIB_FEAT_ID":3}]}],"DOB":[{"FEAT_DESC":"12/11/1978","LIB_FEAT_ID":2,"FEAT_DESC_VALUES":[{"FEAT_DESC":"12/11/1978","LIB_FEAT_ID":2},{"FEAT_DESC":"11/12/1978","LIB_FEAT_ID":21}]}],"EMAIL":[{"FEAT_DESC":"bsmith@work.com","LIB_FEAT_ID":5,"FEAT_DESC_VALUES":[{"FEAT_DESC":"bsmith@work.com","LIB_FEAT_ID":5}]}],"NAME":[{"FEAT_DESC":"Robert Smith","LIB_FEAT_ID":1,"USAGE_TYPE":"PRIMARY","FEAT_DESC_VALUES":[{"FEAT_DESC":"Robert Smith","LIB_FEAT_ID":1},{"FEAT_DESC":"Bob J Smith","LIB_FEAT_ID":38},{"FEAT_DESC":"Bob Smith","LIB_FEAT_ID":20}]}],"PHONE":[{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4,"USAGE_TYPE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4}]},{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4,"USAGE_TYPE":"MOBILE","FEAT_DESC_VALUES":[{"FEAT_DESC":"702-919-1300","LIB_FEAT_ID":4}]}],"RECORD_TYPE":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10,"FEAT_DESC_VALUES":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10}]}]},"RECORD_SUMMARY":[{"DATA_SOURCE":"CUSTOMERS","RECORD_COUNT":3}],"RECORDS":[{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1001","INTERNAL_ID":35,"MATCH_KEY":"","MATCH_LEVEL_CODE":"","ERRULE_CODE":"","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"},{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1002","INTERNAL_ID":36,"MATCH_KEY":"+NAME+DOB+PHONE","MATCH_LEVEL_CODE":"RESOLVED","ERRULE_CODE":"CNAME_CFF_CEXCL","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"},{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1003","INTERNAL_ID":37,"MATCH_KEY":"+NAME+DOB+EMAIL","MATCH_LEVEL_CODE":"RESOLVED","ERRULE_CODE":"SF1_PNAME_CSTAB","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"}]},"RELATED_ENTITIES":[]}
{"RESOLVED_ENTITY":{"ENTITY_ID":38,"ENTITY_NAME":"Edward Kusha","FEATURES":{"ADDRESS":[{"FEAT_DESC":"1304 Poppy Hills Dr Blacklick OH 43004","LIB_FEAT_ID":46,"USAGE_TYPE":"HOME","FEAT_DESC_VALUES":[{"FEAT_DESC":"1304 Poppy Hills Dr Blacklick OH 43004","LIB_FEAT_ID":46}]}],"DOB":[{"FEAT_DESC":"3/1/1970","LIB_FEAT_ID":45,"FEAT_DESC_VALUES":[{"FEAT_DESC":"3/1/1970","LIB_FEAT_ID":45}]}],"EMAIL":[{"FEAT_DESC":"Kusha123@hmail.com","LIB_FEAT_ID":48,"FEAT_DESC_VALUES":[{"FEAT_DESC":"Kusha123@hmail.com","LIB_FEAT_ID":48}]}],"NAME":[{"FEAT_DESC":"Edward Kusha","LIB_FEAT_ID":44,"USAGE_TYPE":"PRIMARY","FEAT_DESC_VALUES":[{"FEAT_DESC":"Edward Kusha","LIB_FEAT_ID":44}]}],"RECORD_TYPE":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10,"FEAT_DESC_VALUES":[{"FEAT_DESC":"PERSON","LIB_FEAT_ID":10}]}],"SSN":[{"FEAT_DESC":"294-66-9999","LIB_FEAT_ID":47,"FEAT_DESC_VALUES":[{"FEAT_DESC":"294-66-9999","LIB_FEAT_ID":47}]}]},"RECORD_SUMMARY":[{"DATA_SOURCE":"CUSTOMERS","RECORD_COUNT":1}],"RECORDS":[{"DATA_SOURCE":"CUSTOMERS","RECORD_ID":"1009","INTERNAL_ID":38,"MATCH_KEY":"","MATCH_LEVEL_CODE":"","ERRULE_CODE":"","FIRST_SEEN_DT":"2024-10-25T17:39:00Z","LAST_SEEN_DT":"2024-10-25T17:39:00Z"}]},"RELATED_ENTITIES":[]}

find_interesting_entities_by_entity_id(entity_id: int, flags: int = 0) → str

TODO: Document find_interesting_entities_by_entity_id()

find_interesting_entities_by_record_id(data_source_code: str, record_id: str, flags: int = 0) → str

TODO: Document find_interesting_entities_by_record_id()

find_network_by_entity_id(entity_ids: ~typing.List[int], max_degrees: int, build_out_degrees: int, build_out_max_entities: int, flags: int = <SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS: 8589946880>) → str

The find_network_by_entity_id method finds all entities surrounding a requested set of entities. This includes the requested entities, paths between them, and relations to other nearby entities. Returns a JSON document that identifies the path between the each set of search entities (if the path exists), and the information for the entities in the path.

Parameters:

• entity_ids (list(int)) – The entity IDs to find the network between.

• max_degrees (int) – The maximum number of degrees in paths between search entities.

• build_out_degrees (int) – The number of degrees of relationships to show around each search entity.

• build_out_max_entities (int) – The maximum number of entities to return in the discovered network.

• flags (int, optional) – The maximum number of entities to return in the discovered network. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

build_out_degrees = 1
entity_list = [1, 4]
flags = SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS
max_degrees = 2
max_entities = 10

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.find_network_by_entity_id(entity_list, max_degrees, build_out_degrees, max_entities, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "ENTITY_PATHS": [
        {
            "START_ENTITY_ID": 1,
            "END_ENTITY_ID": 35,
            "ENTITIES": []
        }
    ],
    "ENTITY_NETWORK_LINKS": [],
    "ENTITIES": [
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 1,
                "ENTITY_NAME": "",
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "TEST",
                        "RECORD_COUNT": 1
                    }
                ]
            }
        },
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 35,
                "ENTITY_NAME": "Robert Smith",
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 3
                    }
                ]
            }
        }
    ]
}

find_network_by_record_id(record_keys: ~typing.List[~typing.Tuple[str, str]], max_degrees: int, build_out_degrees: int, build_out_max_entities: int, flags: int = <SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS: 8589946880>) → str

The find_network_by_record_id method finds all entities surrounding a requested set of entities by their RECORD_ID values. This includes the requested entities, paths between them, and relations to other nearby entities. Returns a JSON document that identifies the path between the each set of search entities (if the path exists), and the information for the entities in the path.

Parameters:

• record_keys (list(tuple(str, str))) – The data source codes and record IDs to find the network between.

• max_degrees (int) – The maximum number of degrees in paths between search entities.

• build_out_degrees (int) – The number of degrees of relationships to show around each search entity.

• build_out_max_entities (int) – The maximum number of entities to return in the discovered network.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

build_out_degrees = 1
flags = SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS
max_degrees = 2
max_entities = 10
record_list = [("CUSTOMERS", "1001"), ("CUSTOMERS", "1009")]

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.find_network_by_record_id(record_list, max_degrees, build_out_degrees, max_entities, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "ENTITY_PATHS": [
        {
            "START_ENTITY_ID": 35,
            "END_ENTITY_ID": 38,
            "ENTITIES": []
        }
    ],
    "ENTITY_NETWORK_LINKS": [],
    "ENTITIES": [
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 35,
                "ENTITY_NAME": "Robert Smith",
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 3
                    }
                ]
            }
        },
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 38,
                "ENTITY_NAME": "Edward Kusha",
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 1
                    }
                ]
            }
        }
    ]
}

find_path_by_entity_id(start_entity_id: int, end_entity_id: int, max_degrees: int, avoid_entity_ids: ~typing.List[int] | None = None, required_data_sources: ~typing.List[str] | None = None, flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>) → str

The find_path_by_entity_id method finds the most efficient relationship between two entities path based on the parameters and returns a JSON document with an ENTITY_PATHS section that details the path between the entities. The ENTITIES sections details information on the entities. Paths are found using known relationships with other entities. Paths are found using known relationships with other entities.

Parameters:

• start_entity_id (int) – The entity ID for the starting entity of the search path.

• end_entity_id (int) – The entity ID for the ending entity of the search path.

• max_degrees (int) – The maximum number of degrees in paths between search entities.

• avoid_entity_ids (list(int), optional) – The entity IDs to avoid when finding a path.

• required_data_sources (list(str), optional) – The data source code(s) that must be in a path.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

Returns:

A JSON document with an ENTITY_PATHS section that details the path between the entities.

Return type:

str

Raises:

Example:

from typing import List

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

avoid_entity_ids: List[int] = []
end_entity_id = 4
flags = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS
max_degrees = 2
required_data_sources: List[str] = []
start_entity_id = 1

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.find_path_by_entity_id(
        start_entity_id,
        end_entity_id,
        max_degrees,
        avoid_entity_ids,
        required_data_sources,
        flags,
    )
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "ENTITY_PATHS": [
        {
            "START_ENTITY_ID": 1,
            "END_ENTITY_ID": 35,
            "ENTITIES": []
        }
    ],
    "ENTITY_PATH_LINKS": [],
    "ENTITIES": [
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 1,
                "ENTITY_NAME": "",
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "TEST",
                        "RECORD_COUNT": 1
                    }
                ]
            }
        },
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 35,
                "ENTITY_NAME": "Robert Smith",
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 3
                    }
                ]
            }
        }
    ]
}

find_path_by_record_id(start_data_source_code: str, start_record_id: str, end_data_source_code: str, end_record_id: str, max_degrees: int, avoid_record_keys: ~typing.List[~typing.Tuple[str, str]] | None = None, required_data_sources: ~typing.List[str] | None = None, flags: int = <SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS: 1073754112>) → str

The find_path_by_record_id method finds the most efficient relationship between two entities path based on the parameters by RECORD_ID values and returns a JSON document with an ENTITY_PATHS section that details the path between the entities. The ENTITIES sections details information on the entities. Paths are found using known relationships with other entities. The entities are identified by starting and ending records.

Parameters:

• start_data_source_code (str) – Identifies the provenance of the record for the starting entity of the search path.

• start_record_id (str) – The unique identifier within the records of the same data source for the starting entity of the search path.

• end_data_source_code (str) – Identifies the provenance of the record for the ending entity of the search path.

• end_record_id (str) – The unique identifier within the records of the same data source for the ending entity of the search path.

• max_degrees (int) – The maximum number of degrees in paths between search entities.

• avoid_record_keys (list(tuple(str, str)), optional) – The data source codes and record IDs to avoid when finding a path.

• required_data_sources (list(str), optional) – The data source code(s) that must be in a path.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

from typing import List, Tuple

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

avoid_record_keys: List[Tuple[str, str]] = []
end_data_source_code = "CUSTOMERS"
end_record_id = "1009"
flags = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS
max_degrees = 2
required_data_sources: List[str] = []
start_data_source_code = "CUSTOMERS"
start_record_id = "1001"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.find_path_by_record_id(
        start_data_source_code,
        start_record_id,
        end_data_source_code,
        end_record_id,
        max_degrees,
        avoid_record_keys,
        required_data_sources,
        flags,
    )
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "ENTITY_PATHS": [
        {
            "START_ENTITY_ID": 35,
            "END_ENTITY_ID": 38,
            "ENTITIES": []
        }
    ],
    "ENTITY_PATH_LINKS": [],
    "ENTITIES": [
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 35,
                "ENTITY_NAME": "Robert Smith",
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 3
                    }
                ]
            }
        },
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 38,
                "ENTITY_NAME": "Edward Kusha",
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 1
                    }
                ]
            }
        }
    ]
}

get_active_config_id() → int

The get_active_config_id method returns the identifier of the currently active Senzing engine configuration.

Returns:

The identifier of the active Senzing Engine configuration.

Return type:

int

Raises:

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.get_active_config_id()
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

4030462317

get_entity_by_entity_id(entity_id: int, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>) → str

The get_entity_by_entity_id method returns entity data based on the ID of a resolved identity.

Parameters:

• entity_id (int) – The unique identifier of an entity.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

entity_id = 1
flags = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.get_entity_by_entity_id(entity_id, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "RESOLVED_ENTITY": {
        "ENTITY_ID": 1,
        "ENTITY_NAME": "",
        "FEATURES": {},
        "RECORD_SUMMARY": [
            {
                "DATA_SOURCE": "TEST",
                "RECORD_COUNT": 1
            }
        ],
        "RECORDS": [
            {
                "DATA_SOURCE": "TEST",
                "RECORD_ID": "2",
                "INTERNAL_ID": 1,
                "MATCH_KEY": "",
                "MATCH_LEVEL_CODE": "",
                "ERRULE_CODE": "",
                "FIRST_SEEN_DT": "YYYY-MM-DDThh:mm:ssZ",
                "LAST_SEEN_DT": "YYYY-MM-DDThh:mm:ssZ"
            }
        ]
    },
    "RELATED_ENTITIES": []
}

get_entity_by_record_id(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>) → str

The get_entity_by_record_id method returns entity data based on the ID of a record which is a member of the entity.

Parameters:

• data_source_code (str) – Identifies the provenance of the data.

• record_id (str) – The unique identifier within the records of the same data source.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

data_source_code = "CUSTOMERS"
flags = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS
record_id = "1001"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.get_entity_by_record_id(data_source_code, record_id, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "RESOLVED_ENTITY": {
        "ENTITY_ID": 35,
        "ENTITY_NAME": "Robert Smith",
        "FEATURES": {
            "ADDRESS": [
                {
                    "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                    "LIB_FEAT_ID": 22,
                    "USAGE_TYPE": "HOME",
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                            "LIB_FEAT_ID": 22
                        }
                    ]
                },
                {
                    "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                    "LIB_FEAT_ID": 3,
                    "USAGE_TYPE": "MAILING",
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                            "LIB_FEAT_ID": 3
                        }
                    ]
                }
            ],
            "DOB": [
                {
                    "FEAT_DESC": "12/11/1978",
                    "LIB_FEAT_ID": 2,
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "12/11/1978",
                            "LIB_FEAT_ID": 2
                        },
                        {
                            "FEAT_DESC": "11/12/1978",
                            "LIB_FEAT_ID": 21
                        }
                    ]
                }
            ],
            "EMAIL": [
                {
                    "FEAT_DESC": "bsmith@work.com",
                    "LIB_FEAT_ID": 5,
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "bsmith@work.com",
                            "LIB_FEAT_ID": 5
                        }
                    ]
                }
            ],
            "NAME": [
                {
                    "FEAT_DESC": "Robert Smith",
                    "LIB_FEAT_ID": 1,
                    "USAGE_TYPE": "PRIMARY",
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "Robert Smith",
                            "LIB_FEAT_ID": 1
                        },
                        {
                            "FEAT_DESC": "Bob J Smith",
                            "LIB_FEAT_ID": 38
                        },
                        {
                            "FEAT_DESC": "Bob Smith",
                            "LIB_FEAT_ID": 20
                        }
                    ]
                }
            ],
            "PHONE": [
                {
                    "FEAT_DESC": "702-919-1300",
                    "LIB_FEAT_ID": 4,
                    "USAGE_TYPE": "HOME",
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 4
                        }
                    ]
                },
                {
                    "FEAT_DESC": "702-919-1300",
                    "LIB_FEAT_ID": 4,
                    "USAGE_TYPE": "MOBILE",
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 4
                        }
                    ]
                }
            ],
            "RECORD_TYPE": [
                {
                    "FEAT_DESC": "PERSON",
                    "LIB_FEAT_ID": 10,
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "PERSON",
                            "LIB_FEAT_ID": 10
                        }
                    ]
                }
            ]
        },
        "RECORD_SUMMARY": [
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_COUNT": 3
            }
        ],
        "RECORDS": [
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1001",
                "INTERNAL_ID": 35,
                "MATCH_KEY": "",
                "MATCH_LEVEL_CODE": "",
                "ERRULE_CODE": "",
                "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
            },
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1002",
                "INTERNAL_ID": 36,
                "MATCH_KEY": "+NAME+DOB+PHONE",
                "MATCH_LEVEL_CODE": "RESOLVED",
                "ERRULE_CODE": "CNAME_CFF_CEXCL",
                "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
            },
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1003",
                "INTERNAL_ID": 37,
                "MATCH_KEY": "+NAME+DOB+EMAIL",
                "MATCH_LEVEL_CODE": "RESOLVED",
                "ERRULE_CODE": "SF1_PNAME_CSTAB",
                "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
            }
        ]
    },
    "RELATED_ENTITIES": []
}

get_record(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_JSON_DATA: 65536>) → str

The get_record method returns a JSON document of a single record from the Senzing repository. Can be called as many times as desired and from multiple threads at the same time.

Parameters:

• data_source_code (str) – Identifies the provenance of the data.

• record_id (str) – The unique identifier within the records of the same data source.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS.

Returns:

A JSON document of a single record.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

data_source_code = "CUSTOMERS"
flags = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS
record_id = "1001"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.get_record(data_source_code, record_id, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "DATA_SOURCE": "CUSTOMERS",
    "RECORD_ID": "1001",
    "JSON_DATA": {
        "DATA_SOURCE": "CUSTOMERS",
        "RECORD_ID": "1001",
        "RECORD_TYPE": "PERSON",
        "PRIMARY_NAME_LAST": "Smith",
        "PRIMARY_NAME_FIRST": "Robert",
        "DATE_OF_BIRTH": "12/11/1978",
        "ADDR_TYPE": "MAILING",
        "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132",
        "PHONE_TYPE": "HOME",
        "PHONE_NUMBER": "702-919-1300",
        "EMAIL_ADDRESS": "bsmith@work.com",
        "DATE": "1/2/18",
        "STATUS": "Active",
        "AMOUNT": "100"
    }
}

get_redo_record() → str

The get_redo_record method returns the next internally queued redo record from the Senzing repository. The process_redo_record method is called to process the redo record retrieved by get_redo_record.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.get_redo_record()
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "REASON": "deferred delete",
    "DATA_SOURCE": "CUSTOMERS",
    "RECORD_ID": "1001",
    "DSRC_ACTION": "X"
}

get_stats() → str

The get_stats method retrieves workload statistics for the current process. These statistics will automatically reset after retrieval.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.get_stats()
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "workload": {
        "apiVersion": "4.0.0.24289",
        "loadedRecords": 6,
        "addedRecords": 20,
        "bulkAddedRecords": 0,
        "optimizedOut": 3,
        "optimizedOutSkipped": 6,
        "newObsEnt": 18,
        "obsEntHashSame": 4,
        "obsEntHashDiff": 1,
        "partiallyResolved": 0,
        "deletedRecords": 15,
        "changeDeletes": 4,
        "reevaluations": 4,
        "repairedEntities": 6,
        "duration": 96,
        "retries": 0,
        "candidates": 11,
        "actualAmbiguousTest": 0,
        "cachedAmbiguousTest": 0,
        "libFeatCacheHit": 706,
        "libFeatCacheMiss": 589,
        "resFeatStatCacheHit": 6211,
        "resFeatStatCacheMiss": 1052,
        "libFeatInsert": 28,
        "resFeatStatInsert": 28,
        "resFeatStatUpdateAttempt": 522,
        "resFeatStatUpdateFail": 0,
        "unresolveTest": 4,
        "abortedUnresolve": 0,
        "lockWaits": {
            "maxRefreshLocksMS": 0,
            "totalRefreshLocksMS": 0,
            "countRefreshLocks": 0
        },
        "unresolveTriggers": {
            "normalResolve": 0,
            "update": 0,
            "relLink": 0,
            "extensiveResolve": 4,
            "ambiguousNoResolve": 0,
            "ambiguousMultiResolve": 0
        },
        "reresolveTriggers": {
            "abortRetry": 0,
            "unresolveMovement": 0,
            "multipleResolvableCandidates": 0,
            "resolveNewFeatures": 7,
            "newFeatureFTypes": [
                {
                    "ADDRESS": 5
                },
                {
                    "ADDR_KEY": 5
                },
                {
                    "DOB": 5
                },
                {
                    "NAME": 7
                },
                {
                    "NAMEADDR_KEY": 5
                },
                {
                    "NAMEDATE_KEY": 7
                },
                {
                    "NAMEPHONE_KEY": 5
                },
                {
                    "NAMEREGION_KEY": 5
                },
                {
                    "NAME_KEY": 7
                },
                {
                    "PHONE": 5
                }
            ]
        },
        "reresolveSkipped": 1,
        "filteredObsFeat": 0,
        "expressedFeatureCalls": [
            {
                "EFCALL_ID": 1,
                "EFUNC_CODE": "PHONE_HASHER",
                "numCalls": 20
            },
            {
                "EFCALL_ID": 7,
                "EFUNC_CODE": "NAME_HASHER",
                "numCalls": 45
            },
            {
                "EFCALL_ID": 9,
                "EFUNC_CODE": "ADDR_HASHER",
                "numCalls": 21
            },
            {
                "EFCALL_ID": 10,
                "EFUNC_CODE": "EXPRESS_BOM",
                "numCalls": 1
            },
            {
                "EFCALL_ID": 16,
                "EFUNC_CODE": "EXPRESS_ID",
                "numCalls": 1
            },
            {
                "EFCALL_ID": 34,
                "EFUNC_CODE": "FEAT_BUILDER",
                "numCalls": 19
            },
            {
                "EFCALL_ID": 92,
                "EFUNC_CODE": "NAME_HASHER",
                "numCalls": 21
            },
            {
                "EFCALL_ID": 94,
                "EFUNC_CODE": "NAME_HASHER",
                "numCalls": 45
            },
            {
                "EFCALL_ID": 95,
                "EFUNC_CODE": "NAME_HASHER",
                "numCalls": 2
            },
            {
                "EFCALL_ID": 96,
                "EFUNC_CODE": "NAME_HASHER",
                "numCalls": 45
            },
            {
                "EFCALL_ID": 97,
                "EFUNC_CODE": "NAME_HASHER",
                "numCalls": 45
            },
            {
                "EFCALL_ID": 98,
                "EFUNC_CODE": "NAME_HASHER",
                "numCalls": 45
            }
        ],
        "expressedFeaturesCreated": [
            {
                "ADDR_KEY": 42
            },
            {
                "EMAIL_KEY": 19
            },
            {
                "ID_KEY": 1
            },
            {
                "NAMEADDR_KEY": 54
            },
            {
                "NAMEDATE_KEY": 99
            },
            {
                "NAMEID_KEY": 2
            },
            {
                "NAMEPHONE_KEY": 25
            },
            {
                "NAMEREGION_KEY": 54
            },
            {
                "NAME_KEY": 35
            },
            {
                "PHONE_KEY": 20
            },
            {
                "SEARCH_KEY": 1
            }
        ],
        "scoredPairs": [
            {
                "ADDRESS": 8
            },
            {
                "DOB": 18
            },
            {
                "EMAIL": 5
            },
            {
                "NAME": 29
            },
            {
                "PHONE": 9
            },
            {
                "RECORD_TYPE": 10
            }
        ],
        "cacheHit": [
            {
                "DOB": 1
            },
            {
                "NAME": 3
            }
        ],
        "cacheMiss": [
            {
                "ADDRESS": 8
            },
            {
                "DOB": 17
            },
            {
                "EMAIL": 5
            },
            {
                "NAME": 26
            },
            {
                "PHONE": 9
            }
        ],
        "redoTriggers": [
            {
                "DEFERRED_DELETE": 6
            }
        ],
        "latchContention": [],
        "highContentionFeat": [],
        "highContentionResEnt": [],
        "genericDetect": [],
        "candidateBuilders": [
            {
                "ADDR_KEY": 34
            },
            {
                "DOB": 36
            },
            {
                "EMAIL_KEY": 32
            },
            {
                "ID_KEY": 1
            },
            {
                "NAMEADDR_KEY": 34
            },
            {
                "NAMEDATE_KEY": 36
            },
            {
                "NAMEID_KEY": 1
            },
            {
                "NAMEPHONE_KEY": 33
            },
            {
                "NAMEREGION_KEY": 34
            },
            {
                "NAME_KEY": 37
            },
            {
                "PHONE_KEY": 33
            },
            {
                "SEARCH_KEY": 1
            },
            {
                "SSN": 1
            }
        ],
        "suppressedCandidateBuilders": [],
        "suppressedScoredFeatureType": [],
        "suppressedCandidateBuildersForReresolve": [],
        "suppressedScoredFeatureTypeForReresolve": [],
        "suppressedDisclosedRelationshipDomainCount": 0,
        "corruptEntityTestDiagnosis": {
            "corruptionTypes": 0
        },
        "threadState": {
            "active": 0,
            "idle": 8,
            "governorContention": 0,
            "sqlExecuting": 0,
            "loader": 0,
            "resolver": 0,
            "scoring": 0,
            "dataLatchContention": 0,
            "obsEntContention": 0,
            "resEntContention": 0
        },
        "systemResources": {
            "initResources": [
                {
                    "physicalCores": 16
                },
                {
                    "logicalCores": 16
                },
                {
                    "totalMemory": "62.6GB"
                },
                {
                    "availableMemory": "52.7GB"
                }
            ],
            "currResources": [
                {
                    "availableMemory": "48.5GB"
                },
                {
                    "activeThreads": 0
                },
                {
                    "workerThreads": 8
                },
                {
                    "systemLoad": [
                        {
                            "cpuUser": 5.160142
                        },
                        {
                            "cpuSystem": 3.932384
                        },
                        {
                            "cpuIdle": 90.800713
                        },
                        {
                            "cpuWait": 0.071174
                        },
                        {
                            "cpuSoftIrq": 0.035587
                        }
                    ]
                }
            ]
        }
    }
}

get_virtual_entity_by_record_id(record_keys: ~typing.List[~typing.Tuple[str, str]], flags: int = <SzEngineFlags.SZ_ENTITY_CORE_FLAGS: 63488>) → str

The get_virtual_entity_by_record_id method creates a view of a virtual entity using a list of existing loaded records. The virtual entity is composed of only those records and their features. Entity resolution is not performed.

Parameters:

• record_keys (list(tuple(str, str))) – The data source codes and record IDs identifying records to create the virtual entity from.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

flags = SzEngineFlags.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS
record_list = [
    ("CUSTOMERS", "1001"),
    ("CUSTOMERS", "1002"),
]

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.get_virtual_entity_by_record_id(record_list, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "RESOLVED_ENTITY": {
        "ENTITY_ID": 35,
        "ENTITY_NAME": "Robert Smith",
        "FEATURES": {
            "ADDRESS": [
                {
                    "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                    "LIB_FEAT_ID": 22,
                    "USAGE_TYPE": "HOME",
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                            "LIB_FEAT_ID": 22
                        }
                    ]
                },
                {
                    "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                    "LIB_FEAT_ID": 3,
                    "USAGE_TYPE": "MAILING",
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                            "LIB_FEAT_ID": 3
                        }
                    ]
                }
            ],
            "DOB": [
                {
                    "FEAT_DESC": "12/11/1978",
                    "LIB_FEAT_ID": 2,
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "12/11/1978",
                            "LIB_FEAT_ID": 2
                        },
                        {
                            "FEAT_DESC": "11/12/1978",
                            "LIB_FEAT_ID": 21
                        }
                    ]
                }
            ],
            "EMAIL": [
                {
                    "FEAT_DESC": "bsmith@work.com",
                    "LIB_FEAT_ID": 5,
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "bsmith@work.com",
                            "LIB_FEAT_ID": 5
                        }
                    ]
                }
            ],
            "NAME": [
                {
                    "FEAT_DESC": "Robert Smith",
                    "LIB_FEAT_ID": 1,
                    "USAGE_TYPE": "PRIMARY",
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "Robert Smith",
                            "LIB_FEAT_ID": 1
                        },
                        {
                            "FEAT_DESC": "Bob Smith",
                            "LIB_FEAT_ID": 20
                        }
                    ]
                }
            ],
            "PHONE": [
                {
                    "FEAT_DESC": "702-919-1300",
                    "LIB_FEAT_ID": 4,
                    "USAGE_TYPE": "HOME",
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 4
                        }
                    ]
                },
                {
                    "FEAT_DESC": "702-919-1300",
                    "LIB_FEAT_ID": 4,
                    "USAGE_TYPE": "MOBILE",
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 4
                        }
                    ]
                }
            ],
            "RECORD_TYPE": [
                {
                    "FEAT_DESC": "PERSON",
                    "LIB_FEAT_ID": 10,
                    "FEAT_DESC_VALUES": [
                        {
                            "FEAT_DESC": "PERSON",
                            "LIB_FEAT_ID": 10
                        }
                    ]
                }
            ]
        },
        "RECORD_SUMMARY": [
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_COUNT": 2
            }
        ],
        "RECORDS": [
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1001",
                "INTERNAL_ID": 35,
                "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
            },
            {
                "DATA_SOURCE": "CUSTOMERS",
                "RECORD_ID": "1002",
                "INTERNAL_ID": 36,
                "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
            }
        ]
    }
}

help(method_name: str = '') → str

Return the help for a particular message.

Parameters:

method_name (str) – The name of the method. (e.g. “init”). If empty, a list of methods and descriptions is returned.

Returns:

The Help information about the requested method

Return type:

str

how_entity_by_entity_id(entity_id: int, flags: int = <SzEngineFlags.SZ_INCLUDE_FEATURE_SCORES: 67108864>) → str

The how_entity_by_entity_id method determines and details steps-by-step how records resolved to a single entity.

In most cases, how provides more detailed information than why as the resolution is detailed step-by-step.

Parameters:

• entity_id (int) – The unique identifier of an entity.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

entity_id = 1
flags = SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.how_entity_by_entity_id(entity_id, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "HOW_RESULTS": {
        "RESOLUTION_STEPS": [],
        "FINAL_STATE": {
            "NEED_REEVALUATION": 0,
            "VIRTUAL_ENTITIES": [
                {
                    "VIRTUAL_ENTITY_ID": "V1",
                    "MEMBER_RECORDS": [
                        {
                            "INTERNAL_ID": 1,
                            "RECORDS": [
                                {
                                    "DATA_SOURCE": "TEST",
                                    "RECORD_ID": "2"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

initialize(instance_name: str, settings: str | Dict[Any, Any], config_id: int | None = None, verbose_logging: int = 0) → None

Null function in the sz-sdk-python-grpc implementation.

preprocess_record(record_definition: str, flags: int = <SzEngineFlags.SZ_ENTITY_INCLUDE_RECORD_JSON_DATA: 65536>) → str

The preprocess_record method tests adding a record into the Senzing datastore.

Parameters:

• record_definition (str) – A JSON document containing the record to be tested.

• flags (int, optional) – Flags used to control information returned. Defaults to 0.

Returns:

A JSON document containing metadata as specified by the flags.

Return type:

str

Raises:

Example:

import json

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

flags = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS
record_definition = json.dumps(
    {
        "RECORD_TYPE": "PERSON",
        "PRIMARY_NAME_LAST": "Smith",
        "PRIMARY_NAME_FIRST": "Robert",
        "DATE_OF_BIRTH": "12/11/1978",
        "ADDR_TYPE": "MAILING",
        "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132",
        "PHONE_TYPE": "HOME",
        "PHONE_NUMBER": "702-919-1300",
        "EMAIL_ADDRESS": "bsmith@work.com",
        "DATE": "1/2/18",
        "STATUS": "Active",
        "AMOUNT": "100",
    }
)

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.preprocess_record(record_definition, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "JSON_DATA": {
        "RECORD_TYPE": "PERSON",
        "PRIMARY_NAME_LAST": "Smith",
        "PRIMARY_NAME_FIRST": "Robert",
        "DATE_OF_BIRTH": "12/11/1978",
        "ADDR_TYPE": "MAILING",
        "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132",
        "PHONE_TYPE": "HOME",
        "PHONE_NUMBER": "702-919-1300",
        "EMAIL_ADDRESS": "bsmith@work.com",
        "DATE": "1/2/18",
        "STATUS": "Active",
        "AMOUNT": "100"
    }
}

prime_engine() → None

Null function in the sz-sdk-python-grpc implementation.

process_redo_record(redo_record: str, flags: int = 0) → str

The process_redo_record method is called to process the redo record retrieved by get_redo_record.

Parameters:

• redo_record (str) – A redo record retrieved from get_redo_record.

• flags (int, optional) – Flags used to control information returned. Defaults to 0.

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

flags = SzEngineFlags.SZ_WITH_INFO

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    while True:
        redo_record = sz_engine.get_redo_record()
        if not redo_record:
            break
        result = sz_engine.process_redo_record(redo_record, flags)
        print(result)
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
  "DATA_SOURCE": "CUSTOMERS",
  "RECORD_ID": "2207",
  "AFFECTED_ENTITIES": [
    {
      "ENTITY_ID": 305
    }
  ],
  "INTERESTING_ENTITIES": {
    "ENTITIES": []
  }
}

reevaluate_entity(entity_id: int, flags: int = 0) → str

The reevaluate_entity method reevaluates the specified entity.

Parameters:

• entity_id (int) – The unique identifier of an entity.

• flags (int, optional) – Flags used to control information returned. Defaults to 0.

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

entity_id = 1
flags = SzEngineFlags.SZ_WITH_INFO

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.reevaluate_entity(entity_id, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "DATA_SOURCE": "TEST",
    "RECORD_ID": "2",
    "AFFECTED_ENTITIES": [
        {
            "ENTITY_ID": 1
        }
    ],
    "INTERESTING_ENTITIES": {
        "ENTITIES": []
    }
}

reevaluate_record(data_source_code: str, record_id: str, flags: int = 0) → str

The reevaluate_record method reevaluates a specific record.

Parameters:

• data_source_code (str) – Identifies the provenance of the data.

• record_id (str) – The unique identifier within the records of the same data source.

• flags (int, optional) – Flags used to control information returned. Defaults to 0.

Returns:

If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty string.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

data_source_code = "CUSTOMERS"
flags = SzEngineFlags.SZ_WITH_INFO
record_id = "1001"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.reevaluate_record(data_source_code, record_id, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "DATA_SOURCE": "CUSTOMERS",
    "RECORD_ID": "1001",
    "AFFECTED_ENTITIES": [
        {
            "ENTITY_ID": 35
        }
    ],
    "INTERESTING_ENTITIES": {
        "ENTITIES": []
    }
}

reinitialize(config_id: int) → None

search_by_attributes(attributes: str, flags: int = <SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_ALL: 67123215>, search_profile: str = '') → str

The search_by_attributes method retrieves entity data based on a user-specified set of entity attributes.

Parameters:

• attributes (str) – A JSON document with the attribute data to search for.

• flags (int, optional) – _description_. Defaults to SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS.

• search_profile (str) – The name of a configured search profile. Defaults to SEARCH.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import json

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

attributes = json.dumps({"NAME_FULL": "Bob Smith", "EMAIL_ADDRESS": "bsmith@work.com"})
flags = SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.search_by_attributes(attributes, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.
{
    "RESOLVED_ENTITIES": [
        {
            "MATCH_INFO": {
                "MATCH_LEVEL_CODE": "RESOLVED",
                "MATCH_KEY": "+NAME+EMAIL",
                "ERRULE_CODE": "SF1_CNAME",
                "FEATURE_SCORES": {
                    "EMAIL": [
                        {
                            "INBOUND_FEAT_ID": 5,
                            "INBOUND_FEAT_DESC": "bsmith@work.com",
                            "INBOUND_FEAT_USAGE_TYPE": "",
                            "CANDIDATE_FEAT_ID": 5,
                            "CANDIDATE_FEAT_DESC": "bsmith@work.com",
                            "CANDIDATE_FEAT_USAGE_TYPE": "",
                            "SCORE": 100,
                            "ADDITIONAL_SCORES": {
                                "FULL_SCORE": 100
                            },
                            "SCORE_BUCKET": "SAME",
                            "SCORE_BEHAVIOR": "F1"
                        }
                    ],
                    "NAME": [
                        {
                            "INBOUND_FEAT_ID": -2,
                            "INBOUND_FEAT_DESC": "BOB SMITH",
                            "INBOUND_FEAT_USAGE_TYPE": "",
                            "CANDIDATE_FEAT_ID": 38,
                            "CANDIDATE_FEAT_DESC": "Bob J Smith",
                            "CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
                            "SCORE": 93,
                            "ADDITIONAL_SCORES": {
                                "GENERATION_MATCH": -1,
                                "GNR_FN": 93,
                                "GNR_GN": -1,
                                "GNR_ON": -1,
                                "GNR_SN": -1
                            },
                            "SCORE_BUCKET": "CLOSE",
                            "SCORE_BEHAVIOR": "NAME"
                        },
                        {
                            "INBOUND_FEAT_ID": -2,
                            "INBOUND_FEAT_DESC": "BOB SMITH",
                            "INBOUND_FEAT_USAGE_TYPE": "",
                            "CANDIDATE_FEAT_ID": 1,
                            "CANDIDATE_FEAT_DESC": "Robert Smith",
                            "CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
                            "SCORE": 97,
                            "ADDITIONAL_SCORES": {
                                "GENERATION_MATCH": -1,
                                "GNR_FN": 97,
                                "GNR_GN": -1,
                                "GNR_ON": -1,
                                "GNR_SN": -1
                            },
                            "SCORE_BUCKET": "CLOSE",
                            "SCORE_BEHAVIOR": "NAME"
                        }
                    ]
                }
            },
            "ENTITY": {
                "RESOLVED_ENTITY": {
                    "ENTITY_ID": 35,
                    "ENTITY_NAME": "Robert Smith",
                    "FEATURES": {
                        "ADDRESS": [
                            {
                                "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                                "LIB_FEAT_ID": 22,
                                "USAGE_TYPE": "HOME",
                                "FEAT_DESC_VALUES": [
                                    {
                                        "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                                        "LIB_FEAT_ID": 22
                                    }
                                ]
                            },
                            {
                                "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                                "LIB_FEAT_ID": 3,
                                "USAGE_TYPE": "MAILING",
                                "FEAT_DESC_VALUES": [
                                    {
                                        "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                                        "LIB_FEAT_ID": 3
                                    }
                                ]
                            }
                        ],
                        "DOB": [
                            {
                                "FEAT_DESC": "12/11/1978",
                                "LIB_FEAT_ID": 2,
                                "FEAT_DESC_VALUES": [
                                    {
                                        "FEAT_DESC": "12/11/1978",
                                        "LIB_FEAT_ID": 2
                                    },
                                    {
                                        "FEAT_DESC": "11/12/1978",
                                        "LIB_FEAT_ID": 21
                                    }
                                ]
                            }
                        ],
                        "EMAIL": [
                            {
                                "FEAT_DESC": "bsmith@work.com",
                                "LIB_FEAT_ID": 5,
                                "FEAT_DESC_VALUES": [
                                    {
                                        "FEAT_DESC": "bsmith@work.com",
                                        "LIB_FEAT_ID": 5
                                    }
                                ]
                            }
                        ],
                        "NAME": [
                            {
                                "FEAT_DESC": "Robert Smith",
                                "LIB_FEAT_ID": 1,
                                "USAGE_TYPE": "PRIMARY",
                                "FEAT_DESC_VALUES": [
                                    {
                                        "FEAT_DESC": "Robert Smith",
                                        "LIB_FEAT_ID": 1
                                    },
                                    {
                                        "FEAT_DESC": "Bob J Smith",
                                        "LIB_FEAT_ID": 38
                                    },
                                    {
                                        "FEAT_DESC": "Bob Smith",
                                        "LIB_FEAT_ID": 20
                                    }
                                ]
                            }
                        ],
                        "PHONE": [
                            {
                                "FEAT_DESC": "702-919-1300",
                                "LIB_FEAT_ID": 4,
                                "USAGE_TYPE": "HOME",
                                "FEAT_DESC_VALUES": [
                                    {
                                        "FEAT_DESC": "702-919-1300",
                                        "LIB_FEAT_ID": 4
                                    }
                                ]
                            },
                            {
                                "FEAT_DESC": "702-919-1300",
                                "LIB_FEAT_ID": 4,
                                "USAGE_TYPE": "MOBILE",
                                "FEAT_DESC_VALUES": [
                                    {
                                        "FEAT_DESC": "702-919-1300",
                                        "LIB_FEAT_ID": 4
                                    }
                                ]
                            }
                        ],
                        "RECORD_TYPE": [
                            {
                                "FEAT_DESC": "PERSON",
                                "LIB_FEAT_ID": 10,
                                "FEAT_DESC_VALUES": [
                                    {
                                        "FEAT_DESC": "PERSON",
                                        "LIB_FEAT_ID": 10
                                    }
                                ]
                            }
                        ]
                    },
                    "RECORD_SUMMARY": [
                        {
                            "DATA_SOURCE": "CUSTOMERS",
                            "RECORD_COUNT": 3
                        }
                    ]
                }
            }
        }
    ]
}

why_entities(entity_id_1: int, entity_id_2: int, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>) → str

The why_entities method determines why entities did not resolve or why they do relate.

Parameters:

• entity_id_1 (int) – The entity ID for the starting entity of the search path.

• entity_id_2 (int) – The entity ID for the ending entity of the search path.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

entity_id_1 = 1
entity_id_2 = 4
flags = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.why_entities(
        entity_id_1,
        entity_id_2,
        flags,
    )
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "WHY_RESULTS": [
        {
            "ENTITY_ID": 1,
            "ENTITY_ID_2": 35,
            "MATCH_INFO": {
                "WHY_KEY": "",
                "WHY_ERRULE_CODE": "",
                "MATCH_LEVEL_CODE": "",
                "CANDIDATE_KEYS": {},
                "DISCLOSED_RELATIONS": {},
                "FEATURE_SCORES": {}
            }
        }
    ],
    "ENTITIES": [
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 1,
                "ENTITY_NAME": "",
                "FEATURES": {},
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "TEST",
                        "RECORD_COUNT": 1
                    }
                ],
                "RECORDS": [
                    {
                        "DATA_SOURCE": "TEST",
                        "RECORD_ID": "2",
                        "INTERNAL_ID": 1,
                        "MATCH_KEY": "",
                        "MATCH_LEVEL_CODE": "",
                        "ERRULE_CODE": "",
                        "FIRST_SEEN_DT": "2024-10-25T17:38:57Z",
                        "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
                    }
                ]
            },
            "RELATED_ENTITIES": []
        },
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 35,
                "ENTITY_NAME": "Robert Smith",
                "FEATURES": {
                    "ADDRESS": [
                        {
                            "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                            "LIB_FEAT_ID": 22,
                            "USAGE_TYPE": "HOME",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                                    "LIB_FEAT_ID": 22,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                            "LIB_FEAT_ID": 3,
                            "USAGE_TYPE": "MAILING",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                                    "LIB_FEAT_ID": 3,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "ADDR_KEY": [
                        {
                            "FEAT_DESC": "123|MN||89132",
                            "LIB_FEAT_ID": 8,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "123|MN||89132",
                                    "LIB_FEAT_ID": 8,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "123|MN||LS FKS",
                            "LIB_FEAT_ID": 7,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "123|MN||LS FKS",
                                    "LIB_FEAT_ID": 7,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "1515|ATL||89111",
                            "LIB_FEAT_ID": 24,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "1515|ATL||89111",
                                    "LIB_FEAT_ID": 24,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "1515|ATL||LS FKS",
                            "LIB_FEAT_ID": 25,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "1515|ATL||LS FKS",
                                    "LIB_FEAT_ID": 25,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "DOB": [
                        {
                            "FEAT_DESC": "12/11/1978",
                            "LIB_FEAT_ID": 2,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "12/11/1978",
                                    "LIB_FEAT_ID": 2,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                },
                                {
                                    "FEAT_DESC": "11/12/1978",
                                    "LIB_FEAT_ID": 21,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "EMAIL": [
                        {
                            "FEAT_DESC": "bsmith@work.com",
                            "LIB_FEAT_ID": 5,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "bsmith@work.com",
                                    "LIB_FEAT_ID": 5,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "EMAIL_KEY": [
                        {
                            "FEAT_DESC": "bsmith@WORK.COM",
                            "LIB_FEAT_ID": 11,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "bsmith@WORK.COM",
                                    "LIB_FEAT_ID": 11,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAME": [
                        {
                            "FEAT_DESC": "Robert Smith",
                            "LIB_FEAT_ID": 1,
                            "USAGE_TYPE": "PRIMARY",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "Robert Smith",
                                    "LIB_FEAT_ID": 1,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                },
                                {
                                    "FEAT_DESC": "Bob J Smith",
                                    "LIB_FEAT_ID": 38,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                },
                                {
                                    "FEAT_DESC": "Bob Smith",
                                    "LIB_FEAT_ID": 20,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "Y"
                                }
                            ]
                        }
                    ],
                    "NAMEADDR_KEY": [
                        {
                            "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                            "LIB_FEAT_ID": 27,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                                    "LIB_FEAT_ID": 27,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                            "LIB_FEAT_ID": 28,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                                    "LIB_FEAT_ID": 28,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
                            "LIB_FEAT_ID": 12,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
                                    "LIB_FEAT_ID": 12,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
                            "LIB_FEAT_ID": 13,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
                                    "LIB_FEAT_ID": 13,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                            "LIB_FEAT_ID": 29,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                                    "LIB_FEAT_ID": 29,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                            "LIB_FEAT_ID": 26,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                                    "LIB_FEAT_ID": 26,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAMEDATE_KEY": [
                        {
                            "FEAT_DESC": "J|PP|SM0|DOB.MMDD_HASH=1211",
                            "LIB_FEAT_ID": 43,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0|DOB.MMDD_HASH=1211",
                                    "LIB_FEAT_ID": 43,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "J|PP|SM0|DOB.MMYY_HASH=1278",
                            "LIB_FEAT_ID": 41,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0|DOB.MMYY_HASH=1278",
                                    "LIB_FEAT_ID": 41,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "J|PP|SM0|DOB=71211",
                            "LIB_FEAT_ID": 40,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0|DOB=71211",
                                    "LIB_FEAT_ID": 40,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB.MMDD_HASH=1211",
                            "LIB_FEAT_ID": 32,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB.MMDD_HASH=1211",
                                    "LIB_FEAT_ID": 32,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1178",
                            "LIB_FEAT_ID": 33,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1178",
                                    "LIB_FEAT_ID": 33,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1278",
                            "LIB_FEAT_ID": 42,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1278",
                                    "LIB_FEAT_ID": 42,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB=71211",
                            "LIB_FEAT_ID": 31,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB=71211",
                                    "LIB_FEAT_ID": 31,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
                            "LIB_FEAT_ID": 14,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
                                    "LIB_FEAT_ID": 14,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1178",
                            "LIB_FEAT_ID": 30,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1178",
                                    "LIB_FEAT_ID": 30,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
                            "LIB_FEAT_ID": 16,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
                                    "LIB_FEAT_ID": 16,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB=71211",
                            "LIB_FEAT_ID": 15,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB=71211",
                                    "LIB_FEAT_ID": 15,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAMEPHONE_KEY": [
                        {
                            "FEAT_DESC": "PP|SM0|PHONE.PHONE_LAST_5=91300",
                            "LIB_FEAT_ID": 37,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|PHONE.PHONE_LAST_5=91300",
                                    "LIB_FEAT_ID": 37,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300",
                            "LIB_FEAT_ID": 19,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300",
                                    "LIB_FEAT_ID": 19,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAMEREGION_KEY": [
                        {
                            "FEAT_DESC": "PP|SM0|ADDRESS.CITY_STD=LS FKS",
                            "LIB_FEAT_ID": 36,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|ADDRESS.CITY_STD=LS FKS",
                                    "LIB_FEAT_ID": 36,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|POST=89111",
                            "LIB_FEAT_ID": 35,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|POST=89111",
                                    "LIB_FEAT_ID": 35,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
                            "LIB_FEAT_ID": 18,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
                                    "LIB_FEAT_ID": 18,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|POST=89111",
                            "LIB_FEAT_ID": 34,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|POST=89111",
                                    "LIB_FEAT_ID": 34,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|POST=89132",
                            "LIB_FEAT_ID": 17,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|POST=89132",
                                    "LIB_FEAT_ID": 17,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAME_KEY": [
                        {
                            "FEAT_DESC": "J|PP|SM0",
                            "LIB_FEAT_ID": 39,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0",
                                    "LIB_FEAT_ID": 39,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0",
                            "LIB_FEAT_ID": 23,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0",
                                    "LIB_FEAT_ID": 23,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0",
                            "LIB_FEAT_ID": 6,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0",
                                    "LIB_FEAT_ID": 6,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "PHONE": [
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 4,
                            "USAGE_TYPE": "HOME",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "702-919-1300",
                                    "LIB_FEAT_ID": 4,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 4,
                            "USAGE_TYPE": "MOBILE",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "702-919-1300",
                                    "LIB_FEAT_ID": 4,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "PHONE_KEY": [
                        {
                            "FEAT_DESC": "7029191300",
                            "LIB_FEAT_ID": 9,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "7029191300",
                                    "LIB_FEAT_ID": 9,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "RECORD_TYPE": [
                        {
                            "FEAT_DESC": "PERSON",
                            "LIB_FEAT_ID": 10,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PERSON",
                                    "LIB_FEAT_ID": 10,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 100,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ]
                },
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 3
                    }
                ],
                "RECORDS": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_ID": "1001",
                        "INTERNAL_ID": 35,
                        "MATCH_KEY": "",
                        "MATCH_LEVEL_CODE": "",
                        "ERRULE_CODE": "",
                        "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                        "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
                    },
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_ID": "1002",
                        "INTERNAL_ID": 36,
                        "MATCH_KEY": "+NAME+DOB+PHONE",
                        "MATCH_LEVEL_CODE": "RESOLVED",
                        "ERRULE_CODE": "CNAME_CFF_CEXCL",
                        "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                        "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
                    },
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_ID": "1003",
                        "INTERNAL_ID": 37,
                        "MATCH_KEY": "+NAME+DOB+EMAIL",
                        "MATCH_LEVEL_CODE": "RESOLVED",
                        "ERRULE_CODE": "SF1_PNAME_CSTAB",
                        "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                        "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
                    }
                ]
            },
            "RELATED_ENTITIES": []
        }
    ]
}

why_record_in_entity(data_source_code: str, record_id: str, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>) → str

The why_record_in_entity method determines why a record is included in an entity.

Parameters:

• data_source_code (str) – Identifies the provenance of the data.

• record_id (str) – The unique identifier within the records of the same data source.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

data_source_code = "CUSTOMERS"
flags = SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS
record_id = "1001"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.why_record_in_entity(
        data_source_code,
        record_id,
        flags,
    )
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.
{
    "WHY_RESULTS": [
        {
            "INTERNAL_ID": 35,
            "ENTITY_ID": 35,
            "FOCUS_RECORDS": [
                {
                    "DATA_SOURCE": "CUSTOMERS",
                    "RECORD_ID": "1001"
                }
            ],
            "MATCH_INFO": {
                "WHY_KEY": "+NAME+DOB+PHONE+EMAIL",
                "WHY_ERRULE_CODE": "SF1_SNAME_CFF_CSTAB",
                "MATCH_LEVEL_CODE": "RESOLVED",
                "CANDIDATE_KEYS": {
                    "DOB": [
                        {
                            "FEAT_ID": 2,
                            "FEAT_DESC": "12/11/1978"
                        }
                    ],
                    "EMAIL_KEY": [
                        {
                            "FEAT_ID": 11,
                            "FEAT_DESC": "bsmith@WORK.COM"
                        }
                    ],
                    "NAMEDATE_KEY": [
                        {
                            "FEAT_ID": 14,
                            "FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211"
                        },
                        {
                            "FEAT_ID": 15,
                            "FEAT_DESC": "RPRT|SM0|DOB=71211"
                        },
                        {
                            "FEAT_ID": 16,
                            "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278"
                        }
                    ],
                    "NAMEPHONE_KEY": [
                        {
                            "FEAT_ID": 19,
                            "FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300"
                        }
                    ],
                    "NAMEREGION_KEY": [
                        {
                            "FEAT_ID": 18,
                            "FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
                        }
                    ],
                    "NAME_KEY": [
                        {
                            "FEAT_ID": 6,
                            "FEAT_DESC": "RPRT|SM0"
                        }
                    ],
                    "PHONE_KEY": [
                        {
                            "FEAT_ID": 9,
                            "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": 22,
                            "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",
                            "INBOUND_FEAT_USAGE_TYPE": "",
                            "CANDIDATE_FEAT_ID": 2,
                            "CANDIDATE_FEAT_DESC": "12/11/1978",
                            "CANDIDATE_FEAT_USAGE_TYPE": "",
                            "SCORE": 100,
                            "ADDITIONAL_SCORES": {
                                "FULL_SCORE": 100
                            },
                            "SCORE_BUCKET": "SAME",
                            "SCORE_BEHAVIOR": "FMES"
                        }
                    ],
                    "EMAIL": [
                        {
                            "INBOUND_FEAT_ID": 5,
                            "INBOUND_FEAT_DESC": "bsmith@work.com",
                            "INBOUND_FEAT_USAGE_TYPE": "",
                            "CANDIDATE_FEAT_ID": 5,
                            "CANDIDATE_FEAT_DESC": "bsmith@work.com",
                            "CANDIDATE_FEAT_USAGE_TYPE": "",
                            "SCORE": 100,
                            "ADDITIONAL_SCORES": {
                                "FULL_SCORE": 100
                            },
                            "SCORE_BUCKET": "SAME",
                            "SCORE_BEHAVIOR": "F1"
                        }
                    ],
                    "NAME": [
                        {
                            "INBOUND_FEAT_ID": 1,
                            "INBOUND_FEAT_DESC": "Robert Smith",
                            "INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
                            "CANDIDATE_FEAT_ID": 38,
                            "CANDIDATE_FEAT_DESC": "Bob J Smith",
                            "CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
                            "SCORE": 90,
                            "ADDITIONAL_SCORES": {
                                "GENERATION_MATCH": -1,
                                "GNR_FN": 90,
                                "GNR_GN": 88,
                                "GNR_ON": -1,
                                "GNR_SN": 100
                            },
                            "SCORE_BUCKET": "CLOSE",
                            "SCORE_BEHAVIOR": "NAME"
                        },
                        {
                            "INBOUND_FEAT_ID": 1,
                            "INBOUND_FEAT_DESC": "Robert Smith",
                            "INBOUND_FEAT_USAGE_TYPE": "PRIMARY",
                            "CANDIDATE_FEAT_ID": 20,
                            "CANDIDATE_FEAT_DESC": "Bob Smith",
                            "CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
                            "SCORE": 97,
                            "ADDITIONAL_SCORES": {
                                "GENERATION_MATCH": -1,
                                "GNR_FN": 97,
                                "GNR_GN": 95,
                                "GNR_ON": -1,
                                "GNR_SN": 100
                            },
                            "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": 10,
                            "INBOUND_FEAT_DESC": "PERSON",
                            "INBOUND_FEAT_USAGE_TYPE": "",
                            "CANDIDATE_FEAT_ID": 10,
                            "CANDIDATE_FEAT_DESC": "PERSON",
                            "CANDIDATE_FEAT_USAGE_TYPE": "",
                            "SCORE": 100,
                            "ADDITIONAL_SCORES": {
                                "FULL_SCORE": 100
                            },
                            "SCORE_BUCKET": "SAME",
                            "SCORE_BEHAVIOR": "FVME"
                        }
                    ]
                }
            }
        }
    ],
    "ENTITIES": [
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 35,
                "ENTITY_NAME": "Robert Smith",
                "FEATURES": {
                    "ADDRESS": [
                        {
                            "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                            "LIB_FEAT_ID": 22,
                            "USAGE_TYPE": "HOME",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                                    "LIB_FEAT_ID": 22,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                            "LIB_FEAT_ID": 3,
                            "USAGE_TYPE": "MAILING",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                                    "LIB_FEAT_ID": 3,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "ADDR_KEY": [
                        {
                            "FEAT_DESC": "123|MN||89132",
                            "LIB_FEAT_ID": 8,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "123|MN||89132",
                                    "LIB_FEAT_ID": 8,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "123|MN||LS FKS",
                            "LIB_FEAT_ID": 7,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "123|MN||LS FKS",
                                    "LIB_FEAT_ID": 7,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "1515|ATL||89111",
                            "LIB_FEAT_ID": 24,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "1515|ATL||89111",
                                    "LIB_FEAT_ID": 24,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "1515|ATL||LS FKS",
                            "LIB_FEAT_ID": 25,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "1515|ATL||LS FKS",
                                    "LIB_FEAT_ID": 25,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "DOB": [
                        {
                            "FEAT_DESC": "12/11/1978",
                            "LIB_FEAT_ID": 2,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "12/11/1978",
                                    "LIB_FEAT_ID": 2,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                },
                                {
                                    "FEAT_DESC": "11/12/1978",
                                    "LIB_FEAT_ID": 21,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "EMAIL": [
                        {
                            "FEAT_DESC": "bsmith@work.com",
                            "LIB_FEAT_ID": 5,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "bsmith@work.com",
                                    "LIB_FEAT_ID": 5,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "EMAIL_KEY": [
                        {
                            "FEAT_DESC": "bsmith@WORK.COM",
                            "LIB_FEAT_ID": 11,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "bsmith@WORK.COM",
                                    "LIB_FEAT_ID": 11,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAME": [
                        {
                            "FEAT_DESC": "Robert Smith",
                            "LIB_FEAT_ID": 1,
                            "USAGE_TYPE": "PRIMARY",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "Robert Smith",
                                    "LIB_FEAT_ID": 1,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                },
                                {
                                    "FEAT_DESC": "Bob J Smith",
                                    "LIB_FEAT_ID": 38,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                },
                                {
                                    "FEAT_DESC": "Bob Smith",
                                    "LIB_FEAT_ID": 20,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "Y"
                                }
                            ]
                        }
                    ],
                    "NAMEADDR_KEY": [
                        {
                            "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                            "LIB_FEAT_ID": 27,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                                    "LIB_FEAT_ID": 27,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                            "LIB_FEAT_ID": 28,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                                    "LIB_FEAT_ID": 28,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
                            "LIB_FEAT_ID": 12,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
                                    "LIB_FEAT_ID": 12,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
                            "LIB_FEAT_ID": 13,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
                                    "LIB_FEAT_ID": 13,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                            "LIB_FEAT_ID": 29,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                                    "LIB_FEAT_ID": 29,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                            "LIB_FEAT_ID": 26,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                                    "LIB_FEAT_ID": 26,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAMEDATE_KEY": [
                        {
                            "FEAT_DESC": "J|PP|SM0|DOB.MMDD_HASH=1211",
                            "LIB_FEAT_ID": 43,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0|DOB.MMDD_HASH=1211",
                                    "LIB_FEAT_ID": 43,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "J|PP|SM0|DOB.MMYY_HASH=1278",
                            "LIB_FEAT_ID": 41,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0|DOB.MMYY_HASH=1278",
                                    "LIB_FEAT_ID": 41,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "J|PP|SM0|DOB=71211",
                            "LIB_FEAT_ID": 40,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0|DOB=71211",
                                    "LIB_FEAT_ID": 40,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB.MMDD_HASH=1211",
                            "LIB_FEAT_ID": 32,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB.MMDD_HASH=1211",
                                    "LIB_FEAT_ID": 32,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1178",
                            "LIB_FEAT_ID": 33,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1178",
                                    "LIB_FEAT_ID": 33,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1278",
                            "LIB_FEAT_ID": 42,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1278",
                                    "LIB_FEAT_ID": 42,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB=71211",
                            "LIB_FEAT_ID": 31,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB=71211",
                                    "LIB_FEAT_ID": 31,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
                            "LIB_FEAT_ID": 14,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
                                    "LIB_FEAT_ID": 14,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1178",
                            "LIB_FEAT_ID": 30,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1178",
                                    "LIB_FEAT_ID": 30,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
                            "LIB_FEAT_ID": 16,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
                                    "LIB_FEAT_ID": 16,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB=71211",
                            "LIB_FEAT_ID": 15,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB=71211",
                                    "LIB_FEAT_ID": 15,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAMEPHONE_KEY": [
                        {
                            "FEAT_DESC": "PP|SM0|PHONE.PHONE_LAST_5=91300",
                            "LIB_FEAT_ID": 37,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|PHONE.PHONE_LAST_5=91300",
                                    "LIB_FEAT_ID": 37,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300",
                            "LIB_FEAT_ID": 19,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300",
                                    "LIB_FEAT_ID": 19,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAMEREGION_KEY": [
                        {
                            "FEAT_DESC": "PP|SM0|ADDRESS.CITY_STD=LS FKS",
                            "LIB_FEAT_ID": 36,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|ADDRESS.CITY_STD=LS FKS",
                                    "LIB_FEAT_ID": 36,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|POST=89111",
                            "LIB_FEAT_ID": 35,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|POST=89111",
                                    "LIB_FEAT_ID": 35,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
                            "LIB_FEAT_ID": 18,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
                                    "LIB_FEAT_ID": 18,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|POST=89111",
                            "LIB_FEAT_ID": 34,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|POST=89111",
                                    "LIB_FEAT_ID": 34,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|POST=89132",
                            "LIB_FEAT_ID": 17,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|POST=89132",
                                    "LIB_FEAT_ID": 17,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAME_KEY": [
                        {
                            "FEAT_DESC": "J|PP|SM0",
                            "LIB_FEAT_ID": 39,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0",
                                    "LIB_FEAT_ID": 39,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0",
                            "LIB_FEAT_ID": 23,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0",
                                    "LIB_FEAT_ID": 23,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0",
                            "LIB_FEAT_ID": 6,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0",
                                    "LIB_FEAT_ID": 6,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "PHONE": [
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 4,
                            "USAGE_TYPE": "HOME",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "702-919-1300",
                                    "LIB_FEAT_ID": 4,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 4,
                            "USAGE_TYPE": "MOBILE",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "702-919-1300",
                                    "LIB_FEAT_ID": 4,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "PHONE_KEY": [
                        {
                            "FEAT_DESC": "7029191300",
                            "LIB_FEAT_ID": 9,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "7029191300",
                                    "LIB_FEAT_ID": 9,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "RECORD_TYPE": [
                        {
                            "FEAT_DESC": "PERSON",
                            "LIB_FEAT_ID": 10,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PERSON",
                                    "LIB_FEAT_ID": 10,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 100,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ]
                },
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 3
                    }
                ],
                "RECORDS": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_ID": "1001",
                        "INTERNAL_ID": 35,
                        "MATCH_KEY": "",
                        "MATCH_LEVEL_CODE": "",
                        "ERRULE_CODE": "",
                        "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                        "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
                    },
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_ID": "1002",
                        "INTERNAL_ID": 36,
                        "MATCH_KEY": "+NAME+DOB+PHONE",
                        "MATCH_LEVEL_CODE": "RESOLVED",
                        "ERRULE_CODE": "CNAME_CFF_CEXCL",
                        "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                        "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
                    },
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_ID": "1003",
                        "INTERNAL_ID": 37,
                        "MATCH_KEY": "+NAME+DOB+EMAIL",
                        "MATCH_LEVEL_CODE": "RESOLVED",
                        "ERRULE_CODE": "SF1_PNAME_CSTAB",
                        "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                        "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
                    }
                ]
            },
            "RELATED_ENTITIES": []
        }
    ]
}

why_records(data_source_code_1: str, record_id_1: str, data_source_code_2: str, record_id_2: str, flags: int = <SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS: 96009152>) → str

The why_records determines if any two records can or cannot resolve together, or if they relate.

Parameters:

• data_source_code_1 (str) – Identifies the provenance of the data.

• record_id_1 (str) – The unique identifier within the records of the same data source.

• data_source_code_2 (str) – Identifies the provenance of the data.

• record_id_2 (str) – The unique identifier within the records of the same data source.

• flags (int, optional) – Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

data_source_code_1 = "CUSTOMERS"
data_source_code_2 = "CUSTOMERS"
flags = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS
record_id_1 = "1001"
record_id_2 = "1002"

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.why_records(
        data_source_code_1,
        record_id_1,
        data_source_code_2,
        record_id_2,
        flags,
    )
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted and pruned for easier reading.

{
    "WHY_RESULTS": [
        {
            "INTERNAL_ID": 35,
            "ENTITY_ID": 35,
            "FOCUS_RECORDS": [
                {
                    "DATA_SOURCE": "CUSTOMERS",
                    "RECORD_ID": "1001"
                }
            ],
            "INTERNAL_ID_2": 36,
            "ENTITY_ID_2": 35,
            "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": 14,
                            "FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211"
                        },
                        {
                            "FEAT_ID": 15,
                            "FEAT_DESC": "RPRT|SM0|DOB=71211"
                        }
                    ],
                    "NAMEPHONE_KEY": [
                        {
                            "FEAT_ID": 19,
                            "FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300"
                        }
                    ],
                    "NAMEREGION_KEY": [
                        {
                            "FEAT_ID": 18,
                            "FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS"
                        }
                    ],
                    "NAME_KEY": [
                        {
                            "FEAT_ID": 6,
                            "FEAT_DESC": "RPRT|SM0"
                        }
                    ],
                    "PHONE_KEY": [
                        {
                            "FEAT_ID": 9,
                            "FEAT_DESC": "7029191300"
                        }
                    ]
                },
                "DISCLOSED_RELATIONS": {},
                "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": 22,
                            "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",
                            "INBOUND_FEAT_USAGE_TYPE": "",
                            "CANDIDATE_FEAT_ID": 21,
                            "CANDIDATE_FEAT_DESC": "11/12/1978",
                            "CANDIDATE_FEAT_USAGE_TYPE": "",
                            "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": 20,
                            "CANDIDATE_FEAT_DESC": "Bob Smith",
                            "CANDIDATE_FEAT_USAGE_TYPE": "PRIMARY",
                            "SCORE": 97,
                            "ADDITIONAL_SCORES": {
                                "GENERATION_MATCH": -1,
                                "GNR_FN": 97,
                                "GNR_GN": 95,
                                "GNR_ON": -1,
                                "GNR_SN": 100
                            },
                            "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": 10,
                            "INBOUND_FEAT_DESC": "PERSON",
                            "INBOUND_FEAT_USAGE_TYPE": "",
                            "CANDIDATE_FEAT_ID": 10,
                            "CANDIDATE_FEAT_DESC": "PERSON",
                            "CANDIDATE_FEAT_USAGE_TYPE": "",
                            "SCORE": 100,
                            "ADDITIONAL_SCORES": {
                                "FULL_SCORE": 100
                            },
                            "SCORE_BUCKET": "SAME",
                            "SCORE_BEHAVIOR": "FVME"
                        }
                    ]
                }
            }
        }
    ],
    "ENTITIES": [
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 35,
                "ENTITY_NAME": "Robert Smith",
                "FEATURES": {
                    "ADDRESS": [
                        {
                            "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                            "LIB_FEAT_ID": 22,
                            "USAGE_TYPE": "HOME",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                                    "LIB_FEAT_ID": 22,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                            "LIB_FEAT_ID": 3,
                            "USAGE_TYPE": "MAILING",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                                    "LIB_FEAT_ID": 3,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "ADDR_KEY": [
                        {
                            "FEAT_DESC": "123|MN||89132",
                            "LIB_FEAT_ID": 8,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "123|MN||89132",
                                    "LIB_FEAT_ID": 8,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "123|MN||LS FKS",
                            "LIB_FEAT_ID": 7,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "123|MN||LS FKS",
                                    "LIB_FEAT_ID": 7,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "1515|ATL||89111",
                            "LIB_FEAT_ID": 24,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "1515|ATL||89111",
                                    "LIB_FEAT_ID": 24,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "1515|ATL||LS FKS",
                            "LIB_FEAT_ID": 25,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "1515|ATL||LS FKS",
                                    "LIB_FEAT_ID": 25,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "DOB": [
                        {
                            "FEAT_DESC": "12/11/1978",
                            "LIB_FEAT_ID": 2,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "12/11/1978",
                                    "LIB_FEAT_ID": 2,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                },
                                {
                                    "FEAT_DESC": "11/12/1978",
                                    "LIB_FEAT_ID": 21,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "EMAIL": [
                        {
                            "FEAT_DESC": "bsmith@work.com",
                            "LIB_FEAT_ID": 5,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "bsmith@work.com",
                                    "LIB_FEAT_ID": 5,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "EMAIL_KEY": [
                        {
                            "FEAT_DESC": "bsmith@WORK.COM",
                            "LIB_FEAT_ID": 11,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "bsmith@WORK.COM",
                                    "LIB_FEAT_ID": 11,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAME": [
                        {
                            "FEAT_DESC": "Robert Smith",
                            "LIB_FEAT_ID": 1,
                            "USAGE_TYPE": "PRIMARY",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "Robert Smith",
                                    "LIB_FEAT_ID": 1,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                },
                                {
                                    "FEAT_DESC": "Bob J Smith",
                                    "LIB_FEAT_ID": 38,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                },
                                {
                                    "FEAT_DESC": "Bob Smith",
                                    "LIB_FEAT_ID": 20,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "Y"
                                }
                            ]
                        }
                    ],
                    "NAMEADDR_KEY": [
                        {
                            "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                            "LIB_FEAT_ID": 27,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                                    "LIB_FEAT_ID": 27,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                            "LIB_FEAT_ID": 28,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                                    "LIB_FEAT_ID": 28,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
                            "LIB_FEAT_ID": 12,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||89132",
                                    "LIB_FEAT_ID": 12,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
                            "LIB_FEAT_ID": 13,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=123|MN||LS FKS",
                                    "LIB_FEAT_ID": 13,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                            "LIB_FEAT_ID": 29,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||89111",
                                    "LIB_FEAT_ID": 29,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                            "LIB_FEAT_ID": 26,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDR_KEY.EXPRESSION=1515|ATL||LS FKS",
                                    "LIB_FEAT_ID": 26,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAMEDATE_KEY": [
                        {
                            "FEAT_DESC": "J|PP|SM0|DOB.MMDD_HASH=1211",
                            "LIB_FEAT_ID": 43,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0|DOB.MMDD_HASH=1211",
                                    "LIB_FEAT_ID": 43,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "J|PP|SM0|DOB.MMYY_HASH=1278",
                            "LIB_FEAT_ID": 41,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0|DOB.MMYY_HASH=1278",
                                    "LIB_FEAT_ID": 41,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "J|PP|SM0|DOB=71211",
                            "LIB_FEAT_ID": 40,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0|DOB=71211",
                                    "LIB_FEAT_ID": 40,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB.MMDD_HASH=1211",
                            "LIB_FEAT_ID": 32,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB.MMDD_HASH=1211",
                                    "LIB_FEAT_ID": 32,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1178",
                            "LIB_FEAT_ID": 33,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1178",
                                    "LIB_FEAT_ID": 33,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1278",
                            "LIB_FEAT_ID": 42,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB.MMYY_HASH=1278",
                                    "LIB_FEAT_ID": 42,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|DOB=71211",
                            "LIB_FEAT_ID": 31,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|DOB=71211",
                                    "LIB_FEAT_ID": 31,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
                            "LIB_FEAT_ID": 14,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB.MMDD_HASH=1211",
                                    "LIB_FEAT_ID": 14,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1178",
                            "LIB_FEAT_ID": 30,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1178",
                                    "LIB_FEAT_ID": 30,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
                            "LIB_FEAT_ID": 16,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB.MMYY_HASH=1278",
                                    "LIB_FEAT_ID": 16,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|DOB=71211",
                            "LIB_FEAT_ID": 15,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|DOB=71211",
                                    "LIB_FEAT_ID": 15,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAMEPHONE_KEY": [
                        {
                            "FEAT_DESC": "PP|SM0|PHONE.PHONE_LAST_5=91300",
                            "LIB_FEAT_ID": 37,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|PHONE.PHONE_LAST_5=91300",
                                    "LIB_FEAT_ID": 37,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300",
                            "LIB_FEAT_ID": 19,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|PHONE.PHONE_LAST_5=91300",
                                    "LIB_FEAT_ID": 19,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAMEREGION_KEY": [
                        {
                            "FEAT_DESC": "PP|SM0|ADDRESS.CITY_STD=LS FKS",
                            "LIB_FEAT_ID": 36,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|ADDRESS.CITY_STD=LS FKS",
                                    "LIB_FEAT_ID": 36,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0|POST=89111",
                            "LIB_FEAT_ID": 35,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0|POST=89111",
                                    "LIB_FEAT_ID": 35,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
                            "LIB_FEAT_ID": 18,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|ADDRESS.CITY_STD=LS FKS",
                                    "LIB_FEAT_ID": 18,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|POST=89111",
                            "LIB_FEAT_ID": 34,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|POST=89111",
                                    "LIB_FEAT_ID": 34,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0|POST=89132",
                            "LIB_FEAT_ID": 17,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0|POST=89132",
                                    "LIB_FEAT_ID": 17,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "NAME_KEY": [
                        {
                            "FEAT_DESC": "J|PP|SM0",
                            "LIB_FEAT_ID": 39,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "J|PP|SM0",
                                    "LIB_FEAT_ID": 39,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "PP|SM0",
                            "LIB_FEAT_ID": 23,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PP|SM0",
                                    "LIB_FEAT_ID": 23,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "RPRT|SM0",
                            "LIB_FEAT_ID": 6,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "RPRT|SM0",
                                    "LIB_FEAT_ID": 6,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "PHONE": [
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 4,
                            "USAGE_TYPE": "HOME",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "702-919-1300",
                                    "LIB_FEAT_ID": 4,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        },
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 4,
                            "USAGE_TYPE": "MOBILE",
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "702-919-1300",
                                    "LIB_FEAT_ID": 4,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "PHONE_KEY": [
                        {
                            "FEAT_DESC": "7029191300",
                            "LIB_FEAT_ID": 9,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "7029191300",
                                    "LIB_FEAT_ID": 9,
                                    "USED_FOR_CAND": "Y",
                                    "USED_FOR_SCORING": "N",
                                    "ENTITY_COUNT": 1,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ],
                    "RECORD_TYPE": [
                        {
                            "FEAT_DESC": "PERSON",
                            "LIB_FEAT_ID": 10,
                            "FEAT_DESC_VALUES": [
                                {
                                    "FEAT_DESC": "PERSON",
                                    "LIB_FEAT_ID": 10,
                                    "USED_FOR_CAND": "N",
                                    "USED_FOR_SCORING": "Y",
                                    "ENTITY_COUNT": 100,
                                    "CANDIDATE_CAP_REACHED": "N",
                                    "SCORING_CAP_REACHED": "N",
                                    "SUPPRESSED": "N"
                                }
                            ]
                        }
                    ]
                },
                "RECORD_SUMMARY": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_COUNT": 3
                    }
                ],
                "RECORDS": [
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_ID": "1001",
                        "INTERNAL_ID": 35,
                        "MATCH_KEY": "",
                        "MATCH_LEVEL_CODE": "",
                        "ERRULE_CODE": "",
                        "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                        "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
                    },
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_ID": "1002",
                        "INTERNAL_ID": 36,
                        "MATCH_KEY": "+NAME+DOB+PHONE",
                        "MATCH_LEVEL_CODE": "RESOLVED",
                        "ERRULE_CODE": "CNAME_CFF_CEXCL",
                        "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                        "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
                    },
                    {
                        "DATA_SOURCE": "CUSTOMERS",
                        "RECORD_ID": "1003",
                        "INTERNAL_ID": 37,
                        "MATCH_KEY": "+NAME+DOB+EMAIL",
                        "MATCH_LEVEL_CODE": "RESOLVED",
                        "ERRULE_CODE": "SF1_PNAME_CSTAB",
                        "FIRST_SEEN_DT": "2024-10-25T17:39:00Z",
                        "LAST_SEEN_DT": "2024-10-25T17:39:00Z"
                    }
                ]
            },
            "RELATED_ENTITIES": []
        }
    ]
}

why_search(attributes: str, entity_id: int, flags: int = <SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS: 3734464>, search_profile: str = '') → str

The why_search method retrieves entity data based on a specific entity Id and a user-specified set of entity attributes.

Parameters:

• attributes (str) – A JSON document with the attribute data to search for.

• entity_id (int) – The identifier of the entity to retrieve.

• flags (int, optional) – _description_. Defaults to SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS.

• search_profile (str) – The name of a configured search profile. Defaults to SEARCH.

Returns:

A JSON document.

Return type:

str

Raises:

Example:

import json

import grpc
from senzing import SzEngineFlags, SzError

from senzing_grpc import SzAbstractFactoryGrpc

attributes = json.dumps({"NAME_FULL": "BOB SMITH", "EMAIL_ADDRESS": "bsmith@work.com"})
entity_id = 1
flags = SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_engine = sz_abstract_factory.create_engine()
    result = sz_engine.why_search(attributes, entity_id, flags)
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.
{
    "WHY_RESULTS": [
        {
            "ENTITY_ID": 1,
            "MATCH_INFO": {
                "WHY_KEY": "+PNAME+EMAIL",
                "WHY_ERRULE_CODE": "SF1",
                "MATCH_LEVEL_CODE": "POSSIBLY_RELATED"
            }
        }
    ],
    "ENTITIES": [
        {
            "RESOLVED_ENTITY": {
                "ENTITY_ID": 1
            }
        }
    ]
}

szproduct

senzing_grpc.szproduct.SzProductGrpc is a gRPC implementation of the senzing.szproduct.SzProduct interface.

class senzing_grpc.szproduct.SzProductGrpc(grpc_channel: Channel)

Bases: SzProduct

SzProduct module access library over gRPC.

get_license() → str

The get_license method retrieves information about the currently used license.

Returns:

A JSON document containing Senzing license metadata.

Return type:

str

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_product = sz_abstract_factory.create_product()
    result = sz_product.get_license()
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "customer": "Senzing Public Test License",
    "contract": "EVALUATION - support@senzing.com",
    "issueDate": "2024-10-15",
    "licenseType": "EVAL (Solely for non-productive use)",
    "licenseLevel": "STANDARD",
    "billing": "MONTHLY",
    "expireDate": "2025-10-16",
    "recordLimit": 500
}

get_version() → str

The get_version method returns the version of Senzing.

Returns:

A JSON document containing metadata about the Senzing Engine version being used.

Return type:

str

Example:

import grpc
from senzing import SzError

from senzing_grpc import SzAbstractFactoryGrpc

try:
    grpc_channel = grpc.insecure_channel("localhost:8261")
    sz_abstract_factory = SzAbstractFactoryGrpc(grpc_channel)
    sz_product = sz_abstract_factory.create_product()
    result = sz_product.get_version()
    print(f"\n{result}\n")
except SzError as err:
    print(f"\nERROR: {err}\n")

Output:

// Output has been formatted for easier reading.

{
    "PRODUCT_NAME": "Senzing SDK",
    "VERSION": "4.0.0",
    "BUILD_VERSION": "4.0.0.24289",
    "BUILD_DATE": "2024-10-15",
    "BUILD_NUMBER": "2024_10_15__14_21",
    "COMPATIBILITY_VERSION": {
        "CONFIG_VERSION": "11"
    },
    "SCHEMA_VERSION": {
        "ENGINE_SCHEMA_VERSION": "4.0",
        "MINIMUM_REQUIRED_SCHEMA_VERSION": "4.0",
        "MAXIMUM_REQUIRED_SCHEMA_VERSION": "4.99"
    }
}

help(method_name: str = '') → str

Return the help for a particular message.

Parameters:

method_name (str) – The name of the method. (e.g. “init”). If empty, a list of methods and descriptions is returned.

Returns:

The Help information about the requested method

Return type:

str

initialize(instance_name: str, settings: str | Dict[Any, Any], verbose_logging: int = 0) → None

Null function in the sz-sdk-python-grpc implementation.