User GuidesAPI ReferenceRelease NotesEnrichment APIs
Doc HomeSupportLog In

Modify the binning model's records

If any of the specified update commands fail to validate, no changes will be made.

This endpoint can be used to create, update, or delete blocking terms in a project's blocking model. You supply a series of newline-separated JSON objects in the request body. Terms, identified by recordId, have an identifying clauseId to organize the blocking terms into their respective blocking clauses.

For example, to delete a term, update an existing term, and add DOB as a new term, you use a POST body like this:

{
    "action": "DELETE",
    "recordId": "ce22fcff-25be-45b6-8e41-21b71027c318",
  }
  {
    "action": "CREATE",
    "recordId": "8f8890ec-1822-4afc-a44c-3e2101849455",
    "record": {
      "id": ["8f8890ec-1822-4afc-a44c-3e2101849455"],
      "isActive": ["true"],
      "clauseId": ["37c24625-8c49-4a7f-b874-05942ffe10e8"],
      "similarityFunction": ["COSINE"],
      "tokenizer": ["DEFAULT"],
      "fieldName": ["vendorName"],
      "threshold": ["0.75"]
     }
   }
  {
    "action": "CREATE",
    "record": {
      "id":["DOB"],
      "isActive":["true"],
      "clauseId":["37c24625-8c49-4a7f-b874-05942ffe10e8"],
      "similarityFunction":["COSINE"],
      "tokenizer":["DEFAULT"],
      "fieldName":["DOB"],
      "threshold":["0.9"]
     }
   }

Notes:

  • If any of the specified update commands fail to validate, no changes are made.
  • When deleting records, the record field is not required.
  • Terms are updated with the CREATE action and an existing recordId, and added with the CREATE action and with the fieldName as the id .
  • The fieldName must match an attribute in the project's unified dataset.
Language
Click Try It! to start a request and see the response here!