n8n-nodes-entity-enricher 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 TOT Concept
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,137 @@
+# n8n-nodes-entity-enricher
+
+[![npm version](https://img.shields.io/npm/v/n8n-nodes-entity-enricher.svg)](https://www.npmjs.com/package/n8n-nodes-entity-enricher)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+An [n8n](https://n8n.io/) community node that integrates with [Entity Enricher](https://entityenricher.ai) — a multi-model LLM enrichment platform with schema-driven structured output, multilingual support, and automated fusion.
+
+![Single entity enrichment workflow](https://entityenricher.ai/docs/N8NSingleEntity.png)
+
+## Installation
+
+### From the n8n UI
+
+1. Go to **Settings > Community Nodes**
+2. Click **Install a community node**
+3. Enter `n8n-nodes-entity-enricher`
+4. Click **Install**
+
+### From the command line
+
+```bash
+npm install n8n-nodes-entity-enricher
+```
+
+## Prerequisites
+
+1. An Entity Enricher instance (cloud or self-hosted)
+2. An API key (create one in **API Keys > App Access Keys**)
+
+### Credential Setup
+
+1. In n8n, go to **Credentials > New Credential**
+2. Search for **Entity Enricher API**
+3. Enter your API key (format: `ent_XXXXXXXXXXXX`)
+4. Set the Base URL (default: `https://entityenricher.ai`)
+
+The credential is verified against the API on save.
+
+## Operations
+
+| Category | Operation | Description |
+|----------|-----------|-------------|
+| **Enrichment** | Enrich Entity | Enrich a single entity using one or more LLM models with SSE streaming |
+| **Enrichment** | Batch Enrich | Enrich all input items as a single batch with parallel execution |
+| **Schema** | List Schemas | List available saved schemas |
+| **Schema** | Get Schema Details | Get full schema content with extracted search key properties |
+| **Record** | List Records | Query enrichment records with pagination and filters |
+| **Record** | Get Record | Retrieve a specific enrichment result by ID |
+| **Fusion** | Merge Results | Merge multiple model results with optional LLM arbitration |
+| **Configuration** | Get Options | Get available models, languages, and strategies |
+
+## Single Entity Enrichment
+
+Enrich a single entity against a schema with one or more LLM models.
+
+**Configuration:**
+
+![Node configuration for single enrichment](https://entityenricher.ai/docs/N8NConnectorEnrichment.png)
+
+- **Schema**: Select from saved schemas (dynamic dropdown, pinned schemas shown first)
+- **Models**: Choose one or more models (pricing displayed per model)
+- **Languages**: Output languages (English always included)
+- **Strategy**: `multi_expertise` (parallel per-domain) or `single_pass`
+- **Classification Model** *(optional)*: Pre-flight entity type verification to prevent hallucination
+- **Arbitration Model** *(optional)*: LLM-based conflict resolution when using multiple models
+- **Timeout**: Max wait time (default: 5 minutes)
+
+**Output:**
+
+```json
+{
+  "result": { "company_name": "Pfizer", "headquarters": "New York", "..." : "..." },
+  "record_id": "uuid",
+  "success": true,
+  "is_fused": true,
+  "cost_usd": 0.0042,
+  "input_tokens": 1250,
+  "output_tokens": 890,
+  "processing_time_ms": 3200,
+  "fusion": { "agreed_fields": 18, "conflicted_fields": 2, "total_fields": 20 },
+  "source_models": ["anthropic::claude-sonnet-4-5", "openai::gpt-4o"]
+}
+```
+
+Toggle **Include Per-Model Results** to also output individual model results alongside the fused output.
+
+## Batch Enrichment
+
+Enrich all input items in a single batch with parallel execution and per-provider rate limiting.
+
+![Batch enrichment workflow](https://entityenricher.ai/docs/N8NBatchEntities.png)
+
+Each input item is treated as one entity. The node outputs one item per entity with the enrichment result, making it easy to chain with database upserts or further processing.
+
+![Batch enrichment configuration](https://entityenricher.ai/docs/N8NConnectorBatchEnrich.png)
+
+## Key Features
+
+- **Dynamic dropdowns** — Schemas, models, languages, and strategies are loaded from the API at configuration time
+- **SSE streaming** — Uses server-sent events internally to wait for job completion with automatic lifecycle management (pause/continue/cancel)
+- **Auto-continue** — Automatically continues past classification mismatch pauses (non-interactive)
+- **Search key validation** — Validates that input entities contain the required search keys from the schema
+- **Multi-model fusion** — When using 2+ models, results are automatically merged with field-level conflict detection. Conflicts are resolved via **rule-based merging** (majority vote, median, union) by default, or via **LLM arbitration** when an arbitration model is selected. Fusion can also be triggered manually on existing records with the **Merge Results** operation
+- **Inactivity timeout** — The timeout resets on each progress event, so large batches won't time out as long as entities keep completing. The job is automatically cancelled if no event arrives within the configured period (default: 5 minutes)
+
+## Workflow Ideas
+
+| Pattern | Description |
+|---------|-------------|
+| **CRM Enrichment** | Webhook trigger > Extract company > Enrich > Upsert to CRM |
+| **Spreadsheet Pipeline** | Read CSV/Google Sheet > Batch Enrich > Write enriched data back |
+| **Waterfall Enrichment** | Enrich with cheap model > Check quality > Re-enrich failures with premium model |
+| **Scheduled Refresh** | Cron trigger > Fetch stale records > Batch re-enrich > Update database |
+| **Webhook-Driven** | HTTP webhook > Validate input > Enrich > Return result in response |
+
+## Documentation
+
+- [n8n Connector Guide](https://entityenricher.ai/docs/integrations/n8n) — Full setup and usage documentation
+- [API Integration Guide](https://entityenricher.ai/docs/api) — REST API reference and code examples
+- [API Keys](https://entityenricher.ai/docs/platform/api-keys) — Creating and managing API keys
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Lint (type check)
+npm run lint
+```
+
+## License
+
+[MIT](LICENSE)

package/dist/credentials/EntityEnricherApi.credentials.d.ts

@@ -0,0 +1,10 @@
+import type { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class EntityEnricherApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}
+//# sourceMappingURL=EntityEnricherApi.credentials.d.ts.map

package/dist/credentials/EntityEnricherApi.credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityEnricherApi.credentials.d.ts","sourceRoot":"","sources":["../../credentials/EntityEnricherApi.credentials.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,oBAAoB,EACpB,sBAAsB,EACtB,eAAe,EACf,eAAe,EACf,MAAM,cAAc,CAAC;AAEtB,qBAAa,iBAAkB,YAAW,eAAe;IACxD,IAAI,SAAuB;IAC3B,WAAW,SAAyB;IACpC,gBAAgB,SAAoC;IAEpD,UAAU,EAAE,eAAe,EAAE,CAoB3B;IAEF,YAAY,EAAE,oBAAoB,CAOhC;IAEF,IAAI,EAAE,sBAAsB,CAM1B;CACF"}

package/dist/credentials/EntityEnricherApi.credentials.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityEnricherApi = void 0;
+class EntityEnricherApi {
+    name = 'entityEnricherApi';
+    displayName = 'Entity Enricher API';
+    documentationUrl = 'https://entityenricher.ai/docs';
+    properties = [
+        {
+            displayName: 'API Key',
+            name: 'apiKey',
+            type: 'string',
+            typeOptions: { password: true },
+            required: true,
+            default: '',
+            placeholder: 'ent_...',
+            description: 'Organization access key from Entity Enricher (API Keys page)',
+        },
+        {
+            displayName: 'Base URL',
+            name: 'baseUrl',
+            type: 'string',
+            required: true,
+            default: 'https://entityenricher.ai',
+            placeholder: 'https://entityenricher.ai',
+            description: 'Base URL of your Entity Enricher instance',
+        },
+    ];
+    authenticate = {
+        type: 'generic',
+        properties: {
+            headers: {
+                'X-API-Key': '={{$credentials.apiKey}}',
+            },
+        },
+    };
+    test = {
+        request: {
+            baseURL: '={{$credentials.baseUrl}}',
+            url: '/api/enrichment/options',
+            method: 'GET',
+        },
+    };
+}
+exports.EntityEnricherApi = EntityEnricherApi;
+//# sourceMappingURL=EntityEnricherApi.credentials.js.map

package/dist/credentials/EntityEnricherApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityEnricherApi.credentials.js","sourceRoot":"","sources":["../../credentials/EntityEnricherApi.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,iBAAiB;IAC7B,IAAI,GAAG,mBAAmB,CAAC;IAC3B,WAAW,GAAG,qBAAqB,CAAC;IACpC,gBAAgB,GAAG,gCAAgC,CAAC;IAEpD,UAAU,GAAsB;QAC/B;YACC,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC/B,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE;YACX,WAAW,EAAE,SAAS;YACtB,WAAW,EAAE,8DAA8D;SAC3E;QACD;YACC,WAAW,EAAE,UAAU;YACvB,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,2BAA2B;YACpC,WAAW,EAAE,2BAA2B;YACxC,WAAW,EAAE,2CAA2C;SACxD;KACD,CAAC;IAEF,YAAY,GAAyB;QACpC,IAAI,EAAE,SAAS;QACf,UAAU,EAAE;YACX,OAAO,EAAE;gBACR,WAAW,EAAE,0BAA0B;aACvC;SACD;KACD,CAAC;IAEF,IAAI,GAA2B;QAC9B,OAAO,EAAE;YACR,OAAO,EAAE,2BAA2B;YACpC,GAAG,EAAE,yBAAyB;YAC9B,MAAM,EAAE,KAAK;SACb;KACD,CAAC;CACF;AA3CD,8CA2CC"}

package/dist/nodes/EntityEnricher/EntityEnricher.node.d.ts

@@ -0,0 +1,15 @@
+import type { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodePropertyOptions, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class EntityEnricher implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getSchemas(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getModels(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getModelsOptional(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getLanguages(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getStrategies(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+//# sourceMappingURL=EntityEnricher.node.d.ts.map

package/dist/nodes/EntityEnricher/EntityEnricher.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityEnricher.node.d.ts","sourceRoot":"","sources":["../../../nodes/EntityEnricher/EntityEnricher.node.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,SAAS,EACT,oBAAoB,EACpB,MAAM,cAAc,CAAC;AAetB,qBAAa,cAAe,YAAW,SAAS;IAC/C,WAAW,EAAE,oBAAoB,CAiZ/B;IAEF,OAAO;;6BAEkB,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;4BAqBxD,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;oCA2BtE,qBAAqB,GACzB,OAAO,CAAC,oBAAoB,EAAE,CAAC;+BAiB3B,qBAAqB,GACzB,OAAO,CAAC,oBAAoB,EAAE,CAAC;gCAY3B,qBAAqB,GACzB,OAAO,CAAC,oBAAoB,EAAE,CAAC;;MAYlC;IAEI,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;CA+EvE"}