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

واجهة برمجة التطبيقات التفاعلية للوحة الرسم هي مكتبة JavaScript يمكنك استخدامها للتفاعل مع "الإجراء الحواري" باستخدام الكائن 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

الارتفاع بالبكسل.

outputTts

outputTts(text, openMic) returns undefined;

لتشغيل نص SSML.

المَعلمات
text string

سلسلة SSML المتوافقة المطلوب تشغيلها.

openMic boolean

يمكنك اختيار ما إذا كنت تريد فتح الميكروفون بعد تشغيل تقنية TTS.

createIntentHandler

createIntentHandler(intentId, callback) returns IntentHandler

تُنشئ معالِج أهداف لـ NLU مخصّص حسب النية بالشراء.

المَعلمات
intentId string

اسم الغرض كما هو محدّد في أداة إنشاء الإجراءات.

callback function(MatchedIntent)

الدالة المطلوب تنفيذها عند مطابقة الهدف.

IntentHandler object

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

IntentHandler

يشير ذلك المصطلح إلى كائن يمثّل معالج أهداف. يمكن التسجيل باستخدام 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<T>

يشير هذا المصطلح إلى كائن يمثّل فتحة معبأة.

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

نوع الخانة

Option

يشير ذلك المصطلح إلى كائن يمثّل إدخالاً لنوع الخانة.

الحقول
key string

المعرّف الفريد لإدخال نوع الخانة

synonyms array<string>

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

تلميحات

يشير ذلك المصطلح إلى كائن يمثّل تلميحات عن خانة.

الحقول
associatedWords array<string>

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

expect

expect(expectation) returns HandlerRegistration

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

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

معالج الغرض أو الخانة المراد تسجيلها

HandlerRegistration object

معالج الغرض المسجّل أو الخانة

HandlerRegistration

يشير ذلك المصطلح إلى كائن يمثّل معالج أهداف مسجَّل.

الطُرق
deleteHandler() function

إلغاء تسجيل معالج الغرض المتوقّع

clearExpectations

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

تُعلِم "مساعد Google" "مساعد 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

معاودة الاتصال التي تم استدعاؤها أثناء تشغيل تقنية TTS.

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

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

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

المَعلمات
markName string

تم استدعاء اسم العلامة أثناء تشغيل تقنية TTS.

onInputStatusChanged

onInputStatusChanged(inputStatus) returns undefined

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

المَعلمات
inputStatus Enum

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

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