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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#blocksArray<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:



2486
2487
2488
2489
2490
2491
2492
2493
2494
# 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_metadataTypes::DocumentMetadata

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



2486
2487
2488
2489
2490
2491
2492
2493
2494
# 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_typeArray<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:



2486
2487
2488
2489
2490
2491
2492
2493
2494
# 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

#entitiesArray<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:



2486
2487
2488
2489
2490
2491
2492
2493
2494
# 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

#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:



2486
2487
2488
2489
2490
2491
2492
2493
2494
# 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