Amazon Comprehend
Developer Guide

DetectSyntax

Inspects text for syntax and the part of speech of words in the document. For more information, Syntax.

Request Syntax

{ "LanguageCode": "string", "Text": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

LanguageCode

The language code of the input documents. You can specify English ("en") or Spanish ("es").

Type: String

Valid Values: en

Required: Yes

Text

A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

{ "SyntaxTokens": [ { "BeginOffset": number, "EndOffset": number, "PartOfSpeech": { "Score": number, "Tag": "string" }, "Text": "string", "TokenId": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SyntaxTokens

A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see Syntax.

Type: Array of SyntaxToken objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

InvalidRequestException

The request is invalid.

HTTP Status Code: 400

TextSizeLimitExceededException

The size of the input text exceeds the limit. Use a smaller document.

HTTP Status Code: 400

UnsupportedLanguageException

Amazon Comprehend can't process the language of the input text. For all APIs except DetectDominantLanguage, Amazon Comprehend accepts only English or Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects 100 languages. For a list of languages, see Dominant Language

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: