Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Comprehend.Types.DocumentLabel

Description

Synopsis

data DocumentLabel = DocumentLabel' {
- name :: Maybe Text
- page :: Maybe Int
- score :: Maybe Double
}
newDocumentLabel :: DocumentLabel
documentLabel_name :: Lens' DocumentLabel (Maybe Text)
documentLabel_page :: Lens' DocumentLabel (Maybe Int)
documentLabel_score :: Lens' DocumentLabel (Maybe Double)

Documentation

data DocumentLabel Source #

Specifies one of the label or labels that categorize the document being analyzed.

See: newDocumentLabel smart constructor.

Constructors

DocumentLabel'
Fields name :: Maybe Text The name of the label. page :: Maybe Int Page number where the label occurs. 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 label correctly attributed.

Instances

Instances details

FromJSON DocumentLabel Source #
Instance details Defined in Amazonka.Comprehend.Types.DocumentLabel Methods parseJSON :: Value -> Parser DocumentLabel # parseJSONList :: Value -> Parser [DocumentLabel] #
Generic DocumentLabel Source #
Instance details Defined in Amazonka.Comprehend.Types.DocumentLabel Associated Types type Rep DocumentLabel :: Type -> Type # Methods from :: DocumentLabel -> Rep DocumentLabel x # to :: Rep DocumentLabel x -> DocumentLabel #
Read DocumentLabel Source #
Instance details Defined in Amazonka.Comprehend.Types.DocumentLabel Methods readsPrec :: Int -> ReadS DocumentLabel # readList :: ReadS [DocumentLabel] # readPrec :: ReadPrec DocumentLabel # readListPrec :: ReadPrec [DocumentLabel] #
Show DocumentLabel Source #
Instance details Defined in Amazonka.Comprehend.Types.DocumentLabel Methods showsPrec :: Int -> DocumentLabel -> ShowS # show :: DocumentLabel -> String # showList :: [DocumentLabel] -> ShowS #
NFData DocumentLabel Source #
Instance details Defined in Amazonka.Comprehend.Types.DocumentLabel Methods rnf :: DocumentLabel -> () #
Eq DocumentLabel Source #
Instance details Defined in Amazonka.Comprehend.Types.DocumentLabel Methods (==) :: DocumentLabel -> DocumentLabel -> Bool # (/=) :: DocumentLabel -> DocumentLabel -> Bool #
Hashable DocumentLabel Source #
Instance details Defined in Amazonka.Comprehend.Types.DocumentLabel Methods hashWithSalt :: Int -> DocumentLabel -> Int # hash :: DocumentLabel -> Int #
type Rep DocumentLabel Source #
Instance details Defined in Amazonka.Comprehend.Types.DocumentLabel type Rep DocumentLabel = D1 ('MetaData "DocumentLabel" "Amazonka.Comprehend.Types.DocumentLabel" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "DocumentLabel'" '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)))))

newDocumentLabel :: DocumentLabel Source #

Create a value of DocumentLabel 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:DocumentLabel', documentLabel_name - The name of the label.

$sel:page:DocumentLabel', documentLabel_page - Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter.

$sel:score:DocumentLabel', documentLabel_score - The confidence score that Amazon Comprehend has this label correctly attributed.

documentLabel_name :: Lens' DocumentLabel (Maybe Text) Source #

The name of the label.

documentLabel_page :: Lens' DocumentLabel (Maybe Int) Source #

Page number where the label occurs. This field is present in the response only if your request includes the Byte parameter.

documentLabel_score :: Lens' DocumentLabel (Maybe Double) Source #

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