הפניה ל-API של בד הציור האינטראקטיבי

ה-Interactive Canvas API הוא ספריית JavaScript שמשמשת להתממשקות עם פעולת השיחה באמצעות האובייקט interactiveCanvas באפליקציית האינטרנט.

למידע נוסף על לוח הציור האינטראקטיבי, עיינו במסמכי התיעוד בנושא לוח הציור האינטראקטיבי.

שיטות

למקומות

ready(callbacks) returns undefined

מופעלת על ידי אפליקציית האינטרנט של לוח הציור האינטראקטיבי אחרי הטעינה שלה כדי להירשם לשיחות חוזרות.

פרמטרים
callbacks InteractiveCanvasCallbacks

אובייקט שמכיל קריאות חוזרות של method.

sendTextQuery

sendTextQuery(textQuery) returns Promise<state>

שליחת שאילתת טקסט לפעולת השיחה.

פרמטרים
textQuery string

השאילתה שצריך לשלוח לפעולה בשיחה.
state string

אחד מהבאים:

הפלטפורמה יכולה לאשר בקשות של READY:.

BLOCKED: יש שאילתה בטיסה והשאילתה החדשה תוסר.

UNKNOWN: לא ניתן לקבוע את מצב השאילתה הנוכחי.

getHeaderHeightPx

getHeaderHeightPx() returns Promise<height>

הגדרה זו קובעת את גובה הכותרת בחלק העליון של מסך.

פרמטרים
height number

הגובה בפיקסלים.

outputTts

outputTts(text, openMic) returns undefined;

הפעלת טקסט SSML.

פרמטרים
text string

המחרוזת הנתמכת על ידי SSML שיש להפעיל.
openMic boolean

האם להפעיל את המיקרופון לאחר השמעת ה-TTS.

createIntentHandler

createIntentHandler(intentId, callback) returns IntentHandler

יוצר handler של Intent עבור קהל בהתאמה אישית עם כוונת רכישה ב-NLU.

פרמטרים
intentId string

שם ה-Intent כפי שמוגדר ב-Actions Builder.
callback function(MatchedIntent)

הפונקציה להרצה כשיש התאמה ל-Intent.
IntentHandler object

אובייקט handler של Intent שניתן לרשום באמצעות expect().

IntentHandler

אובייקט שמייצג handler של Intent. אפשר לרשום באמצעות expect() או prompt().

MatchedIntent

אובייקט שמכיל את הנתונים של ה-Intent שהותאם.

שיטות
getIntentArg(parameterName) function(string)

שיטה לקבלת פרמטר Intent של Intent שהותאם.

createNumberSlot

createNumberSlot(callback, hints?) returns Slot<number>

יוצר משבצת מסוג מספר.

פרמטרים
callback function(FilledSlot)

הפונקציה שתבוצע כשהמשבצת תמלא.
hints Hints

מילים קצרות שהמשתמש יכול לומר במהלך מילוי משבצת הזמן. hints כדי לעזור למערכת של NLU להחליט איזה משבצת למלא.
Slot object

אובייקט משבצת שאפשר לרשום באמצעות prompt().

createTextSlot

createTextSlot(callback, hints?) returns Slot<string>

יוצר משבצת של מחרוזת סוג.

פרמטרים
callback function(FilledSlot)

הפונקציה שתבוצע כשהמשבצת תמלא.
hints Hints

מילים קצרות שהמשתמש יכול לומר במהלך מילוי משבצת הזמן. hints כדי לעזור למערכת של NLU להחליט איזה משבצת למלא.
Slot object

אובייקט משבצת שאפשר לרשום באמצעות prompt().

createConfirmationSlot

createConfirmationSlot(callback, hints?) returns Slot<boolean>

יוצר יחידת קיבולת (Slot) מסוג בוליאני.

פרמטרים
callback function(FilledSlot)

