Senzing Node.js SDK

Node.js/TypeScript bindings for Senzing v4 entity resolution, built with NAPI-RS.

Packages

Quick Start

npm install @senzing/sdk @senzing/configtool
Copy

import { SzEnvironment, SzFlags } from "@senzing/sdk";
import { addDataSource } from "@senzing/configtool";

const settings = JSON.stringify({
  PIPELINE: {
    CONFIGPATH: "/opt/senzing/er/resources/templates",
    RESOURCEPATH: "/opt/senzing/er/resources",
    SUPPORTPATH: "/opt/senzing/data",
  },
  SQL: { CONNECTION: "sqlite3://na:na@/tmp/senzing.db" },
});

const env = new SzEnvironment("my-app", settings);

try {
  // Bootstrap configuration with data sources
  const cm = env.getConfigManager();
  let cfg = cm.createConfig();
  cfg = addDataSource(cfg, { code: "CUSTOMERS" });
  env.reinitialize(cm.setDefaultConfig(cfg, "Initial config"));

  // Add and resolve records
  const engine = env.getEngine();
  engine.addRecord(
    "CUSTOMERS",
    "1001",
    JSON.stringify({ NAME_FULL: "Robert Smith", DATE_OF_BIRTH: "1985-02-15" }),
    SzFlags.WITH_INFO,
  );

  // Search by attributes
  const result = engine.searchByAttributes(
    JSON.stringify({ NAME_FULL: "Bob Smith" }),
    undefined,
    SzFlags.SEARCH_BY_ATTRIBUTES_DEFAULT_FLAGS,
  );
  console.log(JSON.parse(result));
} finally {
  env.destroy();
}
Copy

Guides

• Getting Started -- Install the runtime, create your first entity
• Configuration Lifecycle -- Create, edit, register, and activate configs
• Error Handling -- Error hierarchy, instanceof patterns, retry logic
• Deployment -- Docker, PostgreSQL, monitoring, worker threads
• Code Snippets -- 27 runnable examples covering every SDK operation

API Reference

Browse the full API reference using the sidebar navigation:

• SzEnvironment -- Lifecycle management, subsystem access
• SzEngine -- Record operations, entity resolution, search, export
• SzConfigManager -- Configuration management
• SzDiagnostic -- Performance benchmarks, repository management
• SzProduct -- Version and license information
• SzFlags -- Flag constants (bigint values)
• SzError -- Structured error hierarchy

Platform Support

Examples and Code Snippets

The repository includes 6 full examples and 27 focused code snippets covering: