Class: Aws::ComprehendMedical::Types::Entity

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

Overview

Provides information about an extracted medical entity.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesArray<Types::Attribute>

The extracted attributes that relate to this entity.

Returns:



617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 617

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

#begin_offsetInteger

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

Returns:

  • (Integer)


617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 617

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

#categoryString

The category of the entity.

Returns:

  • (String)


617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 617

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

#end_offsetInteger

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

Returns:

  • (Integer)


617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 617

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

#idInteger

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

Returns:

  • (Integer)


617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 617

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

#scoreFloat

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

Returns:

  • (Float)


617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 617

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

#textString

The segment of input text extracted as this entity.

Returns:

  • (String)


617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 617

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

#traitsArray<Types::Trait>

Contextual information for the entity.

Returns:



617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 617

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

#typeString

Describes the specific type of entity with category of entities.

Returns:

  • (String)


617
618
619
620
621
622
623
624
625
626
627
628
629
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 617

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