Class: Aws::Comprehend::Types::ClassifyDocumentResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#classesArray<Types::DocumentClass>

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.

Returns:



871
872
873
874
875
876
877
878
879
880
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 871

class ClassifyDocumentResponse < Struct.new(
  :classes,
  :labels,
  :document_metadata,
  :document_type,
  :errors,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#document_metadataTypes::DocumentMetadata

Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.



871
872
873
874
875
876
877
878
879
880
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 871

class ClassifyDocumentResponse < Struct.new(
  :classes,
  :labels,
  :document_metadata,
  :document_type,
  :errors,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#document_typeArray<Types::DocumentTypeListItem>

The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

Returns:



871
872
873
874
875
876
877
878
879
880
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 871

class ClassifyDocumentResponse < Struct.new(
  :classes,
  :labels,
  :document_metadata,
  :document_type,
  :errors,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#errorsArray<Types::ErrorsListItem>

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

Returns:



871
872
873
874
875
876
877
878
879
880
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 871

class ClassifyDocumentResponse < Struct.new(
  :classes,
  :labels,
  :document_metadata,
  :document_type,
  :errors,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#labelsArray<Types::DocumentLabel>

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.

Returns:



871
872
873
874
875
876
877
878
879
880
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 871

class ClassifyDocumentResponse < Struct.new(
  :classes,
  :labels,
  :document_metadata,
  :document_type,
  :errors,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#warningsArray<Types::WarningsListItem>

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.

The field is empty if the system generated no warnings.

Returns:



871
872
873
874
875
876
877
878
879
880
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 871

class ClassifyDocumentResponse < Struct.new(
  :classes,
  :labels,
  :document_metadata,
  :document_type,
  :errors,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end