API reference (20230101)
- Overview
- Overview
- POSTCreate entity matcher model
- POSTDelete entity matcher model
- POSTFilter models
- GETList entity matching models
- GETRetrieve an entity matching model by the ID of the model
- POSTPredict matches
- POSTRe-fit entity matcher model
- GETRetrieve entity matcher predict results
- POSTRetrieve entity matching models
- POSTUpdate entity matching models
const response = await client.entityMatching.predict({
externalId: 'model123',
sources: [{externalId: 'asset1', name: 'asset1'}, {externalId: 'asset2', name: 'asset2'}],
targets: [{externalId: 'ts1', name: 'ts1'}, {externalId: 'ts2', name: 'ts2'}],
});{
"jobId": 123,
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"errorMessage": null
}Required capabilities:
entitymatchingAcl:WRITE
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’.
const response = await client.entityMatching.predict({
externalId: 'model123',
sources: [{externalId: 'asset1', name: 'asset1'}, {externalId: 'asset2', name: 'asset2'}],
targets: [{externalId: 'ts1', name: 'ts1'}, {externalId: 'ts2', name: 'ts2'}],
});{
"jobId": 123,
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"errorMessage": null
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
- Option 1
- Option 2
The ID of the model that is used to predict matches.
1 <= x <= 9007199254740991List 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.
2000000List 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.
1 - 2000000 elementsThe maximum number of results to return for each source entity.
0 <= x <= 1003
Only return matches with score above this threshold.
0 <= x <= 10.7
Response
Success
Contextualization job ID.
123
The status of the job.
Queued, Running, Completed, Failed The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
If the job failed, some more information about the error cause.
null
Was this page helpful?