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
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines/{pipelineId}/runs \
--header 'Authorization: Bearer <token>'{
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"errorMessage": null
}Run pipeline
Required capabilities:
entitymatchingAcl:READassetsAcl:READ
Run an entity matching pipeline. Data is downloaded from CDF and an entity matching model is fit according to the parameters specified when the pipeline was created.
Match generation
Which matches are returned is then decided based on the sources the pipeline trusts the most:
- If a source has a confirmed match, this match is returned.
- If not 1, but a match is found using one of the regex-rules in rules and the match found is not in the rejected matches, this match is returned.
- If not 1 nor 2, but the entity matching model find a match with score above the threshold, and the match found is not in the rejected matches, this match is returned.
- If none of the above applies, no match is returned for the source.
Improving results
If additional matches are confirmed and added to the list of confirmed/rejected matches, or if additional rules are confirmed and added to rules through the update endpoint, re-running the pipeline should give new and improved results.
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/entitymatching/pipelines/{pipelineId}/runs \
--header 'Authorization: Bearer <token>'{
"status": "Queued",
"createdTime": 1730204346000,
"startTime": 1730204346000,
"statusTime": 1730204346000,
"jobId": 123,
"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.
Path Parameters
A server-generated ID for the object.
1 <= x <= 9007199254740991Response
Run job for a pipeline
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
If the job failed, some more information about the error cause.
null
Was this page helpful?