Skip to content

DetectEntitiesResponse

Source code in docs_src/capo_comprehendmedical/types/detect_entities_response.py 
15
16
17
18
19
20
21
22
23
24
25
class DetectEntitiesResponse(TypedDict, closed=True):
    entities: "capo_comprehendmedical.types.entity_list.EntityList"
    """<p>The collection of medical 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 the detection and analysis. Attributes and traits of the entity are also returned.</p>"""
    unmapped_attributes: NotRequired[
        "capo_comprehendmedical.types.unmapped_attribute_list.UnmappedAttributeList"
    ]
    """<p>Attributes extracted from the input text that we were unable to relate to an entity.</p>"""
    pagination_token: NotRequired["capo_comprehendmedical.types.string.String"]
    """<p>If the result of the previous request to <code>DetectEntities</code> was truncated, include the <code>PaginationToken</code> to fetch the next page of 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 medical 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 the detection and analysis. Attributes and traits of the entity are also returned.

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 DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.

unmapped_attributes instance-attribute 

unmapped_attributes: NotRequired[UnmappedAttributeList]

Attributes extracted from the input text that we were unable to relate to an entity.