Comprehend / Client / describe_entity_recognizer

describe_entity_recognizer

Comprehend.Client.describe_entity_recognizer(**kwargs)

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

See also: AWS API Documentation

Request Syntax

response = client.describe_entity_recognizer(
    EntityRecognizerArn='string'
)

Parameters:

EntityRecognizerArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Return type:

dict

Returns:

Response Syntax

{
    'EntityRecognizerProperties': {
        'EntityRecognizerArn': 'string',
        'LanguageCode': 'en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW',
        'Status': 'SUBMITTED'|'TRAINING'|'DELETING'|'STOP_REQUESTED'|'STOPPED'|'IN_ERROR'|'TRAINED',
        'Message': 'string',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'TrainingStartTime': datetime(2015, 1, 1),
        'TrainingEndTime': datetime(2015, 1, 1),
        'InputDataConfig': {
            'DataFormat': 'COMPREHEND_CSV'|'AUGMENTED_MANIFEST',
            'EntityTypes': [
                {
                    'Type': 'string'
                },
            ],
            'Documents': {
                'S3Uri': 'string',
                'TestS3Uri': 'string',
                'InputFormat': 'ONE_DOC_PER_FILE'|'ONE_DOC_PER_LINE'
            },
            'Annotations': {
                'S3Uri': 'string',
                'TestS3Uri': 'string'
            },
            'EntityList': {
                'S3Uri': 'string'
            },
            'AugmentedManifests': [
                {
                    'S3Uri': 'string',
                    'Split': 'TRAIN'|'TEST',
                    'AttributeNames': [
                        'string',
                    ],
                    'AnnotationDataS3Uri': 'string',
                    'SourceDocumentsS3Uri': 'string',
                    'DocumentType': 'PLAIN_TEXT_DOCUMENT'|'SEMI_STRUCTURED_DOCUMENT'
                },
            ]
        },
        'RecognizerMetadata': {
            'NumberOfTrainedDocuments': 123,
            'NumberOfTestDocuments': 123,
            'EvaluationMetrics': {
                'Precision': 123.0,
                'Recall': 123.0,
                'F1Score': 123.0
            },
            'EntityTypes': [
                {
                    'Type': 'string',
                    'EvaluationMetrics': {
                        'Precision': 123.0,
                        'Recall': 123.0,
                        'F1Score': 123.0
                    },
                    'NumberOfTrainMentions': 123
                },
            ]
        },
        'DataAccessRoleArn': 'string',
        'VolumeKmsKeyId': 'string',
        'VpcConfig': {
            'SecurityGroupIds': [
                'string',
            ],
            'Subnets': [
                'string',
            ]
        },
        'ModelKmsKeyId': 'string',
        'VersionName': 'string',
        'SourceModelArn': 'string',
        'FlywheelArn': 'string',
        'OutputDataConfig': {
            'FlywheelStatsS3Prefix': 'string'
        }
    }
}

Response Structure

