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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#classes ⇒ Array<Types::DocumentClass>

The classes used by the document being analyzed. These are used for models trained in multi-class mode. 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.

For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.

Returns:



890
891
892
893
894
895
896
897
898
899
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 890

class ClassifyDocumentResponse < Struct.new(
  :classes,
  :labels,
  :document_metadata,
  :document_type,
  :errors,
  :warnings)
  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:



890
891
892
893
894
895
896
897
898
899
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 890

class ClassifyDocumentResponse < Struct.new(
  :classes,
  :labels,
  :document_metadata,
  :document_type,
  :errors,
  :warnings)
  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:



890
891
892
893
894
895
896
897
898
899
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 890

class ClassifyDocumentResponse < Struct.new(
  :classes,
  :labels,
  :document_metadata,
  :document_type,
  :errors,
  :warnings)
  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:



890
891
892
893
894
895
896
897
898
899
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 890

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

#labels ⇒ Array<Types::DocumentLabel>

The labels used in 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:



890
891
892
893
894
895
896
897
898
899
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 890

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

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



890
891
892
893
894
895
896
897
898
899
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 890

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