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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#begin_offset ⇒ Integer

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 '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

#category ⇒ String

The category of attribute.

Returns:

  • (String) 

71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File '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_offset ⇒ Integer

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 '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

#id ⇒ Integer

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 '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_score ⇒ Float

The level of confidence that 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 '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_type ⇒ String

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 '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

#score ⇒ Float

The level of confidence that 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 '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

#text ⇒ String

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 '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

#traits ⇒ Array<Types::Trait>

Contextual information for this attribute.

Returns:


71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File '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

#type ⇒ String

The type of attribute.

Returns:

  • (String) 

71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File '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