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.Types.DocumentClass

Description

 
Synopsis

Documentation

data DocumentClass Source #

Specifies the class that categorizes the document being analyzed

See: newDocumentClass smart constructor.

Constructors

DocumentClass' 

Fields

  • name :: Maybe Text

    The name of the class.

  • page :: Maybe Int

    Page number in the input document. This field is present in the response only if your request includes the Byte parameter.

  • score :: Maybe Double

    The confidence score that Amazon Comprehend has this class correctly attributed.

Instances

Instances details
FromJSON DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

Generic DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

Associated Types

type Rep DocumentClass :: Type -> Type #

Read DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

Show DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

NFData DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

Methods

rnf :: DocumentClass -> () #

Eq DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

Hashable DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

type Rep DocumentClass Source # 
Instance details

Defined in Amazonka.Comprehend.Types.DocumentClass

type Rep DocumentClass = D1 ('MetaData "DocumentClass" "Amazonka.Comprehend.Types.DocumentClass" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "DocumentClass'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "page") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newDocumentClass :: DocumentClass Source #

Create a value of DocumentClass 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:name:DocumentClass', documentClass_name - The name of the class.

$sel:page:DocumentClass', documentClass_page - Page number in the input document. This field is present in the response only if your request includes the Byte parameter.

$sel:score:DocumentClass', documentClass_score - The confidence score that Amazon Comprehend has this class correctly attributed.

documentClass_page :: Lens' DocumentClass (Maybe Int) Source #

Page number in the input document. This field is present in the response only if your request includes the Byte parameter.

documentClass_score :: Lens' DocumentClass (Maybe Double) Source #

The confidence score that Amazon Comprehend has this class correctly attributed.