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

Description

Detects the key noun phrases found in a batch of documents.

Synopsis

Creating a Request

data BatchDetectKeyPhrases Source #

See: newBatchDetectKeyPhrases smart constructor.

Constructors

BatchDetectKeyPhrases' 

Fields

  • textList :: Sensitive [Sensitive Text]

    A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes 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
Eq BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Show BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Generic BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Associated Types

type Rep BatchDetectKeyPhrases :: Type -> Type #

NFData BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Methods

rnf :: BatchDetectKeyPhrases -> () #

Hashable BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

ToJSON BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

AWSRequest BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Associated Types

type AWSResponse BatchDetectKeyPhrases #

ToHeaders BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

ToPath BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

ToQuery BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

type Rep BatchDetectKeyPhrases Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

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

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

newBatchDetectKeyPhrases Source #

Create a value of BatchDetectKeyPhrases 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:textList:BatchDetectKeyPhrases', batchDetectKeyPhrases_textList - A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

$sel:languageCode:BatchDetectKeyPhrases', batchDetectKeyPhrases_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

batchDetectKeyPhrases_textList :: Lens' BatchDetectKeyPhrases [Text] Source #

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

batchDetectKeyPhrases_languageCode :: Lens' BatchDetectKeyPhrases 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 BatchDetectKeyPhrasesResponse Source #

See: newBatchDetectKeyPhrasesResponse smart constructor.

Constructors

BatchDetectKeyPhrasesResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • resultList :: [BatchDetectKeyPhrasesItemResult]

    A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

  • errorList :: [BatchItemError]

    A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

Instances

Instances details
Eq BatchDetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Show BatchDetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Generic BatchDetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

Associated Types

type Rep BatchDetectKeyPhrasesResponse :: Type -> Type #

NFData BatchDetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

type Rep BatchDetectKeyPhrasesResponse Source # 
Instance details

Defined in Amazonka.Comprehend.BatchDetectKeyPhrases

type Rep BatchDetectKeyPhrasesResponse = D1 ('MetaData "BatchDetectKeyPhrasesResponse" "Amazonka.Comprehend.BatchDetectKeyPhrases" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "BatchDetectKeyPhrasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "resultList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchDetectKeyPhrasesItemResult]) :*: S1 ('MetaSel ('Just "errorList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchItemError]))))

newBatchDetectKeyPhrasesResponse Source #

Create a value of BatchDetectKeyPhrasesResponse 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:httpStatus:BatchDetectKeyPhrasesResponse', batchDetectKeyPhrasesResponse_httpStatus - The response's http status code.

$sel:resultList:BatchDetectKeyPhrasesResponse', batchDetectKeyPhrasesResponse_resultList - A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

$sel:errorList:BatchDetectKeyPhrasesResponse', batchDetectKeyPhrasesResponse_errorList - A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

Response Lenses

batchDetectKeyPhrasesResponse_resultList :: Lens' BatchDetectKeyPhrasesResponse [BatchDetectKeyPhrasesItemResult] Source #

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

batchDetectKeyPhrasesResponse_errorList :: Lens' BatchDetectKeyPhrasesResponse [BatchItemError] Source #

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.