Comprehend / Client / batch_detect_entities

batch_detect_entities#

Comprehend.Client.batch_detect_entities(**kwargs)#

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.batch_detect_entities(
    TextList=[
        'string',
    ],
    LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
)
Parameters:

  • TextList (list) –

    [REQUIRED]

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

    • (string) –

  • LanguageCode (string) –

    [REQUIRED]

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Return type:

dict

Returns:

Response Syntax

{
    'ResultList': [
        {
            'Index': 123,
            'Entities': [
                {
                    'Score': ...,
                    'Type': 'PERSON'|'LOCATION'|'ORGANIZATION'|'COMMERCIAL_ITEM'|'EVENT'|'DATE'|'QUANTITY'|'TITLE'|'OTHER',
                    'Text': 'string',
                    'BeginOffset': 123,
                    'EndOffset': 123,
                    'BlockReferences': [
                        {
                            'BlockId': 'string',
                            'BeginOffset': 123,
                            'EndOffset': 123,
                            'ChildBlocks': [
                                {
                                    'ChildBlockId': 'string',
                                    'BeginOffset': 123,
                                    'EndOffset': 123
                                },
                            ]
                        },
                    ]
                },
            ]
        },
    ],
    'ErrorList': [
        {
            'Index': 123,
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • ResultList (list) –

      A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

      • (dict) –

        The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

        • Index (integer) –

          The zero-based index of the document in the input list.

        • Entities (list) –

          One or more Entity objects, one for each entity detected in the document.

          • (dict) –

            Provides information about an entity.

            • Score (float) –

              The level of confidence that Amazon Comprehend has in the accuracy of the detection.

            • Type (string) –

              The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

              For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

            • Text (string) –

              The text of the entity.

            • BeginOffset (integer) –

              The zero-based offset from the beginning of the source text to the first character in the entity.

              This field is empty for non-text input.

            • EndOffset (integer) –

              The zero-based offset from the beginning of the source text to the last character in the entity.

              This field is empty for non-text input.

            • BlockReferences (list) –

              A reference to each block for this entity. This field is empty for plain-text input.

              • (dict) –

                A reference to a block.

                • BlockId (string) –

                  Unique identifier for the block.

                • BeginOffset (integer) –

                  Offset of the start of the block within its parent block.

                • EndOffset (integer) –

                  Offset of the end of the block within its parent block.

                • ChildBlocks (list) –

                  List of child blocks within this block.

                  • (dict) –

                    Nested block contained within a block.

                    • ChildBlockId (string) –

                      Unique identifier for the child block.

                    • BeginOffset (integer) –

                      Offset of the start of the child block within its parent block.

                    • EndOffset (integer) –

                      Offset of the end of the child block within its parent block.

    • ErrorList (list) –

      A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

      • (dict) –

        Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.

        • Index (integer) –

          The zero-based index of the document in the input list.

        • ErrorCode (string) –

          The numeric error code of the error.

        • ErrorMessage (string) –

          A text description of the error.

Exceptions