Class: Aws::ComprehendMedical::Types::SNOMEDCTEntity

Inherits:

Struct

• Object
• Struct
• Aws::ComprehendMedical::Types::SNOMEDCTEntity

Includes:

Structure

Defined in:

lib/aws-sdk-comprehendmedical/types.rb

Overview

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes ⇒ Array<Types::SNOMEDCTAttribute>

  An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.

• #begin_offset ⇒ Integer

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

• #category ⇒ String

  The category of the detected 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 detected entity.

• #snomedct_concepts ⇒ Array<Types::SNOMEDCTConcept>

  The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.

• #text ⇒ String

  The segment of input text extracted as this entity.

• #traits ⇒ Array<Types::SNOMEDCTTrait>

  Contextual information for the entity.

• #type ⇒ String

  Describes the specific type of entity with category of entities.

Instance Attribute Details

#attributes ⇒ Array<Types::SNOMEDCTAttribute>

An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.

Returns:

• (Array<Types::SNOMEDCTAttribute>)

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

class SNOMEDCTEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :snomedct_concepts)
  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 'lib/aws-sdk-comprehendmedical/types.rb', line 1588

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

#category ⇒ String

The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.

Returns:

• (String)

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

class SNOMEDCTEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :snomedct_concepts)
  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 'lib/aws-sdk-comprehendmedical/types.rb', line 1588

class SNOMEDCTEntity < Struct.new(
  :id,
  :text,
  :category,
  :type,
  :score,
  :begin_offset,
  :end_offset,
  :attributes,
  :traits,
  :snomedct_concepts)
  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 'lib/aws-sdk-comprehendmedical/types.rb', line 1588

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

#score ⇒ Float

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

Returns:

• (Float)

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

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

#snomedct_concepts ⇒ Array<Types::SNOMEDCTConcept>

The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Returns:

• (Array<Types::SNOMEDCTConcept>)

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

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

#text ⇒ String

The segment of input text extracted as this entity.

Returns:

• (String)

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

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

#traits ⇒ Array<Types::SNOMEDCTTrait>

Contextual information for the entity.

Returns:

• (Array<Types::SNOMEDCTTrait>)

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

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

#type ⇒ String

Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.

Returns:

• (String)

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

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