Documentation de référence de l'API Interactive Canvas

L'API Interactive Canvas est une bibliothèque JavaScript qui permet d'interfacer avec votre action conversationnelle à l'aide de l'objet interactiveCanvas dans votre application Web.

Pour en savoir plus sur Interactive Canvas, consultez la page Interactive Canvas documentation.

Méthodes

prêt

ready(callbacks) returns undefined

Appelé par l'application Web Interactive Canvas une fois qu'elle a été chargée pour enregistrer des 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 :

READY: Les demandes peuvent être acceptées par la plate-forme.

BLOCKED: Une requête est en cours de transfert, et la nouvelle requête sera supprimée.

UNKNOWN: Impossible de déterminer l'état actuel de la requête.

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 SSML à lire acceptée.
openMic boolean

Permet d'activer ou non le micro après 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 expect().

IntentHandler

Objet représentant un gestionnaire d'intents. Vous pouvez l'enregistrer à l'aide de expect() ou prompt().

MatchedIntent

Objet contenant les données d'un intent mis en correspondance.

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'emplacement est rempli.
hints Hints

Mots courts que l'utilisateur pourrait dire lorsqu'il remplit un emplacement. hints aider le système NLU à décider quel emplacement remplir.
Slot object

Objet d'emplacement qui peut être enregistré à l'aide de prompt().

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'emplacement est rempli.
hints Hints

Mots courts que l'utilisateur pourrait dire lorsqu'il remplit un emplacement. hints aider le système NLU à décider quel emplacement remplir.
Slot object

Objet d'emplacement qui peut être enregistré à l'aide de prompt().

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'emplacement est rempli.
hints Hints

Mots courts que l'utilisateur pourrait dire lorsqu'il remplit un emplacement. hints aider le système NLU à décider quel emplacement remplir.
Slot object

Objet d'emplacement qui peut être enregistré à l'aide de prompt().

createOptionsSlot

createOptionsSlot(options, callback, hints?) returns Slot<string>

Crée un emplacement à partir d'une liste d'options prédéfinie.

Paramètres
options array<Option>

Fonction à exécuter lorsque l'emplacement est rempli.
callback function(FilledSlot)

Fonction à exécuter lorsque l'emplacement est rempli.
hints Hints

Mots courts que l'utilisateur pourrait dire lorsqu'il remplit un emplacement. hints aider le système NLU à décider quel emplacement remplir.
Slot object

Objet d'emplacement qui peut être enregistré à l'aide de prompt().

Encoche

Objet représentant un espace publicitaire à remplir. Vous pouvez l'enregistrer à l'aide de expect() ou prompt().

FilledSlot&lt;T&gt;

Objet représentant un espace publicitaire plein.

Paramètre
T boolean|number|string

Type d'emplacement.

Option

Objet représentant une entrée de type d'espace publicitaire.

Champs
key string

Identifiant unique de l'entrée du type d'emplacement.
synonyms array<string>

Liste de mots utilisés pour sélectionner l'option d'emplacement.

Astuces

Objet représentant des indications pour un emplacement.

Champs
associatedWords array<string>

Liste de mots permettant au système NLU de décider quel emplacement remplir.

CANNOT TRANSLATE

expect(expectation) returns HandlerRegistration

Enregistre l'attente sur le client. Peut être appelé sur des gestionnaires d'intent et des emplacements.

Paramètres
expectation IntentHandler|Slot

Gestionnaire d'intent ou emplacement à enregistrer.
HandlerRegistration object

Emplacement ou gestionnaire d'intent enregistré.

HandlerRegistration

Objet représentant un gestionnaire d'intent enregistré.

Méthodes
deleteHandler() function

Annule l'enregistrement du gestionnaire d'intent attendu.

clearExpectations

clearExpectations() returns undefined;

Supprime toutes les attentes en supprimant l'ensemble des gestionnaires d'intent et des emplacements enregistrés précédemment.

Requête

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 des gestionnaires d'intent et des emplacements.

Paramètres
tts string

Chaîne de synthèse vocale utilisée pour inviter l'utilisateur à répondre à l'attente fournie.
expectation IntentHandler|Slot

Gestionnaire d'intent ou emplacement à enregistrer.
Answer<T> object

Réponse fournie par l'utilisateur à l'invite.

Répondre<T>

Objet représentant une réponse fournie par l'utilisateur à une requête.

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 :

ANSWERED: L'utilisateur a répondu par une réponse à l'invite.

NO_MATCH: L'utilisateur a été invité à donner une réponse et a renvoyé une réponse qui ne correspondait ni à la réponse attendue, ni à aucun autre intent attendu.

YIELD: L'utilisateur a répondu à l'invite avec un intent différent.

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 de triggerScene().

Choisissez l'une des options suivantes :

SUCCESS: La requête a bien été traitée par le serveur.

BLOCKED: La requête a été bloquée par une requête existante en cours de transfert.

UNKNOWN: L'état de la demande est inconnu.

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, ainsi que 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, ainsi que 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

Informe l'Assistant que l'application Web Dessin a mis à jour son état. La setCanvasState ne renvoie pas de valeur. La charge utile de l'état est accessible via 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 à des informations ou à des demandes de votre action conversationnelle, tandis que les méthodes permettent d'envoyer d'informations ou de demandes à votre Action conversationnelle.

onUpdate

onUpdate(data) returns Promise|undefined

Appelé lorsqu'une réponse Canvas est envoyée par l'action conversationnelle. La synthèse vocale commencera lorsque la promesse renvoyée est résolue, ou expire au bout de 10 secondes.

Paramètres
data Object

Données mises à jour envoyées par le webhook.

onTtsMark

onTtsMark(markName) returns undefined

Rappel invoqué lors de la lecture de la synthèse vocale.

Marques spéciales qui sont toujours déclenchées:

  • 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 du tag <mark>, comme <mark name="custom"/>

Paramètres
markName string

Marquer le nom comme appelé lors de la lecture TTS

onInputStatusChanged

onInputStatusChanged(inputStatus) returns undefined

Informe l'application Canvas que l'état de la saisie par l'Assistant a changé.

Paramètres
inputStatus Enum

État du traitement de la saisie vocale et/ou de texte sur l'appareil. Boîte comme suit:

  • LISTENING : le micro est ouvert.
  • IDLE : le micro est fermé.
  • PROCESSING : l'Assistant exécute actuellement une (le micro est fermé).