POST /predict-api/api/extraction/file

Owned by Technische Redaktion
Dec 01, 2022
4 min read
As of Versionproduct version 2022 Winter
Request MethodPOST
Response FormatJSON
Description

Retrieves an extraction prediction for the binary content file that is passed in the request body.

The endpoint will return a JSON structure containing a list of predictions with one prediction that is structured as already described for the endpoint GET /predict-api/api/extraction/{objectId}.

Request Header

Content-Type: application/json

X-ID-TENANT-NAME: tenant_name

Request Example

/predict-api/api/extraction/file

File to be analyzed in the request body.

Result Example
{
    "predictions": [{
        "properties": {
            "appAIInvoice:aiiCompanyName": [
                {
                    "value": "Lufthansa",
                    "probability": 99.24,
                    "boundingBox": [
                        403,
                        729,
                        61,
                        14
                    ],
                    "page": 0
                },
                {
                    "value": "AKG Thermotechnik International GmbH & Co.KG",
                    "probability": 93.24,
                    "boundingBox": [
                        413,
                        224,
                        93,
                        14
                    ],
                    "page": 1
                }
            ],
            "appAIInvoice:aiiIssueDateTime": [
                {
                    "value": "2018-01-26T15:21:170Z",
                    "probability": 85.12,
                    "boundingBox": [
                        213,
                        234,
                        76,
                        14
                    ],
                    "page": 1
                }
            ]
        },
        "system:objectId": {
            "value": "cdc7095f-a5ce-486d-92a7-6d0955d969ee"
        },
        "predictionId": 1065
    }]
}