L'API Interactive Canvas est une bibliothèque JavaScript qui vous permet d'interagir avec votre action conversationnelle à l'aide de l'objet interactiveCanvas
de votre application Web.
Pour en savoir plus sur Interactive Canvas, consultez la documentation d'Interactive Canvas.
Méthodes
prêt
ready(callbacks) returns undefined
Appelée par l'application Web Interactive Canvas une fois qu'elle est chargée pour enregistrer les rappels.
Paramètres | |
---|---|
callbacks |
InteractiveCanvasCallbacks
Objet contenant des rappels de méthode. |
sendTextQuery
sendTextQuery(textQuery) returns Promise<state>
Envoie une requête textuelle à l'action de conversation.
Paramètres | |
---|---|
textQuery |
string
Requête à envoyer à l'action de conversation. |
state |
string
Choisissez l'une des options suivantes :
|
getHeaderHeightPx
getHeaderHeightPx() returns Promise<height>
Détermine la hauteur de l'en-tête en haut d'un écran.
Paramètres | |
---|---|
height |
number
Hauteur en pixels. |
outputTts
outputTts(text, openMic) returns undefined;
Lit du texte SSML.
Paramètres | |
---|---|
text |
string
Chaîne à lire compatible avec le SSML. |
openMic |
boolean
Permet de spécifier si le micro doit être activé ou non après la lecture de la synthèse vocale. |
createIntentHandler
createIntentHandler(intentId, callback) returns IntentHandler
Crée un gestionnaire d'intent pour un intent personnalisé NLU.
Paramètres | |
---|---|
intentId |
string
Nom de l'intent tel que défini dans Actions Builder. |
callback |
function(MatchedIntent)
Fonction à exécuter lorsque l'intent est mis en correspondance. |
IntentHandler |
object
Objet de gestionnaire d'intents pouvant être enregistré à l'aide de |
IntentHandler
Objet représentant un gestionnaire d'intents. Enregistrement possible à l'aide de expect()
ou de prompt()
.
MatchedIntent
Objet contenant les données d'un intent correspondant.
Méthodes | |
---|---|
getIntentArg(parameterName) |
function(string)
Méthode permettant d'obtenir le paramètre d'intent d'un intent correspondant. |
createNumberSlot
createNumberSlot(callback, hints?) returns Slot<number>
Crée un emplacement de type number.
Paramètres | |
---|---|
callback |
function(FilledSlot)
Fonction à exécuter lorsque l'espace est rempli. |
hints |
Hints
Mots courts que l'utilisateur pourrait dire lorsqu'il remplit un emplacement. |
Slot |
object
Objet Slot qui peut être enregistré à l'aide de |
createTextSlot
createTextSlot(callback, hints?) returns Slot<string>
Crée un emplacement de type chaîne.
Paramètres | |
---|---|
callback |
function(FilledSlot)
Fonction à exécuter lorsque l'espace est rempli. |
hints |
Hints
Mots courts que l'utilisateur pourrait dire lorsqu'il remplit un emplacement. |
Slot |
object
Objet Slot qui peut être enregistré à l'aide de |
createConfirmationSlot
createConfirmationSlot(callback, hints?) returns Slot<boolean>
Crée un emplacement de type booléen.
Paramètres | |
---|---|
callback |
function(FilledSlot)
Fonction à exécuter lorsque l'espace est rempli. |
hints |
Hints
Mots courts que l'utilisateur pourrait dire lorsqu'il remplit un emplacement. |
Slot |
object
Objet Slot qui peut être enregistré à l'aide de |
createOptionsSlot
createOptionsSlot(options, callback, hints?) returns Slot<string>
Crée un emplacement à partir d'une liste prédéfinie d'options.
Paramètres | |
---|---|
options |
array<Option>
Fonction à exécuter lorsque l'espace est rempli. |
callback |
function(FilledSlot)
Fonction à exécuter lorsque l'espace est rempli. |
hints |
Hints
Mots courts que l'utilisateur pourrait dire lorsqu'il remplit un emplacement. |
Slot |
object
Objet Slot qui peut être enregistré à l'aide de |
Encoche
Objet représentant un emplacement à remplir. Enregistrement possible à l'aide de expect()
ou de prompt()
.
FilledSlot<T>
Objet représentant un espace publicitaire rempli.
Paramètres | |
---|---|
T |
boolean|number|string
Type d'emplacement. |
Option
Objet représentant une entrée de type d'emplacement.
Champs | |
---|---|
key |
string
Identifiant unique de l'entrée du type d'emplacement. |
synonyms |
array<string>
Liste de mots utilisée pour sélectionner l'option d'emplacement. |
Astuces
Objet représentant des suggestions pour un emplacement.
Champs | |
---|---|
associatedWords |
array<string>
Liste de mots utilisée pour aider le système NLU à décider quel emplacement remplir. |
expect
expect(expectation) returns HandlerRegistration
Enregistre l'attente sur le client. Peut être appelé sur les gestionnaires d'intents et les emplacements.
Paramètres | |
---|---|
expectation |
IntentHandler|Slot
Gestionnaire d'intent ou emplacement à enregistrer. |
HandlerRegistration |
object
Gestionnaire d'intents ou emplacement enregistrés. |
HandlerRegistration
Objet représentant un gestionnaire d'intents enregistré.
Méthodes | |
---|---|
deleteHandler() |
function
Annule l'enregistrement du gestionnaire d'intent attendu. |
clearExpectations
clearExpectations() returns undefined;
Supprime toutes les attentes en supprimant tous les gestionnaires d'intents et emplacements précédemment enregistrés.
invite
prompt(tts, expectation) returns Promise<Answer<T>>
Invite l'utilisateur avec la chaîne de synthèse vocale fournie et enregistre l'attente sur le client. Peut être appelé sur les gestionnaires d'intents et les emplacements.
Paramètres | |
---|---|
tts |
string
Chaîne de synthèse vocale utilisée pour demander à l'utilisateur l'attente fournie. |
expectation |
IntentHandler|Slot
Gestionnaire d'intent ou emplacement à enregistrer. |
Answer<T> |
object
Réponse fournie par l'utilisateur à l'invite. |
Réponse<T>
Objet représentant une réponse fournie par l'utilisateur à une invite.
Champs | |
---|---|
value |
boolean|number|string
Valeur de la réponse fournie par l'utilisateur. |
status |
string
État de la réponse. Choisissez l'une des options suivantes :
|
triggerScene
triggerScene(sceneName) returns Promise<TriggerSceneStatus>
Déclenche une scène.
Paramètres | |
---|---|
sceneName |
string
Nom de la scène à déclencher. |
TriggerSceneStatus |
string
État de l'appel à triggerScene(). Choisissez l'une des options suivantes :
|
setUserParam
setUserParam(key, value) returns Promise<undefined>;
Définit la paire clé-valeur transmise et conservée entre les conversations.
Paramètres | |
---|---|
key |
string
Clé du paramètre. |
value |
object|array|boolean|number|string
Valeur du paramètre. |
getUserParam
getUserParam(key) returns Promise<object|array|boolean|number|string>;
Récupère la valeur de paramètre de la clé donnée si elle existe et l'état de l'appel.
Paramètres | |
---|---|
key |
string
Clé du paramètre. |
resetUserParam
resetUserParam() returns Promise<void>;
Efface tous les paramètres utilisateur.
setHomeParam
setHomeParam(key, value) returns Promise<undefined>;
Définit la paire clé-valeur transmise et conservée entre les conversations.
Paramètres | |
---|---|
key |
string
Clé du paramètre. |
value |
object|array|boolean|number|string
Valeur du paramètre. |
getHomeParam
getHomeParam(key) returns Promise<object|array|boolean|number|string>;
Récupère la valeur de paramètre de la clé donnée si elle existe et l'état de l'appel.
Paramètres | |
---|---|
key |
string
Clé du paramètre. |
resetHomeParam
resetHomeParam() returns Promise<void>;
Efface tous les paramètres utilisateur.
setCanvasState
setCanvasState(state) returns undefined
Notifie l'Assistant que l'état de l'application Web Canvas a été modifié. La méthode setCanvasState
ne renvoie aucune valeur. La charge utile de l'état est accessible via la propriété conv.context.canvas.state
.
Paramètres | |
---|---|
state |
Object
État mis à jour de l'application Canvas en tant qu'objet JSON. |
InteractiveCanvasCallbacks
Ces rappels vous permettent de répondre aux informations ou aux requêtes de votre action de conversation, tandis que les méthodes vous permettent d'envoyer des informations ou des requêtes à votre action de conversation.
onUpdate
onUpdate(data) returns Promise|undefined
Appelée lorsqu'une réponse Canvas
est envoyée à partir de l'action conversationnelle. La synthèse vocale démarre une fois la promesse renvoyée résolue ou expire au bout de 10 secondes.
Paramètres | |
---|---|
data |
Object
Données envoyées par le webhook. |
onTtsMark
onTtsMark(markName) returns undefined
Rappel invoqué lors de la lecture par synthèse vocale.
Signes spéciaux qui sont toujours déclenchés:
START
indique le début de la synthèse vocale.END
indique la fin de la synthèse vocale.ERROR
indique une erreur de lecture de la synthèse vocale.
Vous pouvez également définir des marques personnalisées à l'aide de SSML et de la balise <mark>
, comme <mark name="custom"/>
.
Paramètres | |
---|---|
markName |
string
Marquez le nom invoqué pendant la lecture par synthèse vocale. |
onInputStatusChanged
onInputStatusChanged(inputStatus) returns undefined
Notifie l'application Canvas que l'état de saisie par l'Assistant a changé.
Paramètres | |
---|---|
inputStatus |
Enum
État du traitement de la saisie vocale et/ou de texte sur l'appareil. Il peut s'agir des types de fichiers suivants:
|