הפונקציה שתבוצע כשהמשבצת תמלא.
hints Hints

מילים קצרות שהמשתמש יכול לומר במהלך מילוי משבצת הזמן. hints כדי לעזור למערכת של NLU להחליט איזה משבצת למלא.
Slot object

אובייקט משבצת שאפשר לרשום באמצעות prompt().

createOptionsSlot

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

יוצרת יחידת קיבולת (Slot) מרשימה מוגדרת מראש של אפשרויות.

פרמטרים
options array<Option>

הפונקציה שתבוצע כשהמשבצת תמלא.
callback function(FilledSlot)

הפונקציה שתבוצע כשהמשבצת תמלא.
hints Hints

מילים קצרות שהמשתמש יכול לומר במהלך מילוי משבצת הזמן. hints כדי לעזור למערכת של NLU להחליט איזה משבצת למלא.
Slot object

אובייקט משבצת שאפשר לרשום באמצעות prompt().

משבצת

אובייקט שמייצג יחידת קיבולת (Slot) למילוי. אפשר לרשום באמצעות expect() או prompt().

FilledSlot<T>

אובייקט שמייצג יחידת קיבולת מלאה.

פרמטר
T boolean|number|string

הסוג של יחידת הקיבולת (Slot).

אפשרות

אובייקט שמייצג רשומה מסוג משבצת.

שדות
key string

המזהה הייחודי של רשומה מהסוג של יחידת הקיבולת (Slot).
synonyms array<string>

רשימת מילים ששימשו לבחירת אפשרות המשבצת.

רמזים

אובייקט שמייצג רמזים לחריץ.

שדות
associatedWords array<string>

רשימה של מילים שעוזרות למערכת של NLU להחליט איזה משבצת למלא.

expect

expect(expectation) returns HandlerRegistration

רושם את הציפיות אצל הלקוח. אפשר לקרוא להם ב-handlers וביחידות קיבולת (Slot) של Intent.

פרמטרים
expectation IntentHandler|Slot

ה-handler או ה-Slot של ה-Intent שצריך לרשום.
HandlerRegistration object

ה-handler או ה-Slot של ה-Intent הרשום.

HandlerRegistration

אובייקט שמייצג handler רשום של Intent.

שיטות
deleteHandler() function

מבטל את הרישום של ה-handler של ה-Intent הצפוי.

clearExpectations

clearExpectations() returns undefined;

מבטלים את כל הציפיות על ידי מחיקת כל המשבצות ורכיבי ה-handler של ה-Intent שנרשמו בעבר.

הצעה לפעולה

prompt(tts, expectation) returns Promise<Answer<T>>

מציג בפני המשתמש את מחרוזת ה-TTS שסופקה, ורושם את הציפייה בלקוח. אפשר לקרוא להם ב-handlers וביחידות קיבולת (Slot) של Intent.

פרמטרים
tts string

מחרוזת ה-TTS שמשמשת לבקשת המשתמש לגבי הציפייה שצוינה.
expectation IntentHandler|Slot

ה-handler או ה-Slot של ה-Intent שצריך לרשום.
Answer<T> object

התשובה שהמשתמש סיפק להנחיה.

תשובה<T>

אובייקט שמייצג תשובה שניתנה להנחיה על ידי משתמש.

שדות
value boolean|number|string

הערך של התשובה שסופקה על ידי המשתמש.
status string

סטטוס התשובה.

אחד מהבאים:

ANSWERED: המשתמש השיב לשאלה.

NO_MATCH: המשתמש התבקש למסור תשובה והשיב עם תשובה שלא תאמה לתשובה הצפויה או לכל כוונה צפויה אחרת.

YIELD: המשתמש השיב לבקשה עם כוונה אחרת.

triggerScene

triggerScene(sceneName) returns Promise<TriggerSceneStatus>

מפעיל סצנה.

פרמטרים
sceneName string

שם הסצנה להפעלה.
TriggerSceneStatus string

