API reference (20230101-alpha)
- 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 { status, items } = await client.entityMatching.predictResult(12345678);{
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"items": [
{
"source": {
"field": "value",
"ignoredfield": {
"key": "value"
}
},
"matches": [
{
"score": 0.98,
"target": {
"field": "value",
"ignoredfield": {
"key": "value"
}
}
}
]
}
],
"errorMessage": null
}Retrieve entity matcher predict results
Required capabilities:
assetsAcl:READentitymatchingAcl:WRITE
Get the results from a predict job. Note: ‘assetsAcl:READ’ capability is required, unless you specify a valid X-Job-Token in the request header. The X-Job-Token is provided in the response header of the initial call to /context/entitymatching/predict
const { status, items } = await client.entityMatching.predictResult(12345678);{
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"items": [
{
"source": {
"field": "value",
"ignoredfield": {
"key": "value"
}
},
"matches": [
{
"score": 0.98,
"target": {
"field": "value",
"ignoredfield": {
"key": "value"
}
}
}
]
}
],
"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.
Headers
A string token that can be attached to the header of a request fetching the job status. Authenticates the user fetching the job status as the same one who originally posted the job.
Path Parameters
Contextualization job ID.
123
Response
Success
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
Contextualization job ID.
123
List of matched entities with confidence score.
Show child attributes
Show child attributes
If the job failed, some more information about the error cause.
null
Was this page helpful?