Network.AWS.Comprehend.DetectEntities

Inspects text for entities, and returns information about them. For more information, about entities, see 'how-entities' .

Creating a Request

detectEntities

Arguments

:: Text

deText

-> LanguageCode

deLanguageCode

-> DetectEntities

Creates a value of DetectEntities with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• deText - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
• deLanguageCode - The RFC 5646 language code of the input text. If the request does not specify the language code, the service detects the dominant language. If you specify a language code that the service does not support, it returns UnsupportedLanguageException exception. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

data DetectEntities

See: detectEntities smart constructor.

Instances

Eq DetectEntities

Methods

(==) :: DetectEntities -> DetectEntities -> Bool

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

Data DetectEntities

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DetectEntities -> c DetectEntities

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DetectEntities

toConstr :: DetectEntities -> Constr

dataTypeOf :: DetectEntities -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DetectEntities)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DetectEntities)

gmapT :: (forall b. Data b => b -> b) -> DetectEntities -> DetectEntities

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DetectEntities -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DetectEntities -> r

gmapQ :: (forall d. Data d => d -> u) -> DetectEntities -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DetectEntities -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DetectEntities -> m DetectEntities

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectEntities -> m DetectEntities

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectEntities -> m DetectEntities

Read DetectEntities

Methods

readsPrec :: Int -> ReadS DetectEntities

readList :: ReadS [DetectEntities]

readPrec :: ReadPrec DetectEntities

readListPrec :: ReadPrec [DetectEntities]

Show DetectEntities

Methods

showsPrec :: Int -> DetectEntities -> ShowS

show :: DetectEntities -> String

showList :: [DetectEntities] -> ShowS

Generic DetectEntities

Associated Types

type Rep DetectEntities :: * -> *

Methods

from :: DetectEntities -> Rep DetectEntities x

to :: Rep DetectEntities x -> DetectEntities

Hashable DetectEntities

Methods

hashWithSalt :: Int -> DetectEntities -> Int

hash :: DetectEntities -> Int

ToJSON DetectEntities

Methods

toJSON :: DetectEntities -> Value

toEncoding :: DetectEntities -> Encoding

toJSONList :: [DetectEntities] -> Value

toEncodingList :: [DetectEntities] -> Encoding

NFData DetectEntities

Methods

rnf :: DetectEntities -> ()

AWSRequest DetectEntities

Associated Types

type Rs DetectEntities :: *

Methods

request :: DetectEntities -> Request DetectEntities

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DetectEntities -> ClientResponse -> m (Response DetectEntities)

ToHeaders DetectEntities

Methods

toHeaders :: DetectEntities -> [Header]

ToPath DetectEntities

Methods

toPath :: DetectEntities -> ByteString

ToQuery DetectEntities

Methods

toQuery :: DetectEntities -> QueryString

type Rep DetectEntities

type Rep DetectEntities = D1 * (MetaData "DetectEntities" "Network.AWS.Comprehend.DetectEntities" "amazonka-comprehend-1.6.0-7ky9kDszQAoCEHl21SoVpv" False) (C1 * (MetaCons "DetectEntities'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_deText") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_deLanguageCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * LanguageCode))))

type Rs DetectEntities

type Rs DetectEntities = DetectEntitiesResponse

Request Lenses

deText :: Lens' DetectEntities Text

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

deLanguageCode :: Lens' DetectEntities LanguageCode

The RFC 5646 language code of the input text. If the request does not specify the language code, the service detects the dominant language. If you specify a language code that the service does not support, it returns UnsupportedLanguageException exception. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

Destructuring the Response

detectEntitiesResponse

Arguments

:: Int

dersResponseStatus

-> DetectEntitiesResponse

Creates a value of DetectEntitiesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dersEntities - A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. For a list of entity types, see 'how-entities' .
• dersResponseStatus - -- | The response status code.

data DetectEntitiesResponse

See: detectEntitiesResponse smart constructor.

Instances

Eq DetectEntitiesResponse

Methods

(==) :: DetectEntitiesResponse -> DetectEntitiesResponse -> Bool

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

Data DetectEntitiesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DetectEntitiesResponse -> c DetectEntitiesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DetectEntitiesResponse

toConstr :: DetectEntitiesResponse -> Constr

dataTypeOf :: DetectEntitiesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DetectEntitiesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DetectEntitiesResponse)

gmapT :: (forall b. Data b => b -> b) -> DetectEntitiesResponse -> DetectEntitiesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DetectEntitiesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DetectEntitiesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DetectEntitiesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DetectEntitiesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DetectEntitiesResponse -> m DetectEntitiesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectEntitiesResponse -> m DetectEntitiesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DetectEntitiesResponse -> m DetectEntitiesResponse

Read DetectEntitiesResponse

Methods

readsPrec :: Int -> ReadS DetectEntitiesResponse

readList :: ReadS [DetectEntitiesResponse]

readPrec :: ReadPrec DetectEntitiesResponse

readListPrec :: ReadPrec [DetectEntitiesResponse]

Show DetectEntitiesResponse

Methods

showsPrec :: Int -> DetectEntitiesResponse -> ShowS

show :: DetectEntitiesResponse -> String

showList :: [DetectEntitiesResponse] -> ShowS

Generic DetectEntitiesResponse

Associated Types

type Rep DetectEntitiesResponse :: * -> *

Methods

from :: DetectEntitiesResponse -> Rep DetectEntitiesResponse x

to :: Rep DetectEntitiesResponse x -> DetectEntitiesResponse

NFData DetectEntitiesResponse

Methods

rnf :: DetectEntitiesResponse -> ()

type Rep DetectEntitiesResponse

type Rep DetectEntitiesResponse = D1 * (MetaData "DetectEntitiesResponse" "Network.AWS.Comprehend.DetectEntities" "amazonka-comprehend-1.6.0-7ky9kDszQAoCEHl21SoVpv" False) (C1 * (MetaCons "DetectEntitiesResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dersEntities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Entity]))) (S1 * (MetaSel (Just Symbol "_dersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

dersEntities :: Lens' DetectEntitiesResponse [Entity]

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. For a list of entity types, see 'how-entities' .

dersResponseStatus :: Lens' DetectEntitiesResponse Int

• - | The response status code.