Skip to main content

PredictedDocumentClassView

Information about the document class predicted by AI

predictedDocumentClassCodestringrequired

Code of the predicted document class

Example: INVOICE
confidenceIndexnumber<double>

Confidence level of the prediction (0-1)

Example: 0.85
predictedDocumentClassIdentifierstringrequired

Unique identifier of the predicted document class

Example: class-123e4567-e89b-12d3-a456-426614174000
predictedDocumentClassNames object[]required

Localized names of the predicted document class in different languages

  • Array [
    • namestringrequired

    The name in the specified language

    Example: Root folder
    localestringrequired

    Language code (ISO 639-1)

    Example: en-US
  • ]
    • PredictedDocumentClassView
    {
      "predictedDocumentClassCode": "INVOICE",
      "confidenceIndex": 0.85,
      "predictedDocumentClassIdentifier": "class-123e4567-e89b-12d3-a456-426614174000",
      "predictedDocumentClassNames": [
        {
          "name": "Root folder",
          "locale": "en-US"
        }
      ]
    }