The core Senzing entity-resolution engine. More...

#include <SzEngine.hpp>

Inheritance diagram for senzing::sdk::SzEngine:

Public Member Functions
virtual	~SzEngine ()=default

virtual void	PrimeEngine ()=0
	Pre-loads engine resources to reduce first-call latency.

virtual std::string	GetStats ()=0
	Returns JSON workload statistics for this engine instance.

virtual std::string	AddRecord (const std::string &dataSourceCode, const std::string &recordID, const std::string &recordDefinition, SzFlags flags=SzAddRecordDefaultFlags)=0

virtual std::string	GetRecordPreview (const std::string &recordDefinition, SzFlags flags=SzRecordPreviewDefaultFlags)=0

virtual std::string	DeleteRecord (const std::string &dataSourceCode, const std::string &recordID, SzFlags flags=SzDeleteRecordDefaultFlags)=0

virtual std::string	ReevaluateRecord (const std::string &dataSourceCode, const std::string &recordID, SzFlags flags=SzReevaluateRecordDefaultFlags)=0

virtual std::string	ReevaluateEntity (int64_t entityID, SzFlags flags=SzReevaluateEntityDefaultFlags)=0

virtual std::string	SearchByAttributes (const std::string &attributes, const std::string &searchProfile, SzFlags flags=SzSearchByAttributesDefaultFlags)=0

virtual std::string	SearchByAttributes (const std::string &attributes, SzFlags flags=SzSearchByAttributesDefaultFlags)=0

virtual std::string	WhySearch (const std::string &attributes, int64_t entityID, const std::string &searchProfile="", SzFlags flags=SzWhySearchDefaultFlags)=0

virtual std::string	GetEntity (int64_t entityID, SzFlags flags=SzEntityDefaultFlags)=0

virtual std::string	GetEntity (const std::string &dataSourceCode, const std::string &recordID, SzFlags flags=SzEntityDefaultFlags)=0

virtual std::string	GetRecord (const std::string &dataSourceCode, const std::string &recordID, SzFlags flags=SzRecordDefaultFlags)=0

virtual std::string	FindInterestingEntities (int64_t entityID, SzFlags flags=SzFindInterestingEntitiesDefaultFlags)=0

virtual std::string	FindInterestingEntities (const std::string &dataSourceCode, const std::string &recordID, SzFlags flags=SzFindInterestingEntitiesDefaultFlags)=0

virtual std::string	FindPath (int64_t startEntityID, int64_t endEntityID, int32_t maxDegrees, const std::set< int64_t > &avoidEntityIDs={}, const std::set< std::string > &requiredDataSources={}, SzFlags flags=SzFindPathDefaultFlags)=0

virtual std::string	FindPath (const std::string &startDataSourceCode, const std::string &startRecordID, const std::string &endDataSourceCode, const std::string &endRecordID, int32_t maxDegrees, const std::set< std::pair< std::string, std::string > > &avoidRecordKeys={}, const std::set< std::string > &requiredDataSources={}, SzFlags flags=SzFindPathDefaultFlags)=0

virtual std::string	FindNetwork (const std::set< int64_t > &entityIDs, int32_t maxDegrees, int32_t buildOutDegrees, int32_t buildOutMaxEntities, SzFlags flags=SzFindNetworkDefaultFlags)=0

virtual std::string	FindNetwork (const std::set< std::pair< std::string, std::string > > &recordKeys, int32_t maxDegrees, int32_t buildOutDegrees, int32_t buildOutMaxEntities, SzFlags flags=SzFindNetworkDefaultFlags)=0

virtual std::string	WhyRecordInEntity (const std::string &dataSourceCode, const std::string &recordID, SzFlags flags=SzWhyRecordInEntityDefaultFlags)=0

virtual std::string	WhyRecords (const std::string &dataSourceCode1, const std::string &recordID1, const std::string &dataSourceCode2, const std::string &recordID2, SzFlags flags=SzWhyRecordsDefaultFlags)=0

virtual std::string	WhyEntities (int64_t entityID1, int64_t entityID2, SzFlags flags=SzWhyEntitiesDefaultFlags)=0

virtual std::string	HowEntity (int64_t entityID, SzFlags flags=SzHowEntityDefaultFlags)=0

virtual std::string	GetVirtualEntity (const std::set< std::pair< std::string, std::string > > &recordKeys, SzFlags flags=SzVirtualEntityDefaultFlags)=0

virtual SzExportHandle	ExportJsonEntityReport (SzFlags flags=SzExportDefaultFlags)=0

