Classify Extract Page Service.
POST {{baseUrl}}/session/services/classifyextractpage
The Classify Extract Page Service will perform classification and extraction on each item submitted and return a UIM object containing information from the result of classification and extraction. Service Properties Env - Metadata environment identifier. Value is one of IncludeOcrData - Boolean. If true then the returned UIM data object will contain extracted characters information. Otherwise by default, it won't. Project - Optional string. The recognition project to use to classify the document. Valid values are Number of Request Items This Real-Time Service supports one or more items. Values Per Request Item No values are needed or used Files Per Request Item There can only be one file per request item object. It can either be an embedded file or a reference to a file ID previously posted to the Files Resource. The File Type property for the file is ignored for this service.
D
, T
or P
. Default value is P
.Default
for the Advanced Recognition and InformationExtraction
for the Information Extraction. If omitted, Default
is used.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string |
RESPONSES
status OK
| {
"returnStatus": {
"status": 200,
"code": "OK0000",
"message": "",
"server": "WS-Sa3586a2353bb48c0b7131c9875f61e69IS"
},
"licenseUsedPercent": 0,
"id": "REQ5",
"serviceName": "classifyextractpage",
"executionMilliSeconds": 656,
"licensePagesUsed": 1,
"licensePagesUsed2": 1,
"resultItems": [
{
"nodeId": 1,
"errorCode": "",
"errorMessage": "",
"values": [
{
"name": "TemplateId",
"value": "28"
},
{
"name": "DocumentTypeName",
"value": "TestWren"
},
{
"name": "DocBoundary",
"value": 0
},
{
"name": "ClassificationId",
"value": "d907a548196c4e35837dad51954cd3ed"
},
{
"name": "UimData",
"value": {
"docType": "TestWren",
"locale": "en-US",
"flaggedReason": null,
"extractionId": null,
"nodeList": [
{
"name": "InvoiceNumber",
"isArray": false,
"indexFieldType": "Number",
"labelText": "Invoice No.",
"isRequired": true,
"controlType": "TextBox",
"data": [
{
"arrayIndex": 0,
"value": 227628,
"fieldError": {
"errorCode": "ER2208",
"recoverable": false,
"message": "Out of Bounds:Valid values: 1000 ➜ 10210"
},
"mustConfirm": true,
"choices": null,
"locationRect": {
"left": 639,
"top": 144,
"width": 124,
"height": 30
},
"pageId": 1,
"confidence": 100,
"extractedCharacters": null
}
]
}
]
}
}
]
}
]
} |
ENDPOINTS