Categories:
suggestions dialog v3
Description of the suggestions dialog v3 that allows sending suggestions to the user
Introduction
ℹ️ This is an aura-bot core dialog, deployed jointly with the corresponding Aura Platform release.
The aim of the suggestions dialog v3 is precisely to send suggestions to the user related to the current conversation. This can help the user get the information he needs quickly using these suggestions.
This dialog is closely related to the main dialog. The main dialog will execute the suggestions dialog if the suggestions property is true in aura-configuration-api server or suggestions property is true in settings of triggerConditions of generic-dialog-v3 dialog.
Find here the source code of the dialog’s file suggestions-v3.ts.
Settings
The suggestions dialog v3 is part of the aura-bot core, so it does not have a specific section in the ChannelConfiguration model.
As previously indicated, each dialog can activate suggestions using the suggestions field in its own section.
An extract of the dialog-config.json file is included below:
Example for generic-dialog-v3 dialog:
{
"id": "generic-dialog-v3",
"channelDataVersion": "v3",
"triggerConditions": [
{
"intent": "intent.tv.init",
"settings": {
"locales": {
"success": [
"tv:tv.init.start"
],
"error": [
"tv:tv.error.fpaOrCognitive"
]
},
"sound": "positive",
"needPlayingContent": false,
"payloadType": "tv",
"suggestions": true
}
}
]
}
This snippet shows how to execute the suggestions dialog v3 after the generic-v3-dialog dialog is executed.
Example for none-v3 dialog:
{
"triggerConditions": [
{
"intent": "None"
}
],
"id": "none-v3",
"channelDataVersion": "v3",
"suggestions": true
}
This snippet shows how to execute the suggestions dialog v3 after the none-v3-dialog dialog is executed.
How it works
If the suggestions property is true for the running dialog, the main dialog will pass the conversational flow to suggestions dialog v3 in the suggestions step.
Currently, the dialog get suggestions data of aura-configuration-api, Obtaining suggestions randomly, the number of suggestions configured globally or per channel.
Configuration variables used globally
This section lists all the variables that the suggestions dialog v3 uses and can be configured to adapt the environment:
| Property | Type | Description |
|---|---|---|
| AURA_SUGGESTIONS_V3_NUMBER | string | Number of suggestions configured to be returned in channel data version 3. By default, 5. |
Configuration variables used per channel
responseOptions.suggestionsNumber has been added to the channel response optionally, so if it is not configured, the global configuration prevails.
Configuration template suggestions
the suggestions dialog v3 return suggestion data as an attachment with a new template defined with contentType: application/vnd.telefonica.aura.suggestion
Example response:
{
"type": "message",
"attachments": [
{
"contentType": "application/vnd.telefonica.aura.suggestion",
"content": {
"suggestions": [
{
"title": "suggestions:tv.search.byGenderViaChannel.suggestion.button",
"value": {
"intent": "intent.tv.content_get_info",
"entities": [
{
"canon": "Discovery",
"entity": "Discovery",
"label": "",
"score": 1,
"type": "ent.audiovisual_channel"
},
{
"canon": "documentales",
"entity": "Documentales",
"label": "DC",
"score": 1,
"type": "ent.audiovisual_genre"
}
]
}
},
{
"title": "suggestions:tv.searchSportByTeam.suggestion.button",
"value": {
"intent": "intent.tv.search",
"entities": [
{
"canon": "estudiantes",
"entity": "Estudiantes",
"label": "",
"score": 1,
"type": "ent.audiovisual_sports_team"
}
]
}
},
{
"title": "suggestions:tv.search.byGenderViaChannel.suggestion.button",
"value": {
"intent": "intent.tv.content_get_info",
"entities": [
{
"canon": "Telecinco",
"entity": "Telecinco",
"label": "",
"score": 1,
"type": "ent.audiovisual_channel"
},
{
"canon": "programas de televisión",
"entity": "Programas",
"label": "PR",
"score": 1,
"type": "ent.audiovisual_genre"
}
]
}
},
{
"title": "suggestions:tv.search.byGender.suggestion.button",
"value": {
"intent": "intent.tv.search",
"entities": [
{
"canon": "películas",
"entity": "película",
"label": "CN",
"score": 1,
"type": "ent.audiovisual_genre"
}
]
}
},
{
"title": "suggestions:tv.search.byActor.suggestion.button",
"value": {
"intent": "intent.tv.search",
"entities": [
{
"canon": "Mario Casas",
"entity": "Mario Casas",
"label": "",
"score": 1,
"type": "ent.audiovisual_actor"
},
{
"canon": "películas",
"entity": "películas",
"label": "CN",
"score": 1,
"type": "ent.audiovisual_genre"
}
]
}
}
]
}
}
]
}
I18n
| key | description |
|---|---|
suggestions:${titleResource.name} |
Used to get cardAction title name from suggestion when the suggestion resource is button type |