User GuidesAPI ReferenceRelease Notes
Doc HomeHelp CenterLog In
API Reference

Update a Project's Binning Model

Create or update a project's binning model.

A project's binning model can be modified by creating, updating, or deleting records containing binning terms. Terms (identified by "recordId") are grouped by "clauseId" in order to collect the binning terms into their respective binning clauses. For example, to delete one term, and create a new term with three clauses, you could use the POST body:

{
    "action": "DELETE",
    "recordId": "DUNSnumber term",
  }
  {
    "action": "CREATE",
    "recordId": "vendorName term",
    "record": {
      "id": ["vendorName term"],
      "isActive": ["true"],
      "clauseId": ["vendorName/city/state clause"],
      "similarityFunction": ["COSINE"],
      "tokenizer": ["DEFAULT"],
      "fieldName": ["vendorName"],
      "threshold": ["0.75"]
    }
  }
  {
    "action": "CREATE",
    "recordId": "city term",
    "record": {
      "id":["city term"],
      "isActive":["true"],
      "clauseId":["vendorName/city/state clause"],
      "similarityFunction":["COSINE"],
      "tokenizer":["DEFAULT"],
      "fieldName":["City"],
      "threshold":["0.9"]
    }
  }
  {
    "action": "CREATE",
    "recordId": "state term",
    "record": {
      "id":["state term"],
      "isActive":["true"],
      "clauseId":["vendorName/city/state clause"],
      "similarityFunction":["COSINE"],
      "tokenizer":["DEFAULT"],
      "fieldName":["state"],
      "threshold":["0.9"]
    }
  }

The "fieldName" must match a field in your Unified Dataset.

Records can be updated using the "CREATE" action and a matching record ID.

When deleting records, the "record" field is not required.

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

Language