Skip to content

PiiEntity

Source code in docs_src/capo_comprehend/types/pii_entity.py 
13
14
15
16
17
18
19
20
21
class PiiEntity(TypedDict, closed=True):
    score: NotRequired["capo_comprehend.types.float.Float"]
    """<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>"""
    type: NotRequired["capo_comprehend.types.pii_entity_type.PiiEntityType"]
    """<p>The entity's type.</p>"""
    begin_offset: NotRequired["capo_comprehend.types.integer.Integer"]
    """<p>The zero-based offset from the beginning of the source text to the first character in the entity.</p>"""
    end_offset: NotRequired["capo_comprehend.types.integer.Integer"]
    """<p>The zero-based offset from the beginning of the source text to the last character in the entity.</p>"""

begin_offset instance-attribute 

begin_offset: NotRequired[Integer]

The zero-based offset from the beginning of the source text to the first character in the entity.

end_offset instance-attribute 

end_offset: NotRequired[Integer]

The zero-based offset from the beginning of the source text to the last character in the entity.

score instance-attribute 

score: NotRequired[Float]

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

type instance-attribute 

type: NotRequired[PiiEntityType]

The entity's type.