Class SzEngine

Constructors

constructor

new SzEngine(): SzEngine
Returns SzEngine

Methods

primeEngine

primeEngine(): void
Primes the engine for optimal performance by loading internal caches.

Returns void
- Defined in packages/sdk/index.d.ts:51
primeEngine(): void
Primes the engine for optimal performance by loading internal caches.

Returns void
Example: Prime the engine after initialization
```
const engine = env.getEngine();
engine.primeEngine();
console.log("Engine caches loaded");
```
See
engine-priming snippet
- Defined in packages/sdk/sdk.d.ts:377

getStats

getStats(): string
Gets engine performance statistics as a JSON string.

Returns string
- Defined in packages/sdk/index.d.ts:53
getStats(): string
Gets engine performance statistics as a JSON string.

Returns string
Example: Log engine statistics
```
const stats = JSON.parse(engine.getStats());
console.log("Workload stats:", JSON.stringify(stats.workload, null, 2));
```
See
engine-priming snippet
- Defined in packages/sdk/sdk.d.ts:390

addRecord

addRecord(
    dataSourceCode: string,
    recordId: string,
    recordDefinition: string,
    flags?: bigint,
): string
Adds a record for entity resolution.

Inserts or updates a record in the entity repository.
Parameters
- dataSourceCode: string
- recordId: string
- recordDefinition: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:59
addRecord(
    dataSourceCode: string,
    recordId: string,
    recordDefinition: string,
    flags?: bigint,
): string
Adds a record for entity resolution.
Parameters
- dataSourceCode: string
- recordId: string
- recordDefinition: string
- Optionalflags: bigint
Returns string
Example: Add a record with WITH_INFO
```
const info = engine.addRecord(
  "CUSTOMERS", "1001",
  JSON.stringify({ NAME_FULL: "Robert Smith", DATE_OF_BIRTH: "1985-02-15" }),
  SzFlags.WITH_INFO,
);
const affected = JSON.parse(info).AFFECTED_ENTITIES;
```
See
- load-records snippet
- load-with-info snippet
- Defined in packages/sdk/sdk.d.ts:196

deleteRecord

deleteRecord(dataSourceCode: string, recordId: string, flags?: bigint): string
Deletes a record from the entity repository.
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:61
deleteRecord(dataSourceCode: string, recordId: string, flags?: bigint): string
Deletes a record from the entity repository.
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns string
Example: Delete a record
```
const info = engine.deleteRecord("CUSTOMERS", "1001", SzFlags.WITH_INFO);
console.log("Affected entities:", JSON.parse(info).AFFECTED_ENTITIES);
```
See
- delete-records snippet
- delete-loop snippet
- Defined in packages/sdk/sdk.d.ts:210

reevaluateRecord

reevaluateRecord(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): string
Reevaluates a specific record against current resolution rules.
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:63

reevaluateEntity

reevaluateEntity(entityId: number, flags?: bigint): string
Reevaluates all records for a specific entity.
Parameters
- entityId: number
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:65
reevaluateEntity(entityId: number, flags?: bigint): string
Reevaluates all records for a specific entity.
Parameters
- entityId: number
- Optionalflags: bigint
Returns string
Example: Reevaluate an entity after rule changes
```
const info = engine.reevaluateEntity(1, SzFlags.WITH_INFO);
const affected = JSON.parse(info).AFFECTED_ENTITIES;
console.log("Reevaluation affected:", affected.length, "entities");
```
See
- force-resolve snippet
- force-unresolve snippet
- Defined in packages/sdk/sdk.d.ts:405

getRecord

getRecord(dataSourceCode: string, recordId: string, flags?: bigint): string
Gets record information by data source and record ID.
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:67

getRecordPreview

getRecordPreview(recordDefinition: string, flags?: bigint): string
Gets a preview of how a record would be processed without persisting it.
Parameters
- recordDefinition: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:69

getEntityById