virtual SzExportHandle	ExportCsvEntityReport (const std::string &csvColumnList, SzFlags flags=SzExportDefaultFlags)=0

virtual std::string	FetchNext (SzExportHandle exportHandle)=0

virtual void	CloseExportReport (SzExportHandle exportHandle)=0

virtual std::string	ProcessRedoRecord (const std::string &redoRecord, SzFlags flags=SzRedoDefaultFlags)=0

virtual std::string	GetRedoRecord ()=0

virtual int64_t	CountRedoRecords ()=0

Detailed Description

The core Senzing entity-resolution engine.

Constructor & Destructor Documentation

◆ ~SzEngine()

virtual senzing::sdk::SzEngine::~SzEngine ( )

virtualdefault

Member Function Documentation

◆ AddRecord()

virtual std::string senzing::sdk::SzEngine::AddRecord	(	const std::string &	dataSourceCode,
		const std::string &	recordID,
		const std::string &	recordDefinition,
		SzFlags	flags = `SzAddRecordDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ CloseExportReport()

virtual void senzing::sdk::SzEngine::CloseExportReport ( SzExportHandle exportHandle )

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ CountRedoRecords()

virtual int64_t senzing::sdk::SzEngine::CountRedoRecords ( )

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ DeleteRecord()

virtual std::string senzing::sdk::SzEngine::DeleteRecord	(	const std::string &	dataSourceCode,
		const std::string &	recordID,
		SzFlags	flags = `SzDeleteRecordDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ ExportCsvEntityReport()

virtual SzExportHandle senzing::sdk::SzEngine::ExportCsvEntityReport	(	const std::string &	csvColumnList,
		SzFlags	flags = `SzExportDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ ExportJsonEntityReport()

virtual SzExportHandle senzing::sdk::SzEngine::ExportJsonEntityReport ( SzFlags flags = SzExportDefaultFlags )

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ FetchNext()

virtual std::string senzing::sdk::SzEngine::FetchNext ( SzExportHandle exportHandle )

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ FindInterestingEntities() [1/2]

virtual std::string senzing::sdk::SzEngine::FindInterestingEntities	(	const std::string &	dataSourceCode,
		const std::string &	recordID,
		SzFlags	flags = `SzFindInterestingEntitiesDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ FindInterestingEntities() [2/2]

virtual std::string senzing::sdk::SzEngine::FindInterestingEntities	(	int64_t	entityID,
		SzFlags	flags = `SzFindInterestingEntitiesDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ FindNetwork() [1/2]

virtual std::string senzing::sdk::SzEngine::FindNetwork	(	const std::set< int64_t > &	entityIDs,
		int32_t	maxDegrees,
		int32_t	buildOutDegrees,
		int32_t	buildOutMaxEntities,
		SzFlags	flags = `SzFindNetworkDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ FindNetwork() [2/2]

virtual std::string senzing::sdk::SzEngine::FindNetwork	(	const std::set< std::pair< std::string, std::string > > &	recordKeys,
		int32_t	maxDegrees,
		int32_t	buildOutDegrees,
		int32_t	buildOutMaxEntities,
		SzFlags	flags = `SzFindNetworkDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ FindPath() [1/2]

virtual std::string senzing::sdk::SzEngine::FindPath	(	const std::string &	startDataSourceCode,
		const std::string &	startRecordID,
		const std::string &	endDataSourceCode,
		const std::string &	endRecordID,
		int32_t	maxDegrees,
		const std::set< std::pair< std::string, std::string > > &	avoidRecordKeys = `{}`,
		const std::set< std::string > &	requiredDataSources = `{}`,
		SzFlags	flags = `SzFindPathDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ FindPath() [2/2]

virtual std::string senzing::sdk::SzEngine::FindPath	(	int64_t	startEntityID,
		int64_t	endEntityID,
		int32_t	maxDegrees,
		const std::set< int64_t > &	avoidEntityIDs = `{}`,
		const std::set< std::string > &	requiredDataSources = `{}`,
		SzFlags	flags = `SzFindPathDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ GetEntity() [1/2]

virtual std::string senzing::sdk::SzEngine::GetEntity	(	const std::string &	dataSourceCode,
		const std::string &	recordID,
		SzFlags	flags = `SzEntityDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ GetEntity() [2/2]

virtual std::string senzing::sdk::SzEngine::GetEntity	(	int64_t	entityID,
		SzFlags	flags = `SzEntityDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ GetRecord()

virtual std::string senzing::sdk::SzEngine::GetRecord	(	const std::string &	dataSourceCode,
		const std::string &	recordID,
		SzFlags	flags = `SzRecordDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ GetRecordPreview()

virtual std::string senzing::sdk::SzEngine::GetRecordPreview	(	const std::string &	recordDefinition,
		SzFlags	flags = `SzRecordPreviewDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ GetRedoRecord()

virtual std::string senzing::sdk::SzEngine::GetRedoRecord ( )

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ GetStats()

virtual std::string senzing::sdk::SzEngine::GetStats ( )

pure virtual

Returns JSON workload statistics for this engine instance.

Implemented in senzing::sdk::core::SzCoreEngine.

◆ GetVirtualEntity()

virtual std::string senzing::sdk::SzEngine::GetVirtualEntity	(	const std::set< std::pair< std::string, std::string > > &	recordKeys,
		SzFlags	flags = `SzVirtualEntityDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ HowEntity()

virtual std::string senzing::sdk::SzEngine::HowEntity	(	int64_t	entityID,
		SzFlags	flags = `SzHowEntityDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ PrimeEngine()

virtual void senzing::sdk::SzEngine::PrimeEngine ( )

pure virtual

Pre-loads engine resources to reduce first-call latency.

Implemented in senzing::sdk::core::SzCoreEngine.

◆ ProcessRedoRecord()

virtual std::string senzing::sdk::SzEngine::ProcessRedoRecord	(	const std::string &	redoRecord,
		SzFlags	flags = `SzRedoDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ ReevaluateEntity()

virtual std::string senzing::sdk::SzEngine::ReevaluateEntity	(	int64_t	entityID,
		SzFlags	flags = `SzReevaluateEntityDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ ReevaluateRecord()

virtual std::string senzing::sdk::SzEngine::ReevaluateRecord	(	const std::string &	dataSourceCode,
		const std::string &	recordID,
		SzFlags	flags = `SzReevaluateRecordDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ SearchByAttributes() [1/2]

virtual std::string senzing::sdk::SzEngine::SearchByAttributes	(	const std::string &	attributes,
		const std::string &	searchProfile,
		SzFlags	flags = `SzSearchByAttributesDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ SearchByAttributes() [2/2]

virtual std::string senzing::sdk::SzEngine::SearchByAttributes	(	const std::string &	attributes,
		SzFlags	flags = `SzSearchByAttributesDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ WhyEntities()

virtual std::string senzing::sdk::SzEngine::WhyEntities	(	int64_t	entityID1,
		int64_t	entityID2,
		SzFlags	flags = `SzWhyEntitiesDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ WhyRecordInEntity()

virtual std::string senzing::sdk::SzEngine::WhyRecordInEntity	(	const std::string &	dataSourceCode,
		const std::string &	recordID,
		SzFlags	flags = `SzWhyRecordInEntityDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ WhyRecords()

virtual std::string senzing::sdk::SzEngine::WhyRecords	(	const std::string &	dataSourceCode1,
		const std::string &	recordID1,
		const std::string &	dataSourceCode2,
		const std::string &	recordID2,
		SzFlags	flags = `SzWhyRecordsDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

◆ WhySearch()

virtual std::string senzing::sdk::SzEngine::WhySearch	(	const std::string &	attributes,
		int64_t	entityID,
		const std::string &	searchProfile = `""`,
		SzFlags	flags = `SzWhySearchDefaultFlags`
	)

pure virtual

Implemented in senzing::sdk::core::SzCoreEngine.

The documentation for this class was generated from the following file:

senzing/sdk/SzEngine.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~SzEngine()

Member Function Documentation

◆ AddRecord()

◆ CloseExportReport()

◆ CountRedoRecords()

◆ DeleteRecord()

◆ ExportCsvEntityReport()

◆ ExportJsonEntityReport()

◆ FetchNext()

◆ FindInterestingEntities() [1/2]

◆ FindInterestingEntities() [2/2]

◆ FindNetwork() [1/2]

◆ FindNetwork() [2/2]

◆ FindPath() [1/2]

◆ FindPath() [2/2]

◆ GetEntity() [1/2]

◆ GetEntity() [2/2]

◆ GetRecord()

◆ GetRecordPreview()

◆ GetRedoRecord()

◆ GetStats()

◆ GetVirtualEntity()

◆ HowEntity()

◆ PrimeEngine()

◆ ProcessRedoRecord()

◆ ReevaluateEntity()

◆ ReevaluateRecord()

◆ SearchByAttributes() [1/2]

◆ SearchByAttributes() [2/2]

◆ WhyEntities()

◆ WhyRecordInEntity()

◆ WhyRecords()

◆ WhySearch()