AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

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.

Constant Summary collapse

SENSITIVE =
[]

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)


71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 71

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

#categoryString

The category of attribute.

Returns:

  • (String)


71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 71

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

#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)


71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 71

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

#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)


71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 71

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

#relationship_scoreFloat

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

Returns:

  • (Float)


71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 71

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

#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.

Returns:

  • (String)


71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 71

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

#scoreFloat

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

Returns:

  • (Float)


71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 71

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

#textString

The segment of input text extracted as this attribute.

Returns:

  • (String)


71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 71

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

#traitsArray<Types::Trait>

Contextual information for this attribute.

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 71

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

#typeString

The type of attribute.

Returns:

  • (String)


71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 71

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