amazonka-comprehend-2.0: Amazon Comprehend SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Comprehend.DetectKeyPhrases

Description

Detects the key noun phrases found in the text.

Synopsis

Creating a Request

data DetectKeyPhrases Source #

See: newDetectKeyPhrases smart constructor.

Constructors

DetectKeyPhrases' 

Fields

  • text :: Sensitive Text

    A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.

  • languageCode :: LanguageCode

    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.

Instances

Instances details
ToJSON DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

ToHeaders DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

ToPath DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

ToQuery DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

AWSRequest DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Associated Types

type AWSResponse DetectKeyPhrases #

Generic DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Associated Types

type Rep DetectKeyPhrases :: Type -> Type #

Show DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

NFData DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Methods

rnf :: DetectKeyPhrases -> () #

Eq DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Hashable DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

type AWSResponse DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

type Rep DetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

type Rep DetectKeyPhrases = D1 ('MetaData "DetectKeyPhrases" "Amazonka.Comprehend.DetectKeyPhrases" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "DetectKeyPhrases'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))

newDetectKeyPhrases Source #

Create a value of DetectKeyPhrases 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:

DetectKeyPhrases, detectKeyPhrases_text - A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.

DetectKeyPhrases, detectKeyPhrases_languageCode - 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.

Request Lenses

detectKeyPhrases_text :: Lens' DetectKeyPhrases Text Source #

A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.

detectKeyPhrases_languageCode :: Lens' DetectKeyPhrases LanguageCode Source #

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.

Destructuring the Response

data DetectKeyPhrasesResponse Source #

See: newDetectKeyPhrasesResponse smart constructor.

Constructors

DetectKeyPhrasesResponse' 

Fields

  • keyPhrases :: Maybe [KeyPhrase]

    A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Associated Types

type Rep DetectKeyPhrasesResponse :: Type -> Type #

Show DetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

NFData DetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

Eq DetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

type Rep DetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.DetectKeyPhrases

type Rep DetectKeyPhrasesResponse = D1 ('MetaData "DetectKeyPhrasesResponse" "Amazonka.Comprehend.DetectKeyPhrases" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "DetectKeyPhrasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyPhrases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyPhrase])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetectKeyPhrasesResponse Source #

Create a value of DetectKeyPhrasesResponse 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:

DetectKeyPhrasesResponse, detectKeyPhrasesResponse_keyPhrases - A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

$sel:httpStatus:DetectKeyPhrasesResponse', detectKeyPhrasesResponse_httpStatus - The response's http status code.

Response Lenses

detectKeyPhrasesResponse_keyPhrases :: Lens' DetectKeyPhrasesResponse (Maybe [KeyPhrase]) Source #

A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.