Class: Aws::Comprehend::Types::Entity

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::Entity

Includes:

Structure

Defined in:

lib/aws-sdk-comprehend/types.rb

Overview

Provides information about an entity.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #begin_offset ⇒ Integer

  The zero-based offset from the beginning of the source text to the first character in the entity.

• #block_references ⇒ Array<Types::BlockReference>

  A reference to each block for this entity.

• #end_offset ⇒ Integer

  The zero-based offset from the beginning of the source text to the last character in the entity.

• #score ⇒ Float

  The level of confidence that Amazon Comprehend has in the accuracy of the detection.

• #text ⇒ String

  The text of the entity.

• #type ⇒ String

  The entity type.

Instance Attribute Details

#begin_offset ⇒ Integer

The zero-based offset from the beginning of the source text to the first character in the entity.

This field is empty for non-text input.

Returns:

• (Integer)

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

class Entity < Struct.new(
  :score,
  :type,
  :text,
  :begin_offset,
  :end_offset,
  :block_references)
  SENSITIVE = []
  include Aws::Structure
end

#block_references ⇒ Array<Types::BlockReference>

A reference to each block for this entity. This field is empty for plain-text input.

Returns:

• (Array<Types::BlockReference>)

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

class Entity < Struct.new(
  :score,
  :type,
  :text,
  :begin_offset,
  :end_offset,
  :block_references)
  SENSITIVE = []
  include Aws::Structure
end

#end_offset ⇒ Integer

The zero-based offset from the beginning of the source text to the last character in the entity.

This field is empty for non-text input.

Returns:

• (Integer)

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

class Entity < Struct.new(
  :score,
  :type,
  :text,
  :begin_offset,
  :end_offset,
  :block_references)
  SENSITIVE = []
  include Aws::Structure
end

#score ⇒ Float

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Returns:

• (Float)

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

class Entity < Struct.new(
  :score,
  :type,
  :text,
  :begin_offset,
  :end_offset,
  :block_references)
  SENSITIVE = []
  include Aws::Structure
end

#text ⇒ String

The text of the entity.

Returns:

• (String)

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

class Entity < Struct.new(
  :score,
  :type,
  :text,
  :begin_offset,
  :end_offset,
  :block_references)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

Returns:

• (String)

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

class Entity < Struct.new(
  :score,
  :type,
  :text,
  :begin_offset,
  :end_offset,
  :block_references)
  SENSITIVE = []
  include Aws::Structure
end