v1.2.4 - Algorithm values

- Set AddressMatch default algorithm to `ai-medium-narrow`.
- Set CompanyMatch default algorithm to `ai-medium`
- Add `algorithm` to `DelimitedFileMatchKeyReportRequest`

README.md

@@ -1,6 +1,6 @@
 # Interzoid Data Matching Node.js SDK
 
-**Version: 1.1.1**
+**Version: 1.2.4**
 
 This is a Node.js SDK for Interzoid's Generative-AI powered data matching, data quality, data cleansing, and data normalization for organization and individual name data. Functions include the generation of similarity keys (also called match keys) for identifying and matching inconsistent name data, as well as comparing and scoring data for matching purposes. 
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@interzoid/data-matching",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "author": "Interzoid, Inc. <[email protected]> https://interzoid.com",
   "description": "Interzoid SDK for Typescript, Generative-AI powered data matching, data quality, and data normalization for organization and individual name data",
   "keywords": [
@@ -12,7 +12,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/interzoid/sdk-nodejs"
+    "url": "https://github.com/interzoid/sdk-nodejs.git"
   },
   "homepage": "https://github.com/interzoid/sdk-nodejs#readme",
   "license": "MIT",

src/api/AddressMatchKey.ts

@@ -20,7 +20,7 @@ export async function getAddressMatchKey(
     throw new Error('Invalid request. "apiKey" and "address" are required.');
   }
 
-  const algorithm = request.algorithm || 'narrow';
+  const algorithm = request.algorithm || 'ai-medium-narrow';
   const resource = 'getaddressmatchadvanced';
 
   const resp = await InterzoidApi.doApiGetRequest(resource, request.apiKey, {

src/api/CloudDatabaseMatchKeyReport.ts

@@ -26,6 +26,7 @@ export async function getCloudDatabaseMatchKeyReport(
     source: request.source,
     connection: request.connection,
     category: request.category,
+    algorithm: request.algorithm,
     column: request.column,
     reference: request.reference,
     json: request.json,

src/api/CompanyNameMatchKey.ts

@@ -22,7 +22,7 @@ export async function getCompanyNameMatchKey(
   }
 
   const resource = 'getcompanymatchadvanced';
-  const algorithm = request.algorithm || 'wide';
+  const algorithm = request.algorithm || 'ai-medium';
 
   const resp = await InterzoidApi.doApiGetRequest(resource, request.apiKey, {
     company: request.company,

src/api/DelimitedFileMatchKeyReport.ts

@@ -26,6 +26,7 @@ export async function getDelimitedFileMatchKeyReport(
     connection: request.csvUrl,
     category: request.category,
     column: request.matchColumn,
+    algorithm: request.algorithm,
     reference: request.referenceColumn,
     json: request.responseFormat === 'json',
     html: request.responseFormat === 'html',

src/api/InterzoidApi.ts

@@ -35,7 +35,7 @@ export class InterzoidApi {
     const config: AxiosRequestConfig = {
       params: params,
       headers: {
-        'x-client': 'axios/data-matching-npm/1.0.0',
+        'x-client': 'axios/data-matching-npm/1.2.4',
       },
       paramsSerializer: (params: object) => {
         return qs.stringify(params);

src/interfaces/AddressMatchKeyRequest.ts

@@ -9,5 +9,11 @@ import { InterzoidRequest } from './InterzoidRequest';
  */
 export interface AddressMatchKeyRequest extends InterzoidRequest {
   address: string;
-  algorithm?: 'wide' | 'narrow';
+  algorithm?:
+    | 'narrow'
+    | 'wide'
+    | 'ai-plus-narrow'
+    | 'ai-plus-wide'
+    | 'ai-medium-narrow'
+    | 'ai-medium-wide';
 }

src/interfaces/CloudWorkloadRequest.ts

@@ -13,18 +13,21 @@ import { Category } from './Category';
  * @property {string} connection - Connection string to access database, or in the case of a CSV or TSV file, use the full URL of the location of the file.
  * @property {string} table - Table name to access the source data. Use "CSV" or "TSV" for delimited text files.
  * @property {string} column - Column name within the table to access the source data. This is a number for CSV or TSV files, starting with number 1 from the left side of the file.
+ * @property {string} algorithm - The matching algorithm to use. Valid values are specific to the request.
  * @property {string} [reference] - An additional column from the source table to display in the output results, such as a primary key.
  * @property {string} [newTable] - The name of the new table if the output results are written to a new table. Required if process is CREATE_TABLE.
  * @property {boolean} [json] - If true, the output will be in JSON format.
  * @property {boolean} [html] - Set to 'true' to pad line breaks into the output results for better readability ina browser when run from the address bar.
  */
+
 export interface CloudWorkloadRequest extends InterzoidRequest {
   process: Process;
   category: Category;
   source: Source;
   connection: string;
   table: string;
   column: string;
+  algorithm?: string;
   reference?: string;
   newTable?: string; //required if process is CREATE_TABLE
   json?: boolean;

src/interfaces/CompanyNameMatchKeyRequest.ts

@@ -7,7 +7,8 @@ import { InterzoidRequest } from './InterzoidRequest';
  * @property {string} company - Company name to match
  * @property {string} [algorithm] - Algorithm to use for matching
  */
+
 export interface CompanyNameMatchKeyRequest extends InterzoidRequest {
   company: string;
-  algorithm?: 'wide' | 'medium' | 'narrow';
+  algorithm?: 'ai-plus' | 'ai-medium' | 'wide' | 'medium' | 'narrow';
 }

src/interfaces/DelimitedFileMatchKeyReportRequest.ts

@@ -19,6 +19,7 @@ export interface DelimitedFileMatchKeyReportRequest extends InterzoidRequest {
   category: Category;
   csvUrl: string;
   matchColumn: number;
+  algorithm?: string;
   referenceColumn?: number;
   responseFormat?: 'json' | 'html' | 'text';
 }

tests/api/DelimitedFileMatchKeyReport.test.ts

@@ -18,6 +18,7 @@ describe('getCsvMatchKeyReport', () => {
       category: Category.COMPANY,
       source: Source.CSV,
       process: Process.MATCH_REPORT,
+      algorithm: 'ai-medium',
       csvUrl: 'https://dl.interzoid.com/csv/companies.csv',
       matchColumn: 1,
       apiKey: 'test-api-key',
@@ -73,7 +74,7 @@ describe('getCsvMatchKeyReport', () => {
       responseFormat: 'json',
     };
     await expect(getDelimitedFileMatchKeyReport(request)).rejects.toThrow(
-      `Invalid 'source'. It must be either 'CSV' or 'TSV'.`,
+      `Invalid 'source'. It must be 'CSV', 'TSV', 'Excel, or 'Parquet'.`,
     );
   });