Skip to content

InferSNOMEDCTResponse

Source code in docs_src/capo_comprehendmedical/types/infer_snomedct_response.py
class InferSNOMEDCTResponse(TypedDict, closed=True):
    entities: "capo_comprehendmedical.types.snomedct_entity_list.SNOMEDCTEntityList"
    """<p> The collection of medical concept 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>"""
    pagination_token: NotRequired["capo_comprehendmedical.types.string.String"]
    """<p> If the result of the request is truncated, the pagination token can be used to fetch the next page of entities. </p>"""
    model_version: NotRequired["capo_comprehendmedical.types.string.String"]
    """<p> The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents. </p>"""
    snomedct_details: NotRequired[
        "capo_comprehendmedical.types.snomedct_details.SNOMEDCTDetails"
    ]
    """<p> The details of the SNOMED-CT revision, including the edition, language, and version date. </p>"""
    characters: NotRequired["capo_comprehendmedical.types.characters.Characters"]
    """<p> The number of characters in the input request documentation. </p>"""

characters instance-attribute

characters: NotRequired[Characters]

The number of characters in the input request documentation.

entities instance-attribute

The collection of medical concept 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: NotRequired[String]

The version of the model used to analyze the documents, in the format n.n.n 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 request is truncated, the pagination token can be used to fetch the next page of entities.

snomedct_details instance-attribute

snomedct_details: NotRequired[SNOMEDCTDetails]

The details of the SNOMED-CT revision, including the edition, language, and version date.