Predict matches

Predicts entity matches using a trained model. Note: 'assetsAcl:READ' capability is required unless both sources and targets are specified in the request. Also note that the header of a successful response contains a X-Job-Token which allows to fetch the result of the job at /context/entitymatching/jobs/{jobId} without requiring 'assetsAcl:READ'.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
One of:
id
required
integer <int64> [ 1 .. 9007199254740991 ]

The ID of the model that is used to predict matches.

sources
Array of objects [ 0 .. 2000000 ] items

List of source entities to predict matches for, for example, time series. If omitted, will use sources from create and assetsAcl:READ capability will be required for the request.

targets
Array of objects [ 1 .. 2000000 ] items

List of potential target entities to match to one or more of the source entities, for example, assets. If omitted, will use targets from create and assetsAcl:READ capability will be required for the request.

numMatches
integer [ 0 .. 100 ]

The maximum number of results to return for each source entity.

scoreThreshold
number [ 0 .. 1 ]

Only return matches with score above this threshold.

Responses
200

Success

400

The response for a failed request.

post/context/entitymatching/predict
Request samples
application/json
{
  • "externalId": "my.known.id",
  • "sources": [
    • {
      }
    ],
  • "targets": [
    • {
      }
    ],
  • "numMatches": 3,
  • "scoreThreshold": 0.7
}
Response samples
application/json
{
  • "jobId": 123,
  • "status": "Queued",
  • "createdTime": 0,
  • "startTime": 0,
  • "statusTime": 0,
  • "errorMessage": null
}
➔ Next to Re-fit entity matcher model