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

Class: Aws::ComprehendMedical::Types::Attribute

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#begin_offsetInteger

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

Returns:

  • (Integer)

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

#categoryString

The category of attribute.

Possible values:

  • MEDICATION
  • MEDICAL_CONDITION
  • PROTECTED_HEALTH_INFORMATION
  • TEST_TREATMENT_PROCEDURE
  • ANATOMY
  • TIME_EXPRESSION

Returns:

  • (String)

    The category of attribute.

#end_offsetInteger

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

Returns:

  • (Integer)

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

#idInteger

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

Returns:

  • (Integer)

    The numeric identifier for this attribute.

#relationship_scoreFloat

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

Returns:

  • (Float)

    The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

#relationship_typeString

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

Possible values:

  • EVERY
  • WITH_DOSAGE
  • ADMINISTERED_VIA
  • FOR
  • NEGATIVE
  • OVERLAP
  • DOSAGE
  • ROUTE_OR_MODE
  • FORM
  • FREQUENCY
  • DURATION
  • STRENGTH
  • RATE
  • ACUITY
  • TEST_VALUE
  • TEST_UNITS
  • DIRECTION

Returns:

  • (String)

    The type of relationship between the entity and attribute.

#scoreFloat

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

Returns:

  • (Float)

    The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

#textString

The segment of input text extracted as this attribute.

Returns:

  • (String)

    The segment of input text extracted as this attribute.

#traitsArray<Types::Trait>

Contextual information for this attribute.

Returns:

  • (Array<Types::Trait>)

    Contextual information for this attribute.

#typeString

The type of attribute.

Possible values:

  • NAME
  • DOSAGE
  • ROUTE_OR_MODE
  • FORM
  • FREQUENCY
  • DURATION
  • GENERIC_NAME
  • BRAND_NAME
  • STRENGTH
  • RATE
  • ACUITY
  • TEST_NAME
  • TEST_VALUE
  • TEST_UNITS
  • PROCEDURE_NAME
  • TREATMENT_NAME
  • DATE
  • AGE
  • CONTACT_POINT
  • EMAIL
  • IDENTIFIER
  • URL
  • ADDRESS
  • PROFESSION
  • SYSTEM_ORGAN_SITE
  • DIRECTION
  • QUALITY
  • QUANTITY
  • TIME_EXPRESSION
  • TIME_TO_MEDICATION_NAME
  • TIME_TO_DX_NAME
  • TIME_TO_TEST_NAME
  • TIME_TO_PROCEDURE_NAME
  • TIME_TO_TREATMENT_NAME

Returns:

  • (String)

    The type of attribute.