The addRecord method adds a record into the Senzing repository. Can be called as many times as desired and from multiple threads at the same time.
Identifies the provenance of the data.
The unique identifier within the records of the same data source.
A JSON document containing the record to be added to the Senzing repository.
Flags used to control information returned. Defaults to 0.
The closeExport method closes the exported document created by exportJsonEntityReport. It is part of the export_json_entity_report, fetch_next, close_export lifecycle of a list of sized
A handle created by exportJsonEntityReport or exportCsvEntityReport.
for better support of async waiting
The deleteRecord method deletes a record from the Senzing repository.
Identifies the provenance of the data
The unique identifier within the records of the same data source.
Flags used to control information returned. Defaults to 0.
The exportJsonEntityReport method initializes a cursor over a document of exported entities. It is part of the exportJsonEntityReport, fetchNext, closeExport lifecycle of a list of entities to export.
Finds all entities surrounding a requested set of entities. This includes the requested entities, paths between them, and relations to other nearby entities. Returns a JSON document that identifies the path between the each set of search entities (if the path exists), and the information for the entities in the path.
The entity IDs to find the network between.
Optional
maxDegrees: numberThe maximum number of degrees in paths between search entities.
Optional
buildOutDegrees: numberThe number of degrees of relationships to show around each search entity.
Optional
buildOutMaxEntities: numberThe maximum number of entities to return in the discovered network.
A JSON document.
Finds all entities surrounding a requested set of entities by their RECORD_ID values. This includes the requested entities, paths between them, and relations to other nearby entities. Returns a JSON document that identifies the path between the each set of search entities (if the path exists), and the information for the entities in the path.
The data source codes and record IDs to find the network between.
Optional
maxDegrees: numberThe maximum number of degrees in paths between search entities.
Optional
buildOutDegrees: numberThe number of degrees of relationships to show around each search entity.
Optional
buildOutMaxEntities: numberThe maximum number of entities to return in the discovered network.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.
A JSON document.
Finds the most efficient relationship between two entities path based on the parameters and returns a JSON document with an ENTITY_PATHS section that details the path between the entities. The ENTITIES sections details information on the entities. Paths are found using known relationships with other entities. Paths are found using known relationships with other entities.
The entity ID for the starting entity of the search path.
The entity ID for the ending entity of the search path.
The maximum number of degrees in paths between search entities.
Optional
avoidEntityIds: number[]The entity IDs to avoid when finding a path.
Optional
requiredDataSources: string[]The data source code(s) that must be in a path.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.
A JSON document with an ENTITY_PATHS section that details the path between the entities.
Finds the most efficient relationship between two entities path based on the parameters by RECORD_ID values and returns a JSON document with an ENTITY_PATHS section that details the path between the entities. The ENTITIES sections details information on the entities. Paths are found using known relationships with other entities. The entities are identified by starting and ending records.
Identifies the provenance of the record for the starting entity of the search path.
The unique identifier within the records of the same data source for the starting entity of the search path.
Identifies the provenance of the record for the ending entity of the search path.
The unique identifier within the records of the same data source for the ending entity of the search path.
The maximum number of degrees in paths between search entities.
Optional
avoidRecordKeys: [string, number][]The data source codes and record IDs to avoid when finding a path.
Optional
requiredDataSources: string[]The data source code(s) that must be in a path.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_FIND_PATH_DEFAULT_FLAGS.
A JSON document.
Protected
getReturns entity data based on the ID of a resolved identity.
The unique identifier of an entity.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS.
A JSON document.
Returns entity data based on the ID of a record which is a member of the entity.
Identifies the provenance of the data.
The unique identifier within the records of the same data source.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_ENTITY_DEFAULT_FLAGS.
A JSON document.
returns a JSON document of a single record from the Senzing repository. Can be called as many times as desired and from multiple threads at the same time.
Identifies the provenance of the data.
The unique identifier within the records of the same data source.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_RECORD_DEFAULT_FLAGS.
A JSON document of a single record.
The preprocess_record method tests adding a record into the Senzing datastore.
A JSON document containing the record to be tested.
Flags used to control information returned. Defaults to 0.
A JSON document containing metadata as specified by the flags.
creates a view of a virtual entity using a list of existing loaded records. The virtual entity is composed of only those records and their features. Entity resolution is not performed.
The data source codes and record IDs identifying records to create the virtual entity from.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.
A JSON document.
Determines and details steps-by-step how records resolved to a single entity.
In most cases, how provides more detailed information than why as the resolution is detailed step-by-step.
The unique identifier of an entity.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_HOW_ENTITY_DEFAULT_FLAGS.
A JSON document.
Initializes high resource consumption components of Senzing used in some functions. If this call is not made, these resources are initialized the first time they are needed and can cause unusually long processing times the first time a function is called that requires these resources.
@returns{Promise
The reevaluate_entity method reevaluates the specified entity.
The unique identifier of an entity.
Flags used to control information returned. Defaults to 0.
The reevaluate_record method reevaluates a specific record.
Identifies the provenance of the data.
The unique identifier within the records of the same data source.
Flags used to control information returned. Defaults to 0.
A JSON document. If flags are set to return the WITH_INFO response a JSON document containing the details, otherwise an empty JSON document.
The searchByAttributes method retrieves entity data based on a user-specified set of entity attributes.
A JSON document with the attribute data to search for.
Defaults to SzEngineFlags.SZ_SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS.
The name of a configured search profile. Defaults to "SEARCH".
A JSON document as Promise
Wait for the client to be ready. The callback will be called when the client has successfully connected to the server, and it will be called with an error if the attempt to connect to the server has unrecoverablly failed or if the deadline expires. This function will make the channel start connecting if it has not already done so.
The why_entities method determines why entities did not resolve or why they do relate.
The entity ID for the starting entity of the search path.
The entity ID for the ending entity of the search path.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.
A JSON document as Promise
Determines why a record is included in an entity.
Identifies the provenance of the data.
The unique identifier within the records of the same data source.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS.
A JSON document as Promise
The why_records determines if any two records can or cannot resolve together, or if they relate.
Identifies the provenance of the data.
The unique identifier within the records of the same data source.
Identifies the provenance of the data.
The unique identifier within the records of the same data source.
Flags used to control information returned. Defaults to SzEngineFlags.SZ_WHY_ENTITY_DEFAULT_FLAGS
A JSON document as Promise
Compares the specified search attribute criteria against the entity identified by the specified entity ID to determine why that entity was or was not included in the results of a #searchByAttributes(String, String, Set) "search by attributes" operation.
The specified search attributes are treated as a hypothetical single-record entity and the result of this operation is the #whyEntities(long, long, Set) "why analysis" of the entity identified by the specified entity ID against that hypothetical entity. The details included in the response are determined by the specified flags.
If the specified search profile is null
then the default
generic thresholds from the default search profile will be used for the
search candidate determination. If your search requires different behavior
using alternate generic thresholds, please contact
support@senzing.com for details
on configuring a custom search profile.
The search attributes defining the hypothetical record to match and/or relate to in order to obtain the search results.
The entity ID identifying the entity to analyze against the search attribute criteria.
The optional search profile identifier, or
null
if the default search profile
should be used for the search.
The optional Set of SzFlag instances belonging
to the SzFlagUsageGroup#SZ_WHY_SEARCH_FLAGS group t
control how the operation is performed and the content of the
response, or null
to default to SzFlag#SZ_NO_FLAGS or SzFlag#SZ_WHY_SEARCH_DEFAULT_FLAGS
for the default recommended flags.
The resulting JSON String describing the result of the why analysis against the search criteria.
SzGrpcEngine Access the Senzing Engine module via gRPC