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

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

Overview

Provides information about an entity.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#begin_offsetInteger

A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

  • (Integer)


2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2568

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

#end_offsetInteger

A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

  • (Integer)


2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2568

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

#scoreFloat

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

Returns:

  • (Float)


2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2568

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

#textString

The text of the entity.

Returns:

  • (String)


2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2568

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

#typeString

The entity's type.

Returns:

  • (String)


2568
2569
2570
2571
2572
2573
2574
2575
2576
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2568

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