example-basic.js

/**
 * ExisEcho API - Basic Example
 *
 * This example demonstrates basic duplicate detection using the ExisEcho API.
 *
 * Get your FREE test API key by emailing: exisllc@gmail.com
 * Documentation: https://www.fuzzy-logic.com/Api
 */

import { ExisEchoClient } from './exisecho.js';

// Replace with your API key
const API_KEY = "your-api-key-here";

async function main() {
    // Initialize the client
    const client = new ExisEchoClient(API_KEY);

    // Sample data with potential duplicates
    const records = [
        { id: "1", fields: { name: "John Smith", email: "john.smith@example.com" } },
        { id: "2", fields: { name: "Jon Smyth", email: "jon.smyth@example.com" } },
        { id: "3", fields: { name: "Jane Doe", email: "jane.doe@example.com" } },
        { id: "4", fields: { name: "John A. Smith", email: "johnsmith@example.com" } },
        { id: "5", fields: { name: "Robert Johnson", email: "bob.johnson@example.com" } },
        { id: "6", fields: { name: "Bob Johnson", email: "robert.j@example.com" } },
    ];

    console.log("ExisEcho API - Basic Example");
    console.log("=".repeat(50));
    console.log();
    console.log(`Checking ${records.length} records for duplicates...`);
    console.log();

    try {
        // Find duplicates with phonetic matching enabled
        const result = await client.findDuplicates(records, {
            threshold: 0.7,
            columnOptions: {
                name: {
                    usePhoneticMatching: true,
                    equateSynonyms: true,
                    ignoreWordOrder: true
                }
            }
        });

        if (result.success) {
            const { summary, matches, usage } = result;

            console.log("Results:");
            console.log(`  - Records analyzed: ${summary.totalRecordsAnalyzed}`);
            console.log(`  - Duplicates found: ${summary.totalMatches}`);
            console.log(`  - Processing time: ${summary.processingTimeMs}ms`);
            console.log();

            if (matches.length > 0) {
                console.log("Potential Duplicates:");
                console.log("-".repeat(50));

                for (const match of matches) {
                    const rec1 = records.find(r => r.id === match.record1Id);
                    const rec2 = records.find(r => r.id === match.record2Id);

                    console.log(`  Match Score: ${(match.score * 100).toFixed(0)}% (${match.quality})`);
                    console.log(`    Record ${match.record1Id}: ${rec1.fields.name}`);
                    console.log(`    Record ${match.record2Id}: ${rec2.fields.name}`);
                    console.log();
                }
            }

            console.log("API Usage:");
            console.log(`  - Units consumed: ${usage.unitsConsumed}`);
            console.log(`  - Units remaining: ${usage.unitsRemaining}`);
        } else {
            console.error(`Error: ${result.error}`);
        }
    } catch (error) {
        console.error(`Error: ${error.message}`);
    }
}

main();