مرجع واجهة برمجة التطبيقات للوحة الرسم التفاعلية

واجهة برمجة تطبيقات Canvas التفاعلية هي مكتبة JavaScript يمكنك استخدامها لإنشاء واجهة من خلال "الإجراء الحواري" باستخدام الكائن interactiveCanvas في تطبيق الويب.

لمزيد من المعلومات حول لوحة الرسم التفاعلية، راجع لوحة الرسم التفاعلية ذات الصلة.

الطُرق

جاهز

ready(callbacks) returns undefined

يتم استدعاء هذه الدالة من خلال تطبيق الويب للوحة الرسم التفاعلية بعد تحميلها لتسجيل معاودة الاتصال.

المعلمات
callbacks InteractiveCanvasCallbacks

يشير ذلك المصطلح إلى كائن يحتوي على عمليات استدعاء الطريقة.

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

تحديد ما إذا كان سيتم فتح الميكروفون بعد تشغيل تحويل النص إلى كلام

createIntentHandler

createIntentHandler(intentId, callback) returns IntentHandler

تُنشئ معالجًا intent لـ NLU المخصص حسب النية بالشراء.

المعلمات
intentId string

اسم الغرض على النحو المحدّد في "أداة إنشاء المهام".
callback function(MatchedIntent)

الدالة التي يتم تنفيذها عند مطابقة الغرض.
IntentHandler object

كائن معالج Intent الذي يمكن تسجيله باستخدام expect()

IntentHandler

كائن يمثل معالج intent. يمكن التسجيل باستخدام expect() أو prompt().

MatchedIntent

كائن يحتوي على البيانات لغرض مطابق

الطُرق
getIntentArg(parameterName) function(string)

طريقة للحصول على معلَمة 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&lt;T&gt;

كائن يمثّل خانة معبأة

المعلمة
T boolean|number|string

نوع الخانة

Option

كائن يمثّل إدخالاً لنوع الخانة

الحقول
key string

المعرّف الفريد لإدخال نوع الخانة
synonyms array<string>

قائمة بالكلمات المستخدَمة لتحديد خيار الخانة

تلميحات

كائن يمثّل تلميحات لخانة.

الحقول
associatedWords array<string>

قائمة بالكلمات المستخدمة لمساعدة نظام NLU في تحديد الخانة المراد ملؤها.

يتوقع

expect(expectation) returns HandlerRegistration

تسجيل التوقع على العميل. يمكن طلبها على معالِجات الأهداف والخانات.

المعلمات
expectation IntentHandler|Slot

معالج intent أو الخانة المطلوب تسجيلها.
HandlerRegistration object

معالِج الهدف المسجَّل.

HandlerRegistration

تمثّل هذه السمة كائنًا يمثّل معالِج الهدف المسجَّل.

الطُرق
deleteHandler() function

يؤدي هذا الإجراء إلى إلغاء تسجيل معالِج intent المتوقع.

clearExpectations

clearExpectations() returns undefined;

ستتخلص من كل التوقعات من خلال حذف كل معالِجات الأهداف وخانات الأهداف المسجَّلة سابقًا.

إشعار

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

تُطلب من المستخدم باستخدام سلسلة "تحويل النص إلى كلام" المُقدّمة، وتسجِّل التوقع على الجهاز. يمكن طلبها على معالِجات الأهداف والخانات.

المعلمات
tts string

سلسلة "تحويل النص إلى كلام" المستخدمة لمطالبة المستخدم بالتوقعات المقدمة.
expectation IntentHandler|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

حالة الاستدعاء إلى runScene().

يجب استخدام إحدى السمات التالية:

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

يتم إرسال إشعار إلى "مساعد Google" بأنّ تطبيق "لوحة الرسم" على الويب قد عدَّل حالته. تشير رسالة الأشكال البيانية setCanvasState لا تُرجع الطريقة قيمة. يمكن الوصول إلى حمولة الحالة من خلال conv.context.canvas.state.

المعلمات
state Object

الحالة المحدَّثة لتطبيق "لوحة الرسم" باعتباره كائن JSON.

InteractiveCanvasCallbacks

توفر لك عمليات الاسترداد هذه وسيلة للرد على المعلومات أو الطلبات من "الإجراء الحواري" بينما توفّر الطرق طريقة لإرسال معلومات أو طلبات لـ "الإجراء الحواري" الخاص بك.

onUpdate

onUpdate(data) returns Promise|undefined

يتم استدعاء هذه الوظيفة عند إرسال ردّ Canvas من "الإجراء المستند إلى المحادثة". ستبدأ تحويل النص إلى كلام عندما يتم التعامل بشكل نهائي مع الوعد المعروض، أو انتهاء المهلة بعد 10 ثوانٍ.

المعلمات
data Object

البيانات المعدّلة التي تم إرسالها من خلال الرد التلقائي على الويب

onTtsMark

onTtsMark(markName) returns undefined

معاودة الاتصال التي تم استدعاءها أثناء تشغيل تحويل النص إلى كلام

العلامات الخاصة التي يتم تشغيلها دائمًا:

  • تشير السمة START إلى بداية تقنية "تحويل النص إلى كلام".
  • تشير السمة END إلى نهاية تقنية "تحويل النص إلى كلام".
  • تشير السمة ERROR إلى خطأ في تشغيل النص المحوَّل إلى كلام.

يمكنك أيضًا تحديد علامات مخصّصة باستخدام SSML والعلامة <mark>، مثل <mark name="custom"/>

المعلمات
markName string

وضع علامة على الاسم الذي تم استدعاءه أثناء تشغيل تحويل النص إلى كلام

onInputStatusChanged

onInputStatusChanged(inputStatus) returns undefined

يتم إشعار تطبيق "لوحة الرسم" بأنّ حالة إدخال "مساعد Google" قد تغيّرت.

المعلمات
inputStatus Enum

حالة معالجة الصوت و/أو إدخال النص على الجهاز علبة على النحو التالي:

  • LISTENING : الميكروفون مفتوح.
  • IDLE : الميكروفون مغلق.
  • PROCESSING : يُنفّذ "مساعد Google" حاليًا عملية. طلب البحث (الميكروفون مغلق).