Match pairs of records | Babel Street

curl -X POST https://analytics.babelstreet.com/rest/v1/record-similarity \
     -H "X-BabelStreetAPI-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "fields": {
    "dob": {
      "type": "rni_date",
      "weight": 0.1
    },
    "primaryName": {
      "type": "rni_name",
      "weight": 0.5
    }
  },
  "properties": {
    "threshold": 0.7,
    "includeExplainInfo": true
  },
  "records": {
    "left": [
      [
        {
          "dob": {
            "date": "1993-04-16"
          }
        },
        {
          "primaryName": {
            "text": "Ethan R",
            "entityType": "PERSON",
            "language": "eng",
            "languageOfOrigin": "eng",
            "script": "Latn"
          }
        }
      ],
      [
        {
          "dob": {
            "date": "1993-04-16"
          }
        },
        {
          "primaryName": [
            {
              "text": "Evan R",
              "entityType": "PERSON",
              "language": "eng"
            },
            {
              "text": "Evan Rosenstein",
              "entityType": "PERSON",
              "language": "eng"
            }
          ]
        }
      ]
    ],
    "right": [
      [
        {
          "dob": {
            "date": "1993-04-16"
          }
        },
        {
          "primaryName": {
            "text": "Evan R",
            "entityType": "PERSON",
            "language": "eng"
          }
        }
      ],
      [
        {
          "dob": {
            "date": "1993-04-16"
          }
        },
        {
          "primaryName": {
            "text": "Ivan R",
            "entityType": "PERSON",
            "language": "eng"
          }
        }
      ]
    ]
  }
}'

{
  "fields": {},
  "results": [
    {
      "score": 1.1,
      "left": {
        "fieldname": {
          "text": "string"
        }
      },
      "right": {
        "fieldname": {
          "text": "string"
        }
      },
      "explainInfo": {
        "fieldname": {
          "weight": 1.1,
          "calculatedWeight": 1.1,
          "rawScore": 1.1,
          "finalScore": 1.1,
          "details": {
            "leftInput": {
              "data": "string",
              "normalizedData": "string",
              "latnData": "string",
              "script": "string",
              "languageOfUse": "string",
              "languageOfOrigin": "string",
              "tokens": [
                {
                  "token": "string",
                  "latnTokn": "string",
                  "tokenWeight": 1.1,
                  "bin": 1.1,
                  "biasedBin": 1.1,
                  "tokenType": "string"
                }
              ],
              "entityType": "string",
              "empty": true
            },
            "rightInput": {
              "data": "string",
              "normalizedData": "string",
              "latnData": "string",
              "script": "string",
              "languageOfUse": "string",
              "languageOfOrigin": "string",
              "tokens": [
                {
                  "token": "string",
                  "latnTokn": "string",
                  "tokenWeight": 1.1,
                  "bin": 1.1,
                  "biasedBin": 1.1,
                  "tokenType": "string"
                }
              ],
              "entityType": "string",
              "empty": true
            },
            "scoreTuples": [
              {
                "scoreinIsolation": 1.1,
                "scoreInContext": 1.1,
                "left": "string",
                "right": "string",
                "marked": true,
                "reason": "string",
                "leftMinTokenIndex": 1.1,
                "leftMaxTokenIndex": 1.1,
                "rightMinTokenIndex": 1.1,
                "rightMaxTokenIndex": 1.1
              }
            ],
            "scoreAdjustments": {
              "unbiasedScore": 1.1,
              "score": 1.1,
              "parameter": "string"
            },
            "finalScore": 1.1,
            "defaultInput": {
              "empty": "string"
            },
            "empty": true
          }
        }
      },
      "leftOnlyFields": [
        "string"
      ],
      "rightOnlyFields": [
        "string"
      ]
    }
  ]
}

Compares records and returns a similarity score for each pair. Set comparisonMethod to control pairing: one_to_one (default), one_to_n (single record on one side compared to every record on the other side), or n_to_m (every left record compared to every right record). The fields in the records can be any of the following entity types: PERSON, ORGANIZATION, ADDRESS, DATE, or IDENTIFIER/TEXT. The records do not have to contain the same fields; only fields with the same field name are compared. If one record has three fields and the other has two fields, the missing field will be ignored and the other two fields compared. Each field can contain one or multiple values.

Authentication

X-BabelStreetAPI-Keystring

API Key authentication via header

X-RosetteAPI-Keystring

API Key authentication via header

Request

This endpoint expects an object.

comparisonMethodenumOptionalDefaults to one_to_one

Controls how input records are paired before scoring. Defaults to one_to_one, which preserves existing behavior.

Allowed values:

fieldsobjectOptional

propertiesobjectOptional

recordsobjectOptional

Records to compare. At least one of left or right must contain a record. Two equally sized lists are matched by position. A single record on one side is matched against every record on the other side.

Response

fieldsobjectOptional

resultslist of objectsOptional