getEntityById(entityId: number, flags?: bigint): string
Gets entity information by entity ID.
Parameters
- entityId: number
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:71
getEntityById(entityId: number, flags?: bigint): string
Gets entity information by entity ID.
Parameters
- entityId: number
- Optionalflags: bigint
Returns string
Example: Retrieve an entity by ID
```
const result = engine.getEntityById(1, SzFlags.ENTITY_DEFAULT_FLAGS);
const entity = JSON.parse(result).RESOLVED_ENTITY;
console.log("Entity name:", entity.ENTITY_NAME);
```
See
search-records snippet
- Defined in packages/sdk/sdk.d.ts:224

getEntityByRecord

getEntityByRecord(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): string
Gets entity information by record key (data source + record ID).
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:73
getEntityByRecord(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): string
Gets entity information by record key (data source + record ID).
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns string
Example: Retrieve an entity by its source record
```
const result = engine.getEntityByRecord(
  "CUSTOMERS", "1001",
  SzFlags.ENTITY_DEFAULT_FLAGS,
);
const entity = JSON.parse(result).RESOLVED_ENTITY;
console.log("Entity ID:", entity.ENTITY_ID);
```
See
load-with-info snippet
- Defined in packages/sdk/sdk.d.ts:241

searchByAttributes

searchByAttributes(
    attributes: string,
    searchProfile?: string,
    flags?: bigint,
): string
Searches for entities by attributes.
Parameters
- attributes: string
- OptionalsearchProfile: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:75

searchByAttributes(
    attributes: string,
    searchProfile?: string,
    flags?: bigint,
): string

Searches for entities by attributes.

Parameters

attributes: string
OptionalsearchProfile: string
Optionalflags: bigint

Returns string

Example: Search for matching entities

const attrs = JSON.stringify({ NAME_FULL: "Robert Smith", DATE_OF_BIRTH: "1985-02-15" });
const result = engine.searchByAttributes(attrs, undefined, SzFlags.SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS);
const entities = JSON.parse(result).RESOLVED_ENTITIES;
console.log(`Found ${entities.length} matching entities`);

See

whySearch

whySearch(
    attributes: string,
    entityId: number,
    searchProfile?: string,
    flags?: bigint,
): string
Analyzes why a search result was returned for an entity.
Parameters
- attributes: string
- entityId: number
- OptionalsearchProfile: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:77

whyEntities

whyEntities(entityId1: number, entityId2: number, flags?: bigint): string
Analyzes why two entities are related.
Parameters
- entityId1: number
- entityId2: number
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:79
whyEntities(entityId1: number, entityId2: number, flags?: bigint): string
Analyzes why two entities are related.
Parameters
- entityId1: number
- entityId2: number
- Optionalflags: bigint
Returns string
Example: Compare two entities
```
const result = engine.whyEntities(1, 2, SzFlags.WHY_ENTITIES_DEFAULT_FLAGS);
const whyResults = JSON.parse(result).WHY_RESULTS;
console.log("Match level:", whyResults[0].MATCH_INFO.WHY_KEY);
```
See
why-search snippet
- Defined in packages/sdk/sdk.d.ts:271

whyRecords

whyRecords(
    dsCode1: string,
    recId1: string,
    dsCode2: string,
    recId2: string,
    flags?: bigint,
): string
Analyzes why two records resolved together.
Parameters
- dsCode1: string
- recId1: string
- dsCode2: string
- recId2: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:81
whyRecords(
    dsCode1: string,
    recId1: string,
    dsCode2: string,
    recId2: string,
    flags?: bigint,
): string
Analyzes why two records resolved together.
Parameters
- dsCode1: string
- recId1: string
- dsCode2: string
- recId2: string
- Optionalflags: bigint
Returns string
Example: Why two records resolved
```
const result = engine.whyRecords(
  "CUSTOMERS", "1001",
  "WATCHLIST", "2001",
  SzFlags.WHY_RECORDS_DEFAULT_FLAGS,
);
const whyResults = JSON.parse(result).WHY_RESULTS;
console.log("Match key:", whyResults[0].MATCH_INFO.MATCH_KEY);
```
See
why-search snippet
- Defined in packages/sdk/sdk.d.ts:289

whyRecordInEntity

