Qodex.ai

Classify Service.

POST {{baseUrl}}/session/services/classify

The Classify Service will perform Classification on the images submitted and return available Document Type and Template information if successful. In addition to template information, fields extracted as part of pre-index extraction will be retuned as fields in UimData.

Service Properties

  • Env - Metadata environment identifier. Value is one of D, T or P. Default value is P.

  • Project - Optional string. The recognition project to use to classify the document. Valid values are Default for the Advanced Recognition and InformationExtraction for the Information Extraction. If omitted, Default is used.

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.

Request Body

{"serviceProps"=>[{"name"=>"Env", "value"=>"D"}, {"name"=>"Project", "value"=>"InformationExtraction"}], "requestItems"=>[{"nodeId"=>1, "values"=>nil, "files"=>[{"name"=>"Wren", "value"=>"F_30fd48db3ba14157ade16ba6b7f8c8a9TIF", "contentType"=>"image/tiff", "fileType"=>"tif"}]}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"returnStatus":{"status":200,"code":"OK0000","message":"","server":"WS-Sbf77b6cf64a140c5ad4db11b8cdba56aIS"},"licenseUsedPercent":0,"id":"ReqCPEXTRAC_33B_0041250","serviceName":"classify","executionMilliSeconds":128,"licensePagesUsed":1,"licensePagesUsed2":0,"resultItems":[{"nodeId":1,"errorCode":"","errorMessage":"","values":[{"name":"DocumentTypeName","value":"TestWren"},{"name":"TemplateId","value":"28"},{"name":"DocBoundary","value":0},{"name":"PaperOrientation","value":0},{"name":"ClassificationId","value":"d907a548196c4e35837dad51954cd3ed"},{"name":"UimData","value":{"docType":"","locale":"en-US","flaggedReason":null,"extractionId":"3aff08999e844ff6a31aff002b0fcb4a","packageName":null,"nodeList":[{"name":"InvoiceNumber","isArray":false,"indexFieldType":"string","labelText":"InvoiceNumber","isRequired":false,"controlType":"TextBlock","data":[{"arrayIndex":0,"value":"227628","fieldError":null,"mustConfirm":false,"choices":null,"locationRect":{"left":639,"top":144,"width":124,"height":30},"pageId":1,"confidence":100,"flaggedReason":"","extractedCharacters":null}]},{"name":"ShipVia","isArray":false,"indexFieldType":"string","labelText":"ShipVia","isRequired":false,"controlType":"TextBlock","data":[{"arrayIndex":0,"value":"FOB SHANGHAI","fieldError":null,"mustConfirm":false,"choices":null,"locationRect":{"left":24,"top":379,"width":125,"height":17},"pageId":1,"confidence":97,"flaggedReason":"","extractedCharacters":null}]}]}}],"files":[]}]}