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

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::ClassifyDocumentResponse

Defined in:

gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #classes ⇒ Array<Types::DocumentClass>

  The classes used by the document being analyzed.

• #document_metadata ⇒ Types::DocumentMetadata

  Extraction information about the document.

• #document_type ⇒ Array<Types::DocumentTypeListItem>

  The document type for each page in the input document.

• #errors ⇒ Array<Types::ErrorsListItem>

  Page-level errors that the system detected while processing the input document.

• #labels ⇒ Array<Types::DocumentLabel>

  The labels used the document being analyzed.

Instance Attribute Details

#classes ⇒ Array<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:

• (Array<Types::DocumentClass>)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 867

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

#document_metadata ⇒ Types::DocumentMetadata

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

Returns:

• (Types::DocumentMetadata)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 867

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

#document_type ⇒ Array<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:

• (Array<Types::DocumentTypeListItem>)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 867

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

#errors ⇒ Array<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:

• (Array<Types::ErrorsListItem>)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 867

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

#labels ⇒ Array<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:

• (Array<Types::DocumentLabel>)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 867

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