You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

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)


584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 584

class Entity < Struct.new(
  :score,
  :type,
  :text,
  :begin_offset,
  :end_offset)
  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)


584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 584

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

#scoreFloat

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

Returns:

  • (Float)


584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 584

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

#textString

The text of the entity.

Returns:

  • (String)


584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 584

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

#typeString

The entity's type.

Returns:

  • (String)


584
585
586
587
588
589
590
591
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 584

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