whyRecordInEntity(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): string
Analyzes why a record belongs to its current entity.
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:83

howEntity

howEntity(entityId: number, flags?: bigint): string
Analyzes how an entity was constructed step by step.
Parameters
- entityId: number
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:85

getVirtualEntity

getVirtualEntity(recordKeys: RecordKey[], flags?: bigint): string
Creates a virtual entity from record keys without persisting.
Parameters
- recordKeys: RecordKey[]
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:87

findInterestingEntitiesById

findInterestingEntitiesById(entityId: number, flags?: bigint): string
Finds interesting entities related to a given entity by entity ID.
Parameters
- entityId: number
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:89

findInterestingEntitiesByRecord

findInterestingEntitiesByRecord(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): string
Finds interesting entities related to a given entity by record key.
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:91

findPath

findPath(
    startEntityId: number,
    endEntityId: number,
    maxDegrees: number,
    avoidEntityIds?: number[],
    requiredDataSources?: string[],
    flags?: bigint,
): string
Finds a relationship path between two entities.
Parameters
- startEntityId: number
- endEntityId: number
- maxDegrees: number
- OptionalavoidEntityIds: number[]
- OptionalrequiredDataSources: string[]
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:93
findPath(
    startEntityId: number,
    endEntityId: number,
    maxDegrees: number,
    avoidEntityIds?: number[],
    requiredDataSources?: string[],
    flags?: bigint,
): string
Finds a relationship path between two entities.
Parameters
- startEntityId: number
- endEntityId: number
- maxDegrees: number
- OptionalavoidEntityIds: number[]
- OptionalrequiredDataSources: string[]
- Optionalflags: bigint
Returns string
Example: Find a path between two entities
```
const result = engine.findPath(
  1, 2, 3,
  undefined, undefined,
  SzFlags.FIND_PATH_DEFAULT_FLAGS,
);
const path = JSON.parse(result).ENTITY_PATHS[0];
console.log("Path length:", path.ENTITIES.length);
```
See
search-records snippet
- Defined in packages/sdk/sdk.d.ts:423

findNetwork

findNetwork(
    entityIds: number[],
    maxDegrees: number,
    buildOutDegree: number,
    maxEntities: number,
    flags?: bigint,
): string
Finds a network of related entities starting from seed entity IDs.
Parameters
- entityIds: number[]
- maxDegrees: number
- buildOutDegree: number
- maxEntities: number
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:95
findNetwork(
    entityIds: number[],
    maxDegrees: number,
    buildOutDegree: number,
    maxEntities: number,
    flags?: bigint,
): string
Finds a network of related entities starting from seed entity IDs.
Parameters
- entityIds: number[]
- maxDegrees: number
- buildOutDegree: number
- maxEntities: number
- Optionalflags: bigint
Returns string
Example: Build a network around seed entities
```
const result = engine.findNetwork(
  [1, 2], 3, 1, 100,
  SzFlags.FIND_NETWORK_DEFAULT_FLAGS,
);
const network = JSON.parse(result);
console.log("Entities in network:", network.ENTITY_PATHS.length);
```
See
search-records snippet
- Defined in packages/sdk/sdk.d.ts:440

getRedoRecord

getRedoRecord(): string
Gets the next pending redo record from the queue.

Returns string
- Defined in packages/sdk/index.d.ts:97
getRedoRecord(): string
Gets the next pending redo record from the queue.

Returns string
Example: Fetch the next redo record
```
const redo = engine.getRedoRecord();
if (redo) {
  const info = engine.processRedoRecord(redo, SzFlags.WITH_INFO);
  console.log("Processed redo:", JSON.parse(info).AFFECTED_ENTITIES);
}
```
See
- redo-continuous snippet
- redo-with-info snippet
- Defined in packages/sdk/sdk.d.ts:346

countRedoRecords

countRedoRecords(): number
Counts pending redo records in the queue.

Returns number
- Defined in packages/sdk/index.d.ts:99
countRedoRecords(): number
Counts pending redo records in the queue.

