Batch Detect Entities

comprehend_batch_detect_entities

R Documentation

Inspects the text of a batch of documents for named entities and returns information about them

Description

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.

Usage

comprehend_batch_detect_entities(TextList, LanguageCode)

Arguments

TextList

[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.

LanguageCode

[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.

Value

A list with the following syntax:

list(
  ResultList = list(
    list(
      Index = 123,
      Entities = list(
        list(
          Score = 123.0,
          Type = "PERSON"|"LOCATION"|"ORGANIZATION"|"COMMERCIAL_ITEM"|"EVENT"|"DATE"|"QUANTITY"|"TITLE"|"OTHER",
          Text = "string",
          BeginOffset = 123,
          EndOffset = 123,
          BlockReferences = list(
            list(
              BlockId = "string",
              BeginOffset = 123,
              EndOffset = 123,
              ChildBlocks = list(
                list(
                  ChildBlockId = "string",
                  BeginOffset = 123,
                  EndOffset = 123
                )
              )
            )
          )
        )
      )
    )
  ),
  ErrorList = list(
    list(
      Index = 123,
      ErrorCode = "string",
      ErrorMessage = "string"
    )
  )
)

Request syntax

svc$batch_detect_entities(
  TextList = list(
    "string"
  ),
  LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|"ar"|"hi"|"ja"|"ko"|"zh"|"zh-TW"
)