document-understanding
latest
false
Document Understanding API guide
- Getting Started
- Examples Using the Document Understanding™ Cloud API v1
- Licensing
- Troubleshooting
Classifying a document
API example for classifying a document using the Document Understanding Classification Service with a project ID and curl request.
Start classifying a document
Tip:
The Project ID is obtained from the response received from the Get project information call.
curl -X 'POST' \
'https://{AutomationCloudURL}/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/classifiers/ml-classification/classification?api-version=1' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer <your-access-token>' \
-H 'Content-Type: application/json' \
-d '{
"documentId": "25a03e48-cfe8-ed11-9f75-000d3a4964af"
}'
curl -X 'POST' \
'https://{AutomationCloudURL}/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/classifiers/ml-classification/classification?api-version=1' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer <your-access-token>' \
-H 'Content-Type: application/json' \
-d '{
"documentId": "25a03e48-cfe8-ed11-9f75-000d3a4964af"
}'
Response of classifying a document
{
"classificationResults": [
{
"documentTypeId": "invoices",
"documentId": "25a03e48-cfe8-ed11-9f75-000d3a4964af",
"confidence": 0.6170391,
"ocrConfidence": -1,
"reference": {
"textStartIndex": 0,
"textLength": 0,
"tokens": []
},
"documentBounds": {
"startPage": 0,
"pageCount": 1,
"textStartIndex": 0,
"textLength": 929
},
"classifierName": "ML Classification (Preview)"
}
]
}
{
"classificationResults": [
{
"documentTypeId": "invoices",
"documentId": "25a03e48-cfe8-ed11-9f75-000d3a4964af",
"confidence": 0.6170391,
"ocrConfidence": -1,
"reference": {
"textStartIndex": 0,
"textLength": 0,
"tokens": []
},
"documentBounds": {
"startPage": 0,
"pageCount": 1,
"textStartIndex": 0,
"textLength": 929
},
"classifierName": "ML Classification (Preview)"
}
]
}
Note:
This example shows an API v1 response, which uses camelCase property names. API v2 returns PascalCase property names on all routes. For details, check Migrating automations from Document Understanding API v1 to v2.