סטטוס הקריאה לטריגרScene().

אחד מהבאים:

SUCCESS: השרת עיבד את הבקשה בהצלחה.

BLOCKED: הבקשה נחסמה על ידי שאילתה קיימת בטיסה.

UNKNOWN: סטטוס הבקשה לא ידוע.

setUserParam

setUserParam(key, value) returns Promise<undefined>;

הגדרת צמד מפתח/ערך שהועבר ונשמר בין שיחות.

פרמטרים
key string

מפתח הפרמטר.
value object|array|boolean|number|string

ערך הפרמטר.

getUserParam

getUserParam(key) returns Promise<object|array|boolean|number|string>;

הפונקציה מקבלת את ערך הפרמטר של המפתח הנתון אם הוא קיים ואת סטטוס ההפעלה.

פרמטרים
key string

מפתח הפרמטר.

resetUserParam

resetUserParam() returns Promise<void>;

ניקוי כל הפרמטרים של המשתמשים.

setHomeParam

setHomeParam(key, value) returns Promise<undefined>;

הגדרת צמד מפתח/ערך שהועבר ונשמר בין שיחות.

פרמטרים
key string

מפתח הפרמטר.
value object|array|boolean|number|string

ערך הפרמטר.

getHomeParam

getHomeParam(key) returns Promise<object|array|boolean|number|string>;

הפונקציה מקבלת את ערך הפרמטר של המפתח הנתון אם הוא קיים ואת סטטוס ההפעלה.

פרמטרים
key string

מפתח הפרמטר.

resetHomeParam

resetHomeParam() returns Promise<void>;

ניקוי כל הפרמטרים של המשתמשים.

setCanvasState

setCanvasState(state) returns undefined

תישלח הודעה ל-Assistant על כך שאפליקציית האינטרנט של לוח הציור עדכנה את המצב. השיטה setCanvasState לא מחזירה ערך. אפשר לגשת למטען הייעודי (payload) של המדינה דרך הנכס conv.context.canvas.state.

פרמטרים
state Object

המצב המעודכן של אפליקציית לוח הציור כאובייקט JSON.

InteractiveCanvasCallbacks

הקריאה החוזרת (callback) מאפשרת להגיב למידע או לבקשות מפעולת השיחה, בעוד שהשיטות מאפשרות לשלוח מידע או בקשות לפעולות השיחה.

onUpdate

onUpdate(data) returns Promise|undefined

ההתראה הזו מוצגת כשנשלחת תגובה מסוג Canvas מפעולת השיחה. ה-TTS יתחיל כשה-Promise שהוחזר יסתיים, או הזמן הקצוב לתפוגה אחרי 10 שניות.

פרמטרים
data Object

הנתונים עודכנו על ידי ה-webhook.

onTtsMark

onTtsMark(markName) returns undefined

קריאה חוזרת שמופעלת במהלך הפעלת טקסט לדיבור.

סימנים מיוחדים שמופעלים תמיד:

  • START מציין את תחילת ה-TTS.
  • END מציין את סוף ה-TTS.
  • ERROR מציין שגיאה בהפעלת ה-TTS.

אפשר גם להגדיר סימנים מותאמים אישית באמצעות SSML והתג <mark>, למשל <mark name="custom"/>.

פרמטרים
markName string

סימון השם שהופעל במהלך הפעלת TTS.

onInputStatusChanged

onInputStatusChanged(inputStatus) returns undefined

אפליקציית לוח הציור שולחת הודעה על כך שסטטוס הקלט של Assistant השתנה.

פרמטרים
inputStatus Enum

הסטטוס של עיבוד קלט הקול או הטקסט במכשיר. יכול להיות:

  • LISTENING : המיקרופון פתוח.
  • IDLE : המיקרופון סגור.
  • PROCESSING : Assistant מבצעת כרגע שאילתה (המיקרופון סגור).