Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
This operation requires permissions for the lex:GetUtterancesView
action.
Synopsis
- getUtterancesView :: Text -> NonEmpty Text -> StatusType -> GetUtterancesView
- data GetUtterancesView
- guvBotName :: Lens' GetUtterancesView Text
- guvBotVersions :: Lens' GetUtterancesView (NonEmpty Text)
- guvStatusType :: Lens' GetUtterancesView StatusType
- getUtterancesViewResponse :: Int -> GetUtterancesViewResponse
- data GetUtterancesViewResponse
- guvrsBotName :: Lens' GetUtterancesViewResponse (Maybe Text)
- guvrsUtterances :: Lens' GetUtterancesViewResponse [UtteranceList]
- guvrsResponseStatus :: Lens' GetUtterancesViewResponse Int
Creating a Request
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, useMissed
.
data GetUtterancesView Source #
See: getUtterancesView
smart constructor.
Instances
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 ofUtteranceList
objects, each containing a list ofUtteranceData
objects describing the utterances that were processed by your bot. The response contains a maximum of 100UtteranceData
objects for each version.guvrsResponseStatus
- -- | The response status code.
data GetUtterancesViewResponse Source #
See: getUtterancesViewResponse
smart constructor.
Instances
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.
guvrsResponseStatus :: Lens' GetUtterancesViewResponse Int Source #
- - | The response status code.