libZSservicesZSamazonka-comprehendZSamazonka-comprehend
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Comprehend.DetectSyntax

Description

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

Synopsis

Creating a Request

data DetectSyntax Source #

See: newDetectSyntax smart constructor.

Constructors

DetectSyntax' 

Fields

  • text :: Sensitive Text

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

  • languageCode :: SyntaxLanguageCode

    The language code 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").

Instances

Instances details
Eq DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Show DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Generic DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Associated Types

type Rep DetectSyntax :: Type -> Type #

NFData DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Methods

rnf :: DetectSyntax -> () #

Hashable DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

ToJSON DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

AWSRequest DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Associated Types

type AWSResponse DetectSyntax #

ToHeaders DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

ToPath DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

ToQuery DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

type Rep DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

type Rep DetectSyntax = D1 ('MetaData "DetectSyntax" "Amazonka.Comprehend.DetectSyntax" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectSyntax'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SyntaxLanguageCode)))
type AWSResponse DetectSyntax Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

newDetectSyntax Source #

Create a value of DetectSyntax with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:text:DetectSyntax', detectSyntax_text - A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.

$sel:languageCode:DetectSyntax', detectSyntax_languageCode - The language code 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").

Request Lenses

detectSyntax_text :: Lens' DetectSyntax Text Source #

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

detectSyntax_languageCode :: Lens' DetectSyntax SyntaxLanguageCode Source #

The language code 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").

Destructuring the Response

data DetectSyntaxResponse Source #

See: newDetectSyntaxResponse smart constructor.

Constructors

DetectSyntaxResponse' 

Fields

  • syntaxTokens :: Maybe [SyntaxToken]

    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 how-syntax.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Show DetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Generic DetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Associated Types

type Rep DetectSyntaxResponse :: Type -> Type #

NFData DetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

Methods

rnf :: DetectSyntaxResponse -> () #

type Rep DetectSyntaxResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectSyntax

type Rep DetectSyntaxResponse = D1 ('MetaData "DetectSyntaxResponse" "Amazonka.Comprehend.DetectSyntax" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "DetectSyntaxResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "syntaxTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SyntaxToken])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetectSyntaxResponse Source #

Create a value of DetectSyntaxResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:syntaxTokens:DetectSyntaxResponse', detectSyntaxResponse_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 how-syntax.

$sel:httpStatus:DetectSyntaxResponse', detectSyntaxResponse_httpStatus - The response's http status code.

Response Lenses

detectSyntaxResponse_syntaxTokens :: Lens' DetectSyntaxResponse (Maybe [SyntaxToken]) Source #

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 how-syntax.