Aller au contenu principal

DocumentClassificationResponse

Classification information — present when requested via include=classification or include=all

classificationStatusstring | nullnullable
documentClass object
oneOf
identifierstringrequired
codestringrequired
names objectrequired
property name*string
predictedDocumentClass object
oneOf
predictedDocumentClassIdentifierstringrequired
predictedDocumentClassCodestringrequired
predictedDocumentClassNames objectrequired
property name*string
confidenceIndex(number | null)<double>nullable
predictedFolder object
oneOf
identifierstringrequired
names objectrequired
property name*string
docsUsedToClassify object[]required
  • Array [
    • fileResourceUidstringrequired
    documentUidstringrequired
    cosineSimilaritystringrequired
    namestringrequired
  • ]
    • DocumentClassificationResponse
    {
      "classificationStatus": "string",
      "documentClass": {
        "identifier": "string",
        "code": "string",
        "names": {}
      },
      "predictedDocumentClass": {
        "predictedDocumentClassIdentifier": "string",
        "predictedDocumentClassCode": "string",
        "predictedDocumentClassNames": {},
        "confidenceIndex": 0
      },
      "predictedFolder": {
        "identifier": "string",
        "names": {}
      },
      "docsUsedToClassify": [
        {
          "fileResourceUid": "string",
          "documentUid": "string",
          "cosineSimilarity": "string",
          "name": "string"
        }
      ]
    }