Estimate contextualization quality

Estimate the contextualization quality of an advanced join using the matches (truth values) as reference.

The caller needs to have read access to the view they are querying.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
advancedJoinExternalId
required
string (CogniteExternalId) <= 255 characters

The external ID provided by the client. Must be unique for the resource type.

dummyResponse
boolean
Default: false

Whether to return a bogus response that complies with the expected schema. This will be removed in a future iteration.

required
object (Matcher)
Responses
200

The resulting advanced join job.

400

The response for a bad request.

429

The response for too many requests (concurrency or rate throttling).

post/advancedjoins/estimatequality
Request samples
application/json
{
  • "advancedJoinExternalId": "my.known.id",
  • "dummyResponse": false,
  • "matcher": {
    • "type": "raw",
    • "dbName": "string",
    • "tableName": "string",
    • "fromColumnKey": "string",
    • "toColumnKey": "string"
    }
}
Response samples
application/json
{
  • "jobId": "string",
  • "status": "Queued",
  • "createdTime": 0,
  • "startTime": 0,
  • "statusTime": 0,
  • "errorMessage": null,
  • "advancedJoinExternalId": "my.known.id",
  • "matcher": {
    • "type": "raw",
    • "dbName": "string",
    • "tableName": "string",
    • "fromColumnKey": "string",
    • "toColumnKey": "string"
    },
  • "qualityScorePercent": 100,
  • "confidencePercent": 100,
  • "contextualizationScorePercent": 100
}
➔ Next to List advanced joins