document-understanding
2024.10
true
  • Getting Started
    • Overview
    • Limits and Quota
  • Examples Using the Document Understanding™ API
  • Licensing
  • Troubleshooting
UiPath logo, featuring letters U and I in white

Document Understanding API Guide

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Dec 18, 2024

Classifying a document

Start classifying a document

Tip: The Project ID is obtained from the response received from the Get project information call.
curl -X 'POST' \
  'https://{fqdn}/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/classifiers/ml-classification/classification?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJh***Km6A' \
  -H 'Content-Type: application/json' \
  -d '{
  "documentId": "25a03e48-cfe8-ed11-9f75-000d3a4964af"
}'curl -X 'POST' \
  'https://{fqdn}/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/classifiers/ml-classification/classification?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJh***Km6A' \
  -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)"
    }
  ]
}

  • Start classifying a document
  • Response of classifying a document

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.