Identify By Spliting File
Overview
The "Identify By Spliting File" API is a universal identification interface that allows you to initiate model calls based on the model ID. You can specify whether the interface returns the recognition results synchronously or asynchronously by the parameter "synchronously".
This interface returns multiple recognition results simultaneously. It is suitable for situations where a document contains multiple invoices, and returns the results for each invoice after splitting based on model configuration. This interface is also compatible with situations where a document contains a single invoice, so it is recommended to choose this interface first.
Request
POST https://api.peperwork.ai/api/identify/file/v2/identifyMultiple
Request body
| Name | Type | Mandatory | Description |
|---|---|---|---|
| modelId | string | true | The unique identifier of the model |
| file | file | true | Documents that need to be identified |
| legalPageNumbers | string | false | Page numbers to be identified, if not specified, the entire document will be recognized. |
| workspaceCode | string | false | The workspace name within the model.if empty, defaults to 'Default Workspace'. |
| isAsynchronous | string | false | Whether to return the recognition results asynchronously,Default: 0,1: Asynchronously return,0: Synchronously return |
| returnOcrResult | string | false | Whether to return OCR results,Default: 0,1: Returns OCR results,0: Does not return OCR results |
Examples of the legalPageNumbers:
1-1: only need to recognize the first page;
2-3: only need to recognize the second page and the third page;
1-1, 3-4: only need to recognize the first page, the third page, and the fourth page.
Response body
| Name | Type | Mandatory | Description |
|---|---|---|---|
| fileId | string | true | Unique identifier for uploading files |
| recognizeStatus | string | true | Upload file recognition status (0 - failed, 1 - successful, 2 - Identifying) |
| resultList | array | true | Identification field |
resultList Message Format
| Name | Type | Mandatory | Description |
|---|---|---|---|
| taskId | string | false | Unique identifier of each invoice |
| fieldList | array | false | List of extracted fields from the document |
| pageNumber | int | false | The page number within the document for this field |
| key | string | false | The name of the extracted field |
| value | string | false | The value of the extracted field |
| itemList | array | false | Extracted line information from the document |
| pageNumber | integer | false | The page number within the document for this item |
| key | string | false | The name of the extracted item |
| value | string | false | The value of the extracted item |
Example request
curl -i -X POST https://api.peperwork.ai/api/identify/file/v2/identifyMultiple \
-H "Content-Type: multipart/form-data" \
-H "Authorization: Bearer $DOCAI_API_KEY" \
-F 'modelId=@MODEL_ID' \
-F 'file=@REPLACE_IMAGE_PATH.jpg'
Example of synchronous response
{
"code": 200,
"message": null,
"costTime": null,
"data": [
{
"fileId": "2312151735497780509798400",
"errorMessage": null,
"recognizeStatus": "1",
"resultList": [
{
"wholeTextList": [],
"taxList": [
[
{
"pageNumber": 1,
"key": "taxBase",
"value": "145.0"
},
{
"pageNumber": 1,
"key": "taxType",
"value": "Sales Tax"
},
{
"pageNumber": 1,
"key": "taxValue",
"value": "9.06"
},
{
"pageNumber": 1,
"key": "taxPercentage",
"value": "0.0625"
}
]
],
"fieldList": [
{
"pageNumber": 1,
"key": "supplierAddress",
"value": "1912 Harvest Lane"
},
{
"pageNumber": 1,
"key": "paymentTerms",
"value": "Payment is due within 15 days"
},
{
"pageNumber": 1,
"key": "invoiceDate",
"value": "2019-02-11"
},
{
"pageNumber": 1,
"key": "subAmount",
"value": "145.00"
},
{
"pageNumber": 1,
"key": "supplierCompany",
"value": "East Repair Inc."
},
{
"pageNumber": 1,
"key": "documentType",
"value": "invoice"
},
{
"pageNumber": 1,
"key": "invoiceNumber",
"value": "US-001"
},
{
"pageNumber": 1,
"key": "totalTax",
"value": "9.06"
},
{
"pageNumber": 1,
"key": "customerCompany",
"value": "John Smith"
},
{
"pageNumber": 1,
"key": "dueDate",
"value": "2019-02-26"
},
{
"pageNumber": 1,
"key": "paymentCurrency",
"value": "USD"
},
{
"pageNumber": 1,
"key": "supplierCountry",
"value": ""
},
{
"pageNumber": 1,
"key": "discountAmount",
"value": ""
},
{
"pageNumber": 1,
"key": "grossAmount",
"value": ""
},
{
"pageNumber": 1,
"key": "freightCharge",
"value": ""
},
{
"pageNumber": 1,
"key": "customerCountry",
"value": ""
},
{
"pageNumber": 1,
"key": "dueAmount",
"value": ""
},
{
"pageNumber": 1,
"key": "additionalFees",
"value": ""
}
],
"itemList": [
[
{
"pageNumber": 1,
"key": "taxAmount",
"value": "0.0"
},
{
"pageNumber": 1,
"key": "totalPriceInclTax",
"value": "100.0"
},
{
"pageNumber": 1,
"key": "unitPrice",
"value": "100.0"
},
{
"pageNumber": 1,
"key": "quantity",
"value": "1.0"
},
{
"pageNumber": 1,
"key": "description",
"value": "Front and rear brake cables"
},
{
"pageNumber": 1,
"key": "totalPriceExclTax",
"value": "100.0"
},
{
"pageNumber": 1,
"key": "purchaseOrderNumber",
"value": "2312/2019"
},
{
"pageNumber": 1,
"key": "taxRate",
"value": "0.0625"
},
{
"pageNumber": 1,
"key": "unit",
"value": ""
},
{
"pageNumber": 1,
"key": "POLineItem",
"value": ""
},
{
"pageNumber": 1,
"key": "materialCode",
"value": ""
}
],
[
{
"pageNumber": 1,
"key": "taxAmount",
"value": "0.0"
},
{
"pageNumber": 1,
"key": "totalPriceInclTax",
"value": "30.0"
},
{
"pageNumber": 1,
"key": "unitPrice",
"value": "15.0"
},
{
"pageNumber": 1,
"key": "quantity",
"value": "2.0"
},
{
"pageNumber": 1,
"key": "description",
"value": "New set of pedal arms"
},
{
"pageNumber": 1,
"key": "totalPriceExclTax",
"value": "30.0"
},
{
"pageNumber": 1,
"key": "taxRate",
"value": "0.0625"
},
{
"pageNumber": 1,
"key": "unit",
"value": ""
},
{
"pageNumber": 1,
"key": "POLineItem",
"value": ""
},
{
"pageNumber": 1,
"key": "purchaseOrderNumber",
"value": ""
},
{
"pageNumber": 1,
"key": "materialCode",
"value": ""
}
],
[
{
"pageNumber": 1,
"key": "taxAmount",
"value": "0.0"
},
{
"pageNumber": 1,
"key": "totalPriceInclTax",
"value": "15.0"
},
{
"pageNumber": 1,
"key": "unitPrice",
"value": "5.0"
},
{
"pageNumber": 1,
"key": "quantity",
"value": "3.0"
},
{
"pageNumber": 1,
"key": "description",
"value": "Labor 3hrs"
},
{
"pageNumber": 1,
"key": "totalPriceExclTax",
"value": "15.0"
},
{
"pageNumber": 1,
"key": "taxRate",
"value": "0.0625"
},
{
"pageNumber": 1,
"key": "unit",
"value": ""
},
{
"pageNumber": 1,
"key": "POLineItem",
"value": ""
},
{
"pageNumber": 1,
"key": "purchaseOrderNumber",
"value": ""
},
{
"pageNumber": 1,
"key": "materialCode",
"value": ""
}
]
],
"taskId": "2312151735497780509798400"
}
]
}
],
"requestId": "d6856af734f74a07ba0b9675c470a9f1",
"currentTimeMillis": 1702622461945
}
Example of asynchronous response
{
"code": 200,
"message": null,
"costTime": null,
"data": {
"fileId": "2310091711378393918074800",
"recognizeStatus": "1"
},
"requestId": "da69edd3cb1d47b4a68db9303d280000",
"currentTimeMillis": 1696859401185
}