Validation of a Classification Result

Start the classification validation operation

Tip: The Project ID is obtained from the response received from the Get project information call.

curl -X 'POST' \
  'https://cloud.uipath.com/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/classifiers/ml-classification/validation/start?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer ey***m6A' \
  -H 'Content-Type: application/json' \
  -d '{
  "documentId": "25a03e48-cfe8-ed11-9f75-000d3a4964af",
  "actionTitle": "Title of the action in action center",
  "actionPriority": "Low",
  "actionCatalog": "default_du_actions",
  "actionFolder": "Shared",
  "storageBucketName": "du_storage_bucket",
  "storageBucketDirectoryPath": "du_storage_bucket",
  "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)"
    }
  ]
}'

Response of the classification validation operation- Provides the operationId

{
  "operationId": "805f8efd-cfe8-ed11-907c-6045bd9d17d0"
}

Get the classification validation result

curl -X 'GET' \ 'https://cloud.uipath.com/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/classifiers/ml-classification/validation/result/805f8efd-cfe8-ed11-907c-6045bd9d17d0?api-version=1' \ 
-H 'accept: text/plain' \ 
-H 'Authorization: Bearer eyJhbGci***Km6A'

Get the response of the classification validation result

The action needs to manually be validated using Action Center.

{
  "result": {
    "actionData": {
      "type": "Classification",
      "id": 54121,
      "status": "Completed",
      "title": "Title of the action in action center",
      "priority": "Low",
      "taskCatalogName": "default_du_actions",
      "taskUrl": "https://cloud.uipath.com/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/actions_/tasks/54121",
      "folderPath": "Shared",
      "folderId": 57146,
      "data": {
        "validatedClassificationResultsPath": "du_storage_bucket/805f8efd-cfe8-ed11-907c-6045bd9d17d0/output_results.zip",
        "documentRejectionDetails": null
      },
      "action": "Completed",
      "isDeleted": false,
      "assignedToUser": {
        "id": 26109,
        "emailAddress": null
      },
      "creatorUser": {
        "id": 6216,
        "emailAddress": null
      },
      "deleterUser": null,
      "lastModifierUser": {
        "id": 26109,
        "emailAddress": null
      },
      "completedByUser": {
        "id": 26109,
        "emailAddress": null
      },
      "creationTime": "2023-05-02T09:59:15.87Z",
      "lastAssignedTime": "2023-05-02T10:35:08.363Z",
      "completionTime": "2023-05-02T10:35:18.147Z"
    },
    "validatedClassificationResults": [
      {
        "documentTypeId": "invoices",
        "documentId": "25a03e48-cfe8-ed11-9f75-000d3a4964af",
        "confidence": 1,
        "ocrConfidence": -1,
        "reference": {
          "textStartIndex": 0,
          "textLength": 0,
          "tokens": []
        },
        "documentBounds": {
          "startPage": 0,
          "pageCount": 1,
          "textStartIndex": 0,
          "textLength": 929
        },
        "classifierName": "ML Classification (Preview)"
      }
    ],
    "actionStatus": "Completed"
  },
  "status": "Succeeded",
  "createdAt": "2023-05-02T09:59:13.826819Z",
  "lastUpdatedAt": "2023-05-02T10:35:38.8083224Z"
}