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

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.

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)


59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 59

class Attribute < Struct.new(
  :type,
  :score,
  :relationship_score,
  :id,
  :begin_offset,
  :end_offset,
  :text,
  :traits)
  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)


59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 59

class Attribute < Struct.new(
  :type,
  :score,
  :relationship_score,
  :id,
  :begin_offset,
  :end_offset,
  :text,
  :traits)
  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)


59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 59

class Attribute < Struct.new(
  :type,
  :score,
  :relationship_score,
  :id,
  :begin_offset,
  :end_offset,
  :text,
  :traits)
  include Aws::Structure
end

#relationship_scoreFloat

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

Returns:

  • (Float)


59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 59

class Attribute < Struct.new(
  :type,
  :score,
  :relationship_score,
  :id,
  :begin_offset,
  :end_offset,
  :text,
  :traits)
  include Aws::Structure
end

#scoreFloat

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

Returns:

  • (Float)


59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 59

class Attribute < Struct.new(
  :type,
  :score,
  :relationship_score,
  :id,
  :begin_offset,
  :end_offset,
  :text,
  :traits)
  include Aws::Structure
end

#textString

The segment of input text extracted as this attribute.

Returns:

  • (String)


59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 59

class Attribute < Struct.new(
  :type,
  :score,
  :relationship_score,
  :id,
  :begin_offset,
  :end_offset,
  :text,
  :traits)
  include Aws::Structure
end

#traitsArray<Types::Trait>

Contextual information for this attribute.

Returns:



59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 59

class Attribute < Struct.new(
  :type,
  :score,
  :relationship_score,
  :id,
  :begin_offset,
  :end_offset,
  :text,
  :traits)
  include Aws::Structure
end

#typeString

The type of attribute.

Returns:

  • (String)


59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 59

class Attribute < Struct.new(
  :type,
  :score,
  :relationship_score,
  :id,
  :begin_offset,
  :end_offset,
  :text,
  :traits)
  include Aws::Structure
end