Skip to content

EntityRecognizerMetadata

Source code in docs_src/capo_comprehend/types/entity_recognizer_metadata.py
class EntityRecognizerMetadata(TypedDict, closed=True):
    number_of_trained_documents: NotRequired["capo_comprehend.types.integer.Integer"]
    """<p> The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.</p>"""
    number_of_test_documents: NotRequired["capo_comprehend.types.integer.Integer"]
    """<p> The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.</p>"""
    evaluation_metrics: NotRequired[
        "capo_comprehend.types.entity_recognizer_evaluation_metrics.EntityRecognizerEvaluationMetrics"
    ]
    """<p>Detailed information about the accuracy of an entity recognizer.</p>"""
    entity_types: NotRequired[
        "capo_comprehend.types.entity_recognizer_metadata_entity_types_list.EntityRecognizerMetadataEntityTypesList"
    ]
    """<p>Entity types from the metadata of an entity recognizer.</p>"""

entity_types instance-attribute

entity_types: NotRequired[EntityRecognizerMetadataEntityTypesList]

Entity types from the metadata of an entity recognizer.

evaluation_metrics instance-attribute

evaluation_metrics: NotRequired[EntityRecognizerEvaluationMetrics]

Detailed information about the accuracy of an entity recognizer.

number_of_test_documents instance-attribute

number_of_test_documents: NotRequired[Integer]

The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.

number_of_trained_documents instance-attribute

number_of_trained_documents: NotRequired[Integer]

The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.