Entity ¶

class Entity(TypedDict, closed=True):
    id: NotRequired["capo_comprehendmedical.types.integer.Integer"]
    """<p> The numeric identifier for the entity. 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 entity 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 entity ends. The offset returns the UTF-8 code point in the string. </p>"""
    score: NotRequired["capo_comprehendmedical.types.float.Float"]
    """<p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.</p>"""
    text: NotRequired["capo_comprehendmedical.types.string.String"]
    """<p> The segment of input text extracted as this entity.</p>"""
    category: NotRequired["capo_comprehendmedical.types.entity_type.EntityType"]
    """<p> The category of the entity.</p>"""
    type: NotRequired["capo_comprehendmedical.types.entity_sub_type.EntitySubType"]
    """<p> Describes the specific type of entity with category of entities.</p>"""
    traits: NotRequired["capo_comprehendmedical.types.trait_list.TraitList"]
    """<p>Contextual information for the entity.</p>"""
    attributes: NotRequired["capo_comprehendmedical.types.attribute_list.AttributeList"]
    """<p> The extracted attributes that relate to this entity.</p>"""