Returns number
Example: Check for pending redo records
```
const count = engine.countRedoRecords();
console.log(`${count} redo records pending`);
```
See
- redo-continuous snippet
- load-with-redo snippet
- Defined in packages/sdk/sdk.d.ts:329

processRedoRecord

processRedoRecord(redoRecord: string, flags?: bigint): string
Processes a redo record for deferred resolution.
Parameters
- redoRecord: string
- Optionalflags: bigint
Returns string
- Defined in packages/sdk/index.d.ts:101
processRedoRecord(redoRecord: string, flags?: bigint): string
Processes a redo record for deferred resolution.
Parameters
- redoRecord: string
- Optionalflags: bigint
Returns string
Example: Process a redo record with info
```
const redo = engine.getRedoRecord();
if (redo) {
  const info = engine.processRedoRecord(redo, SzFlags.WITH_INFO);
  console.log("Affected:", JSON.parse(info).AFFECTED_ENTITIES);
}
```
See
- redo-with-info snippet
- redo-worker-pool snippet
- Defined in packages/sdk/sdk.d.ts:363

exportJsonEntityReport

exportJsonEntityReport(flags?: bigint): number
Starts a JSON entity export. Returns an export handle.
Parameters
- Optionalflags: bigint
Returns number
- Defined in packages/sdk/index.d.ts:103

exportJsonEntityReport(flags?: bigint): SzExportIterator

Starts a JSON entity export. Returns an SzExportIterator.

Parameters

Optionalflags: bigint

Returns SzExportIterator

Example: Stream all resolved entities

const iter = engine.exportJsonEntityReport(SzFlags.EXPORT_DEFAULT_FLAGS);
for (const chunk of iter) {
  const lines = chunk.split("\n").filter(Boolean);
  for (const line of lines) {
    const entity = JSON.parse(line);
    console.log("Entity:", entity.RESOLVED_ENTITY.ENTITY_ID);
  }
}

See

load-records snippet

exportCsvEntityReport

exportCsvEntityReport(csvColumnList: string, flags?: bigint): number
Starts a CSV entity export. Returns an export handle.
Parameters
- csvColumnList: string
- Optionalflags: bigint
Returns number
- Defined in packages/sdk/index.d.ts:105
exportCsvEntityReport(csvColumnList: string, flags?: bigint): SzExportIterator
Starts a CSV entity export. Returns an SzExportIterator.
Parameters
- csvColumnList: string
- Optionalflags: bigint
Returns SzExportIterator
See
load-records snippet
- Defined in packages/sdk/sdk.d.ts:315

fetchNext

fetchNext(exportHandle: number): string
Fetches the next batch of export data. Returns empty string when complete.
Parameters
- exportHandle: number
Returns string
- Defined in packages/sdk/index.d.ts:107

closeExport

closeExport(exportHandle: number): void
Closes an export operation and releases resources.
Parameters
- exportHandle: number
Returns void
- Defined in packages/sdk/index.d.ts:109

Class SzEngine

Index

Constructors

Methods

Constructors

constructor

Returns SzEngine

Methods

primeEngine

Returns void

Returns void

Example: Prime the engine after initialization

See

getStats

Returns string

Returns string

Example: Log engine statistics

See

addRecord

Parameters

Returns string

Parameters

Returns string

Example: Add a record with WITH_INFO

See

deleteRecord

Parameters

Returns string

Parameters

Returns string

Example: Delete a record

See

reevaluateRecord

Parameters

Returns string

reevaluateEntity

Parameters

Returns string

Parameters

Returns string

Example: Reevaluate an entity after rule changes

See

getRecord

Parameters

Returns string

getRecordPreview

Parameters

Returns string

getEntityById

Parameters

Returns string

Parameters

Returns string

Example: Retrieve an entity by ID

See

getEntityByRecord

Parameters

Returns string

Parameters

Returns string

Example: Retrieve an entity by its source record

See

searchByAttributes

Parameters

Returns string

Parameters

Returns string

Example: Search for matching entities

See

whySearch

Parameters

Returns string

whyEntities

Parameters

Returns string

Parameters

Returns string

Example: Compare two entities

See

whyRecords