Skip to content

Document category

A document category represents the classification result assigned to a document.

It is returned as an object composed of two fields:

Field Type Description
value string The operational category key assigned to the document.
confidence number The confidence score associated with the selected category.

Example

Category Object

{
  "category": {
    "value": "passport",
    "confidence": 96.0
  }
}

Fields

value

The value field contains the operational category key selected for the document.

The value corresponds to one of the keys defined in the service_categories object.

For example:

"value": "passport"

confidence

The confidence field represents how confident the system is about the selected category.

The value is expressed as a number between 0 and 100, where higher values indicate higher confidence.

For example:

"confidence": 96.1

Note

When the document cannot be matched to a specific category, the value may be set to other, if classification capability is enabled.