مرجع تعاملی Canvas API

Interactive Canvas API یک کتابخانه جاوا اسکریپت است که برای ارتباط با کنش مکالمه خود با استفاده از شی interactiveCanvas در برنامه وب خود استفاده می کنید.

برای اطلاعات بیشتر در مورد بوم تعاملی، به مستندات بوم تعاملی مراجعه کنید.

روش ها

آماده 

ready(callbacks) returns undefined

توسط برنامه وب Interactive Canvas پس از بارگیری برای ثبت تماس‌های برگشتی فراخوانی می‌شود.

پارامترها
callbacks InteractiveCanvasCallbacks

یک شی که حاوی فراخوانی متد است.

sendTextQuery 

sendTextQuery(textQuery) returns Promise<state>

یک درخواست متنی به عمل مکالمه ارسال می کند.

پارامترها
textQuery string

پرس و جو برای ارسال به کنش مکالمه.

state string

یکی از موارد زیر:

READY: درخواست ها می توانند توسط پلت فرم پذیرفته شوند.

BLOCKED: یک پرس و جو در حال پرواز است و درخواست جدید حذف خواهد شد.

UNKNOWN: وضعیت درخواست فعلی را نمی توان تعیین کرد.

getHeaderHeightPx 

getHeaderHeightPx() returns Promise<height>

ارتفاع هدر بالای صفحه نمایش را تعیین می کند.

پارامترها
height number

ارتفاع بر حسب پیکسل

خروجی Tts 

outputTts(text, openMic) returns undefined;

متن SSML را پخش می کند.

پارامترها
text string

رشته ای که از SSML برای پخش پشتیبانی می کند.

openMic boolean

بعد از پخش TTS، میکروفون باز شود.

createIntentHandler

createIntentHandler(intentId, callback) returns IntentHandler

یک کنترل کننده قصد برای یک هدف سفارشی NLU ایجاد می کند.

پارامترها
intentId string

نام Intent همانطور که در Actions Builder تعریف شده است.

callback function( MatchedIntent )

عملکردی که باید زمانی اجرا شود که هدف مطابقت داشته باشد.

IntentHandler object

شیء کنترل کننده قصد که می تواند با استفاده از expect() ثبت شود.

IntentHandler

یک شی که نشان دهنده یک کنترل کننده قصد است. می توان با استفاده از expect() یا prompt() ثبت نام کرد.

MatchedIntent

یک شی که حاوی داده‌های یک هدف منطبق است.

روش ها
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>

یک اسلات از نوع بولی ایجاد می کند.

پارامترها
callback function( FilledSlot )

عملکردی که باید با پر شدن شکاف اجرا شود.

hints Hints

کلمات کوتاهی که کاربر ممکن است هنگام پر کردن یک شکاف بگوید. hints به سیستم NLU کمک می کند تا تصمیم بگیرد کدام شکاف را پر کند.

Slot object

شیء اسلاتی که می توان با استفاده از prompt() ثبت کرد.

createOptionsSlot

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

یک اسلات از یک لیست از پیش تعریف شده از گزینه ها ایجاد می کند.

پارامترها
options array< Option >

عملکردی که باید با پر شدن شکاف اجرا شود.

callback function( FilledSlot )

عملکردی که باید با پر شدن شکاف اجرا شود.

hints Hints

کلمات کوتاهی که کاربر ممکن است هنگام پر کردن یک شکاف بگوید. hints به سیستم NLU کمک می کند تا تصمیم بگیرد کدام شکاف را پر کند.

Slot object

شیء اسلاتی که می توان با استفاده از prompt() ثبت کرد.

اسلات

شیئی که نشان دهنده شکافی است که باید پر شود. می توان با استفاده از expect() یا prompt() ثبت نام کرد.

FilledSlot<T>

شیئی که نشان دهنده یک شکاف پر شده است.

پارامتر
T boolean|number|string

نوع اسلات

گزینه

یک شی که نشان دهنده ورودی نوع شکاف است.

فیلدها
key string

شناسه منحصر به فرد برای ورودی نوع شکاف.

synonyms array<string>

لیستی از کلمات مورد استفاده برای انتخاب گزینه اسلات.

نکات

یک شی که نشان دهنده نکاتی برای یک شکاف است.

فیلدها
associatedWords array<string>

فهرستی از کلمات مورد استفاده برای کمک به سیستم NLU در تصمیم گیری که کدام شکاف را پر کند.

انتظار می رود

expect(expectation) returns HandlerRegistration

