Amazonka.Comprehend.Types.DocumentClass

Documentation

data DocumentClass

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

FromJSON DocumentClass

Defined in Amazonka.Comprehend.Types.DocumentClass

Methods

parseJSON :: Value -> Parser DocumentClass

parseJSONList :: Value -> Parser [DocumentClass]

Generic DocumentClass

Defined in Amazonka.Comprehend.Types.DocumentClass

Associated Types

type Rep DocumentClass :: Type -> Type

Methods

from :: DocumentClass -> Rep DocumentClass x

to :: Rep DocumentClass x -> DocumentClass

Read DocumentClass

Defined in Amazonka.Comprehend.Types.DocumentClass

Methods

readsPrec :: Int -> ReadS DocumentClass

readList :: ReadS [DocumentClass]

readPrec :: ReadPrec DocumentClass

readListPrec :: ReadPrec [DocumentClass]

Show DocumentClass

Defined in Amazonka.Comprehend.Types.DocumentClass

Methods

showsPrec :: Int -> DocumentClass -> ShowS

show :: DocumentClass -> String

showList :: [DocumentClass] -> ShowS

NFData DocumentClass

Defined in Amazonka.Comprehend.Types.DocumentClass

Methods

rnf :: DocumentClass -> ()

Eq DocumentClass

Defined in Amazonka.Comprehend.Types.DocumentClass

Methods

(==) :: DocumentClass -> DocumentClass -> Bool

(/=) :: DocumentClass -> DocumentClass -> Bool

Hashable DocumentClass

Defined in Amazonka.Comprehend.Types.DocumentClass

Methods

hashWithSalt :: Int -> DocumentClass -> Int

hash :: DocumentClass -> Int

type Rep DocumentClass

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

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_name :: Lens' DocumentClass (Maybe Text)

The name of the class.

documentClass_page :: Lens' DocumentClass (Maybe Int)

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)

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