Skip to content

Attribute

Source code in docs_src/capo_comprehendmedical/types/attribute.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class Attribute(TypedDict, closed=True):
    type: NotRequired["capo_comprehendmedical.types.entity_sub_type.EntitySubType"]
    """<p> The type of attribute. </p>"""
    score: NotRequired["capo_comprehendmedical.types.float.Float"]
    """<p> The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute. </p>"""
    relationship_score: NotRequired["capo_comprehendmedical.types.float.Float"]
    """<p> The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity. </p>"""
    relationship_type: NotRequired[
        "capo_comprehendmedical.types.relationship_type.RelationshipType"
    ]
    """<p>The type of relationship between the entity and attribute. Type for the relationship is <code>OVERLAP</code>, indicating that the entity occurred at the same time as the <code>Date_Expression</code>. </p>"""
    id: NotRequired["capo_comprehendmedical.types.integer.Integer"]
    """<p> The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier. </p>"""
    begin_offset: NotRequired["capo_comprehendmedical.types.integer.Integer"]
    """<p> 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. </p>"""
    end_offset: NotRequired["capo_comprehendmedical.types.integer.Integer"]
    """<p> 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.</p>"""
    text: NotRequired["capo_comprehendmedical.types.string.String"]
    """<p> The segment of input text extracted as this attribute.</p>"""
    category: NotRequired["capo_comprehendmedical.types.entity_type.EntityType"]
    """<p> The category of attribute. </p>"""
    traits: NotRequired["capo_comprehendmedical.types.trait_list.TraitList"]
    """<p> Contextual information for this attribute. </p>"""

begin_offset instance-attribute 

begin_offset: NotRequired[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.

category instance-attribute 

category: NotRequired[EntityType]

The category of attribute.

end_offset instance-attribute 

end_offset: NotRequired[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.

id instance-attribute 

id: NotRequired[Integer]

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

relationship_score instance-attribute 

relationship_score: NotRequired[Float]

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

relationship_type instance-attribute 

relationship_type: NotRequired[RelationshipType]

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.

score instance-attribute 

score: NotRequired[Float]

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

text instance-attribute 

text: NotRequired[String]

The segment of input text extracted as this attribute.

traits instance-attribute 

traits: NotRequired[TraitList]

Contextual information for this attribute.

type instance-attribute 

type: NotRequired[EntitySubType]

The type of attribute.