انتظارات را بر روی مشتری ثبت می کند. می توان در کنترل کننده های هدف و اسلات ها فراخوانی کرد.

پارامترها
expectation IntentHandler | Slot

کنترل کننده قصد یا شکافی که باید ثبت شود.

HandlerRegistration object

کنترل کننده قصد یا شکاف ثبت شده.

ثبت نام Handler

یک شی که نشان دهنده یک کنترل کننده قصد ثبت شده است.

روش ها
deleteHandler() function

کنترل کننده قصد مورد انتظار را لغو ثبت می کند.

انتظارات روشن

clearExpectations() returns undefined;

با حذف همه کنترل‌کننده‌ها و اسلات‌های قصد ثبت‌شده قبلی، همه انتظارات را از بین می‌برد.

سریع

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

رشته TTS ارائه شده را از کاربر درخواست می کند و انتظارات را در مشتری ثبت می کند. می توان در کنترل کننده های هدف و اسلات ها فراخوانی کرد.

پارامترها
tts string

رشته TTS برای درخواست از کاربر برای انتظار ارائه شده استفاده می شود.

expectation IntentHandler | Slot

کنترل کننده قصد یا شکافی که باید ثبت شود.

Answer<T> object

پاسخ ارائه شده توسط کاربر به درخواست.

پاسخ <T>

یک شی نشان دهنده پاسخ ارائه شده توسط کاربر به یک درخواست است.

فیلدها
value boolean|number|string

ارزش پاسخ ارائه شده توسط کاربر.

status string

وضعیت پاسخ.

یکی از موارد زیر:

ANSWERED: کاربر با پاسخ به درخواست پاسخ داد.

NO_MATCH: از کاربر خواسته شد تا یک پاسخ بدهد و با پاسخی که با پاسخ مورد انتظار یا هر هدف مورد انتظار دیگری مطابقت نداشت، پاسخ داد.

YIELD: کاربر با هدف متفاوتی به درخواست پاسخ داد.

triggerScene

triggerScene(sceneName) returns Promise<TriggerSceneStatus>

صحنه ای را تحریک می کند.

پارامترها
sceneName string

نام صحنه برای شروع.

TriggerSceneStatus string

وضعیت تماس با triggerScene().

یکی از موارد زیر:

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

به دستیار اطلاع می دهد که برنامه وب Canvas وضعیت خود را به روز کرده است. متد setCanvasState مقداری را بر نمی گرداند. از طریق ویژگی conv.context.canvas.state می توان به بارگذاری وضعیت دسترسی داشت.

پارامترها
state Object

وضعیت به روز شده برنامه Canvas به عنوان یک شی JSON.

InteractiveCanvasCallbacks

این تماس‌های برگشتی راهی برای پاسخگویی به اطلاعات یا درخواست‌های کنش مکالمه‌تان در اختیار شما قرار می‌دهند، در حالی که روش‌ها راهی برای ارسال اطلاعات یا درخواست‌ها به کنش مکالمه‌تان ارائه می‌دهند.

در به روز رسانی 

onUpdate(data) returns Promise|undefined

هنگامی که یک پاسخ Canvas از کنش مکالمه ارسال می شود، فراخوانی می شود. زمانی که Promise برگشتی حل شد، TTS شروع می‌شود یا بعد از 10 ثانیه به پایان می‌رسد.

پارامترها
data Object

داده های به روز شده ارسال شده توسط وب هوک.

onTtsMark 

onTtsMark(markName) returns undefined

پاسخ به تماس که در حین پخش TTS فراخوانی می شود.

علائم ویژه ای که همیشه فعال می شوند:

  • START شروع TTS را نشان می دهد.
  • END پایان TTS را نشان می دهد.
  • ERROR نشان دهنده خطا در پخش TTS است.

همچنین می‌توانید علامت‌های سفارشی را با استفاده از SSML و تگ <mark> ، مانند <mark name="custom"/> تعریف کنید.

پارامترها
markName string

علامت گذاری نام در حین پخش TTS.

onInputStatusChanged

onInputStatusChanged(inputStatus) returns undefined

به برنامه Canvas اطلاع می دهد که وضعیت ورودی دستیار تغییر کرده است.

پارامترها
inputStatus Enum

وضعیت پردازش ورودی صدا و/یا متن در دستگاه. می تواند موارد زیر باشد:

  • LISTENING : میکروفون باز است.
  • IDLE : میکروفون بسته است.
  • PROCESSING : دستیار در حال حاضر در حال اجرای یک درخواست است (میکروفون بسته است).