Qodex.ai

Process Image Pipeline Service.

POST {{baseUrl}}/session/services/processimagepipeline

The Process Image Pipeline Real-Time services executes a series of image services on a single image based on service properties. The order of services execution is as follows:: - Image Enhancement - Classify - Extract

Outputs of all executed services are combined and returned in the response.

Service Properties

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

  • ImageProfile - If non empty, the incoming image is enhanced.

  • ReturnFileDataInline - Boolean. If true, then the resulting file is returned inline in the result item as a base64 encoded file. If false, then the resulting file is returned as a fileId and can be retrieved through the Files resource. Default value is true. Applicable only if image enhancement is done. File ID referncing the resulting file is returned as part of URI in src property of File object of Result Item.

  • Classify - Boolean. Classify the image.

  • Extract - Boolean. Extract the image. If this is set then ClassifyAndExtract is performed on the image and “Classify” flag is ignored.

  • IncludeOcrData - Boolean. If true then the returned UIM data object will contain extracted characters information. Otherwise it won't.

  • 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 necessary or used.

Files Per Request Item

There can only be one file in request item object. It can either be an embedded file or a reference to a file ID previously posted to the Files Resource.

Request Body

{"serviceProps"=>[{"name"=>"Env", "value"=>"D"}, {"name"=>"ImageProfile", "value"=>"DistractionRemoval"}, {"name"=>"Extract", "value"=>true}, {"name"=>"ReturnFileDataInline", "value"=>false}, {"name"=>"IncludeOcrData", "value"=>false}, {"name"=>"Project", "value"=>"InformationExtraction"}], "requestItems"=>[{"nodeId"=>1, "values"=>nil, "files"=>[{"name"=>"Wren", "value"=>"F_ac92828e036e402687e020dbb8f3f4c0TIF", "contentType"=>"image/tiff", "fileType"=>"tif"}]}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"returnStatus":{"status":200,"code":"OK0000","message":"","server":"WS-S406d66e561d54f99b74f71aeca31fc46IS"},"id":"Req34W_3","serviceName":"processimagepipeline","executionMilliSeconds":968,"licensePagesUsed":0,"licensePagesUsed2":0,"resultItems":[{"nodeId":1,"errorCode":"","errorMessage":"","values":[{"name":"BlackBarLeft","value":0},{"name":"BlackBarTop","value":0},{"name":"BlackBarRight","value":0},{"name":"BlackBarBottom","value":0},{"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":"3aff08999e844ff6a31aff002b0fcb4a","packageName":"","nodeList":[{"name":"InvoiceNumber","isArray":false,"indexFieldType":"Number","labelText":"Invoice No.","isRequired":true,"controlType":"TextBox","data":[{"arrayIndex":0,"value":null,"fieldError":null,"mustConfirm":true,"choices":null,"locationRect":{"left":639,"top":144,"width":124,"height":30},"pageId":1,"confidence":100,"extractedCharacters":null}]}]}}],"files":[{"name":"Wren","value":"F_3dce19d31ad948c7a48e92cad7ee0090TIF","contentType":"image/tiff","src":"https://{host}/cp-rest/v2/session/files/F_3dce19d31ad948c7a48e92cad7ee0090TIF","fileType":"tif"}]}]}