Amazon Comprehend · Schema

ClassifyDocumentResponse

ClassifyDocumentResponse schema

Machine LearningNatural Language ProcessingNLPText Analysis

Properties

Name Type Description
Classes object
Labels object
DocumentMetadata object
DocumentType object
Errors object
Warnings object
View JSON Schema on GitHub

JSON Schema

openapi.yml-classify-document-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-schema/openapi.yml-classify-document-response-schema.json",
  "title": "ClassifyDocumentResponse",
  "description": "ClassifyDocumentResponse schema",
  "type": "object",
  "properties": {
    "Classes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfClasses"
        },
        {
          "description": "The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time. "
        }
      ]
    },
    "Labels": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfLabels"
        },
        {
          "description": "The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time. "
        }
      ]
    },
    "DocumentMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DocumentMetadata"
        },
        {
          "description": "Extraction information about the document. This field is present in the response only if your request includes the <code>Byte</code> parameter. "
        }
      ]
    },
    "DocumentType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfDocumentType"
        },
        {
          "description": "The document type for each page in the input document. This field is present in the response only if your request includes the <code>Byte</code> parameter. "
        }
      ]
    },
    "Errors": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfErrors"
        },
        {
          "description": "Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors."
        }
      ]
    },
    "Warnings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfWarnings"
        },
        {
          "description": "<p>Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch. </p> <p>The field is empty if the system generated no warnings.</p>"
        }
      ]
    }
  }
}