UiPath · JSON Structure

Document Understanding Classification Result Structure

Result of an asynchronous classification job

Type: object Properties: 3
AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

ClassificationResult is a JSON Structure definition published by UiPath, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

requestId status result

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-structure/document-understanding-classification-result-structure.json",
  "name": "ClassificationResult",
  "description": "Result of an asynchronous classification job",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "description": "Unique identifier of the classification job",
      "example": "abc123"
    },
    "status": {
      "type": "string",
      "enum": [
        "NotStarted",
        "Running",
        "Failed",
        "Succeeded"
      ],
      "description": "Current status of the classification job",
      "example": "NotStarted"
    },
    "result": {
      "type": "object",
      "description": "Classification output, populated when status is Succeeded",
      "properties": {
        "documentId": {
          "type": "string",
          "description": "Document ID that was classified"
        },
        "classificationResults": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ClassificationResultItem"
          }
        }
      },
      "example": "example-value"
    }
  }
}