amazonka-lex-models-1.5.0: Amazon Lex Model Building Service SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.LexModels.GetUtterancesView

Contents

Description

Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.

For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance.

After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.

Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.

If the bot's childDirected field is set to true , utterances for the bot are not stored and cannot be retrieved with the GetUtterancesView operation. For more information, see PutBot .

This operation requires permissions for the lex:GetUtterancesView action.

Synopsis

Creating a Request

getUtterancesView Source #

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

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

  • guvBotName - The name of the bot for which utterance information should be returned.
  • guvBotVersions - An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.
  • guvStatusType - To return utterances that were recognized and handled, useDetected . To return utterances that were not recognized, use Missed .

data GetUtterancesView Source #

See: getUtterancesView smart constructor.

Instances

Eq GetUtterancesView Source # 
Data GetUtterancesView Source # 

Methods

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

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

toConstr :: GetUtterancesView -> Constr #

dataTypeOf :: GetUtterancesView -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> GetUtterancesView -> GetUtterancesView #

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

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

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

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

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

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

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

Read GetUtterancesView Source # 
Show GetUtterancesView Source # 
Generic GetUtterancesView Source # 
Hashable GetUtterancesView Source # 
NFData GetUtterancesView Source # 

Methods

rnf :: GetUtterancesView -> () #

AWSRequest GetUtterancesView Source # 
ToQuery GetUtterancesView Source # 
ToPath GetUtterancesView Source # 
ToHeaders GetUtterancesView Source # 
type Rep GetUtterancesView Source # 
type Rep GetUtterancesView = D1 (MetaData "GetUtterancesView" "Network.AWS.LexModels.GetUtterancesView" "amazonka-lex-models-1.5.0-9L7od5njsTvH7y9BfUkUqe" False) (C1 (MetaCons "GetUtterancesView'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_guvBotName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_guvBotVersions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 Text))) (S1 (MetaSel (Just Symbol "_guvStatusType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StatusType)))))
type Rs GetUtterancesView Source # 

Request Lenses

guvBotName :: Lens' GetUtterancesView Text Source #

The name of the bot for which utterance information should be returned.

guvBotVersions :: Lens' GetUtterancesView (NonEmpty Text) Source #

An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.

guvStatusType :: Lens' GetUtterancesView StatusType Source #

To return utterances that were recognized and handled, useDetected . To return utterances that were not recognized, use Missed .

Destructuring the Response

getUtterancesViewResponse Source #

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

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

  • guvrsBotName - The name of the bot for which utterance information was returned.
  • guvrsUtterances - An array of UtteranceList objects, each containing a list of UtteranceData objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version.
  • guvrsResponseStatus - -- | The response status code.

data GetUtterancesViewResponse Source #

See: getUtterancesViewResponse smart constructor.

Instances

Eq GetUtterancesViewResponse Source # 
Data GetUtterancesViewResponse Source # 

Methods

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

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

toConstr :: GetUtterancesViewResponse -> Constr #

dataTypeOf :: GetUtterancesViewResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> GetUtterancesViewResponse -> GetUtterancesViewResponse #

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

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

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

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

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

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

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

Read GetUtterancesViewResponse Source # 
Show GetUtterancesViewResponse Source # 
Generic GetUtterancesViewResponse Source # 
NFData GetUtterancesViewResponse Source # 
type Rep GetUtterancesViewResponse Source # 
type Rep GetUtterancesViewResponse = D1 (MetaData "GetUtterancesViewResponse" "Network.AWS.LexModels.GetUtterancesView" "amazonka-lex-models-1.5.0-9L7od5njsTvH7y9BfUkUqe" False) (C1 (MetaCons "GetUtterancesViewResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_guvrsBotName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_guvrsUtterances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UtteranceList]))) (S1 (MetaSel (Just Symbol "_guvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

guvrsBotName :: Lens' GetUtterancesViewResponse (Maybe Text) Source #

The name of the bot for which utterance information was returned.

guvrsUtterances :: Lens' GetUtterancesViewResponse [UtteranceList] Source #

An array of UtteranceList objects, each containing a list of UtteranceData objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version.