Batch Detect Syntax

comprehend_batch_detect_syntax

R Documentation

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them

Description

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide.

Usage

comprehend_batch_detect_syntax(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 for each document is 5 KB.

LanguageCode

[required] The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

Value

A list with the following syntax:

list(
  ResultList = list(
    list(
      Index = 123,
      SyntaxTokens = list(
        list(
          TokenId = 123,
          Text = "string",
          BeginOffset = 123,
          EndOffset = 123,
          PartOfSpeech = list(
            Tag = "ADJ"|"ADP"|"ADV"|"AUX"|"CONJ"|"CCONJ"|"DET"|"INTJ"|"NOUN"|"NUM"|"O"|"PART"|"PRON"|"PROPN"|"PUNCT"|"SCONJ"|"SYM"|"VERB",
            Score = 123.0
          )
        )
      )
    )
  ),
  ErrorList = list(
    list(
      Index = 123,
      ErrorCode = "string",
      ErrorMessage = "string"
    )
  )
)

Request syntax

svc$batch_detect_syntax(
  TextList = list(
    "string"
  ),
  LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"
)