Class: Aws::Comprehend::Types::DetectEntitiesResponse

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::DetectEntitiesResponse

Includes:

Structure

Defined in:

lib/aws-sdk-comprehend/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #blocks ⇒ Array<Types::Block>

  Information about each block of text in the input document.

• #document_metadata ⇒ Types::DocumentMetadata

  Information about the document, discovered during text extraction.

• #document_type ⇒ Array<Types::DocumentTypeListItem>

  The document type for each page in the input document.

• #entities ⇒ Array<Types::Entity>

  A collection of entities identified in the input text.

• #errors ⇒ Array<Types::ErrorsListItem>

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

Instance Attribute Details

#blocks ⇒ Array<Types::Block>

Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

The ‘Block` content for a Word input document does not include a `Geometry` field.

The ‘Block` field is not present in the response for plain-text inputs.

Returns:

• (Array<Types::Block>)

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

class DetectEntitiesResponse < Struct.new(
  :entities,
  :document_metadata,
  :document_type,
  :blocks,
  :errors)
  SENSITIVE = []
  include Aws::Structure
end

#document_metadata ⇒ Types::DocumentMetadata

Information about the document, discovered during text extraction. This field is present in the response only if your request used the ‘Byte` parameter.

Returns:

• (Types::DocumentMetadata)

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

class DetectEntitiesResponse < Struct.new(
  :entities,
  :document_metadata,
  :document_type,
  :blocks,
  :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 used the ‘Byte` parameter.

Returns:

• (Array<Types::DocumentTypeListItem>)

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

class DetectEntitiesResponse < Struct.new(
  :entities,
  :document_metadata,
  :document_type,
  :blocks,
  :errors)
  SENSITIVE = []
  include Aws::Structure
end

#entities ⇒ Array<Types::Entity>

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see [Entities] in the Comprehend Developer Guide.

[1]: docs.aws.amazon.com/comprehend/latest/dg/how-entities.html

Returns:

• (Array<Types::Entity>)

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

class DetectEntitiesResponse < Struct.new(
  :entities,
  :document_metadata,
  :document_type,
  :blocks,
  :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 'lib/aws-sdk-comprehend/types.rb', line 2486

class DetectEntitiesResponse < Struct.new(
  :entities,
  :document_metadata,
  :document_type,
  :blocks,
  :errors)
  SENSITIVE = []
  include Aws::Structure
end