Skip to content

DetectPHIResponse

Source code in docs_src/capo_comprehendmedical/types/detect_phi_response.py 
14
15
16
17
18
19
20
class DetectPHIResponse(TypedDict, closed=True):
    entities: "capo_comprehendmedical.types.entity_list.EntityList"
    """<p>The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.</p>"""
    pagination_token: NotRequired["capo_comprehendmedical.types.string.String"]
    """<p>If the result of the previous request to <code>DetectPHI</code> was truncated, include the <code>PaginationToken</code> to fetch the next page of PHI entities. </p>"""
    model_version: "capo_comprehendmedical.types.string.String"
    """<p>The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.</p>"""

entities instance-attribute 

entities: EntityList

The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.

model_version instance-attribute 

model_version: String

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

pagination_token instance-attribute 

pagination_token: NotRequired[String]

If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.