GET /predict-api/api/classification/{objectId}

Owned by Technische Redaktion
Last updated: Nov 25, 2022
2 min read
As of Versionproduct version 2022 Winter
Request MethodGET
Response FormatJSON
Description

Retrieves a classification prediction for a single object identified by its objectId.

The object type IDs will be returned as defined in the inference schema along with their probability in percentage (level of confidence) in the properties section of the JSON response body.

The response JSON further contains the predictionId that should be used for giving feedback to the PREDICT-API on the quality of received predictions, as well as the system:objectId that was specified in the request URL.

Request Header

Content-Type: application/json

X-ID-TENANT-NAME: tenant_name

Request Example
/predict-api/api/classification/da20c2fb-8071-45e9-b4bf-2af376cdf9b7
Result Example
{
    "predictions": [{
        "properties": {
            "appImpulse:receiptsot|appImpulse:receiptType|Rechnung" : {
                "probability": 98.45
            },
            "appImpulse:receiptsot|appImpulse:receiptType|Order": {
                "probability": 12.77
            },
            "appImpulse:hrsot|appImpulse:hrType|Bewerbung": {
                "probability": 1.38
            },
            "Class4": {
                "probability": 0.99
            },
            "Class5": {
                "probability": 0.02
            }
        },
        "system:objectId": "da20c2fb-8071-45e9-b4bf-2af376cdf9b6",
        "predictionId": 165
    }]
}