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

Inherits:

Struct

• Object
• Struct
• Aws::ComprehendMedical::Types::Entity

Defined in:

gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb

Overview

Provides information about an extracted medical entity.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes ⇒ Array<Types::Attribute>

  The extracted attributes that relate to this entity.

• #begin_offset ⇒ Integer

  The 0-based character offset in the input text that shows where the entity begins.

• #category ⇒ String

  The category of the entity.

• #end_offset ⇒ Integer

  The 0-based character offset in the input text that shows where the entity ends.

• #id ⇒ Integer

  The numeric identifier for the entity.

• #score ⇒ Float

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

• #text ⇒ String

  The segment of input text extracted as this entity.

• #traits ⇒ Array<Types::Trait>

  Contextual information for the entity.

• #type ⇒ String

  Describes the specific type of entity with category of entities.

Instance Attribute Details

#attributes ⇒ Array<Types::Attribute>

The extracted attributes that relate to this entity.

Returns:

• (Array<Types::Attribute>)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 548

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

#begin_offset ⇒ Integer

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)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 548

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

#category ⇒ String

The category of the entity.

Returns:

• (String)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 548

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

#end_offset ⇒ Integer

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)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 548

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

#id ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 548

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

#score ⇒ Float

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

Returns:

• (Float)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 548

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

#text ⇒ String

The segment of input text extracted as this entity.

Returns:

• (String)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 548

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

#traits ⇒ Array<Types::Trait>

Contextual information for the entity.

Returns:

• (Array<Types::Trait>)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 548

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

#type ⇒ String

Describes the specific type of entity with category of entities.

Returns:

• (String)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 548

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