• (dict) –

  • EntityRecognizerProperties (dict) –

    Describes information associated with an entity recognizer.

    • EntityRecognizerArn (string) –

      The Amazon Resource Name (ARN) that identifies the entity recognizer.

    • LanguageCode (string) –

      The language of the input documents. All documents must be in the same language. Only English (“en”) is currently supported.

    • Status (string) –

      Provides the status of the entity recognizer.

    • Message (string) –

      A description of the status of the recognizer.

    • SubmitTime (datetime) –

      The time that the recognizer was submitted for processing.

    • EndTime (datetime) –

      The time that the recognizer creation completed.

    • TrainingStartTime (datetime) –

      The time that training of the entity recognizer started.

    • TrainingEndTime (datetime) –

      The time that training of the entity recognizer was completed.

    • InputDataConfig (dict) –

      The input data properties of an entity recognizer.

      • DataFormat (string) –

        The format of your training data:

        • COMPREHEND_CSV: A CSV file that supplements your training documents. The CSV file contains information about the custom entities that your trained model will detect. The required format of the file depends on whether you are providing annotations or an entity list. If you use this value, you must provide your CSV file by using either the Annotations or EntityList parameters. You must provide your training documents by using the Documents parameter.

        • AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON object that contains a training document and its labels. Each label annotates a named entity in the training document. If you use this value, you must provide the AugmentedManifests parameter in your request.

        If you don’t specify a value, Amazon Comprehend uses COMPREHEND_CSV as the default.

      • EntityTypes (list) –

        The entity types in the labeled training data that Amazon Comprehend uses to train the custom entity recognizer. Any entity types that you don’t specify are ignored.

        A maximum of 25 entity types can be used at one time to train an entity recognizer. Entity types must not contain the following invalid characters: n (line break), \n (escaped line break), r (carriage return), \r (escaped carriage return), t (tab), \t (escaped tab), space, and , (comma).

        • (dict) –

          An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

          • Type (string) –

            An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

            Entity types must not contain the following invalid characters: n (line break), \n (escaped line break, r (carriage return), \r (escaped carriage return), t (tab), \t (escaped tab), space, and , (comma).

      • Documents (dict) –

        The S3 location of the folder that contains the training documents for your custom entity recognizer.

        This parameter is required if you set DataFormat to COMPREHEND_CSV.

        • S3Uri (string) –

          Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

        • TestS3Uri (string) –

          Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

        • InputFormat (string) –

          Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

      • Annotations (dict) –

        The S3 location of the CSV file that annotates your training documents.

        • S3Uri (string) –

          Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

        • TestS3Uri (string) –

          Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

      • EntityList (dict) –

        The S3 location of the CSV file that has the entity list for your custom entity recognizer.

        • S3Uri (string) –

          Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.

      • AugmentedManifests (list) –

        A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

        This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

        • (dict) –

          An augmented manifest file that provides training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

          • S3Uri (string) –

            The Amazon S3 location of the augmented manifest file.

          • Split (string) –

            The purpose of the data you’ve provided in the augmented manifest. You can either train or test this data. If you don’t specify, the default is train.

            TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

            TEST - all of the documents in the manifest will be used for testing.

          • AttributeNames (list) –

            The JSON attribute that contains the annotations for your training documents. The number of attribute names that you specify depends on whether your augmented manifest file is the output of a single labeling job or a chained labeling job.

            If your file is the output of a single labeling job, specify the LabelAttributeName key that was used when the job was created in Ground Truth.

            If your file is the output of a chained labeling job, specify the LabelAttributeName key for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from an individual job.

            • (string) –

          • AnnotationDataS3Uri (string) –

            The S3 prefix to the annotation files that are referred in the augmented manifest file.

          • SourceDocumentsS3Uri (string) –

            The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

          • DocumentType (string) –

            The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don’t specify, the default is PlainTextDocument.

            • PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

            • SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For inference, Amazon Comprehend support PDFs, DOCX and TXT.

    • RecognizerMetadata (dict) –

      Provides information about an entity recognizer.

      • NumberOfTrainedDocuments (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.

      • NumberOfTestDocuments (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.

      • EvaluationMetrics (dict) –

        Detailed information about the accuracy of an entity recognizer.

        • Precision (float) –

          A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

        • Recall (float) –

          A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.

        • F1Score (float) –

          A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100, where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1, where 1 is the best score.

      • EntityTypes (list) –

        Entity types from the metadata of an entity recognizer.

        • (dict) –

          Individual item from the list of entity types in the metadata of an entity recognizer.

          • Type (string) –

            Type of entity from the list of entity types in the metadata of an entity recognizer.

          • EvaluationMetrics (dict) –

            Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.

            • Precision (float) –

              A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

            • Recall (float) –

              A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

            • F1Score (float) –

              A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

          • NumberOfTrainMentions (integer) –

            Indicates the number of times the given entity type was seen in the training data.

    • DataAccessRoleArn (string) –

      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

    • VolumeKmsKeyId (string) –

      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

      • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

      • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    • VpcConfig (dict) –

      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

      • SecurityGroupIds (list) –

        The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by “sg-”, for instance: “sg-03b388029b0a285ea”. For more information, see Security Groups for your VPC.

        • (string) –

      • Subnets (list) –

        The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by “subnet-”, for instance: “subnet-04ccf456919e69055”. For more information, see VPCs and Subnets.

        • (string) –

    • ModelKmsKeyId (string) –

      ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

      • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

      • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

    • VersionName (string) –

      The version name you assigned to the entity recognizer.

    • SourceModelArn (string) –

      The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.

    • FlywheelArn (string) –

      The Amazon Resource Number (ARN) of the flywheel

    • OutputDataConfig (dict) –

      Output data configuration.

      • FlywheelStatsS3Prefix (string) –

        The Amazon S3 prefix for the data lake location of the flywheel statistics.

Exceptions

• Comprehend.Client.exceptions.InvalidRequestException

• Comprehend.Client.exceptions.TooManyRequestsException

• Comprehend.Client.exceptions.ResourceNotFoundException

• Comprehend.Client.exceptions.InternalServerException