- تمثيل YAML
- StaticPrompt
- StaticPromptCandidate
- أداة الاختيار
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- خيار المنتج
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt.
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- اقتراح
- StaticCanvasPrompt
تحدد معالجًا ليتم تنفيذه بعد الحدث. من أمثلة الأحداث الأحداث المستندة إلى النية والحالة في مشهد.
تمثيل YAML | |
---|---|
webhookHandler: string # Union field |
الحقول | ||
---|---|---|
webhookHandler |
اسم معالِج الردّ التلقائي على الويب المطلوب طلبه |
|
حقل الاتحاد prompt يمكن أن تكون الطلبات مضمّنة أو تتم الإشارة إليها حسب الاسم. يمكن أن تكون السمة "prompt " واحدة فقط مما يلي: |
||
staticPrompt |
موجّه ثابت مضمّن يمكن أن تحتوي على مراجع لموارد السلسلة في الحِزم. |
|
staticPromptName |
اسم الطلب الثابت المطلوب استدعاءه |
StaticPrompt
يمثّل هذا النوع قائمة من الطلبات المرشحة التي سيتم اختيار أحدها كطلب يظهر في الردّ على المستخدم. هذه الرسالة قابلة للترجمة.
تمثيل YAML | |
---|---|
candidates:
- object ( |
الحقول | |
---|---|
candidates[] |
قائمة بالطلبات المرشحة التي سيتم إرسالها إلى العميل. يتضمّن كل طلب أداة اختيار لتحديد وقت استخدامها. سيتم إرسال أداة الاختيار الأولى التي تتطابق مع أحد الطلبات، وسيتم تجاهل بقية العناصر. |
StaticPromptCandidate
يمثِّل العنصر المحفّز لعرض طلب ثابت.
تمثيل YAML | |
---|---|
selector: object ( |
الحقول | |
---|---|
selector |
اختياريّ. تمثّل هذه السمة معايير ما إذا كان هذا الطلب يتطابق مع أحد الطلبات. إذا كانت أداة الاختيار فارغة، سيتمّ عرض هذا الطلب دائمًا. |
promptResponse |
الردّ المرتبط بأداة الاختيار |
أداة الاختيار
تحدِّد هذه السياسة معايير ما إذا كان الطلب يتطابق مع أحد الطلبات.
تمثيل YAML | |
---|---|
surfaceCapabilities:
object ( |
الحقول | |
---|---|
surfaceCapabilities |
مجموعة إمكانات السطح المطلوبة. |
SurfaceCapabilities
تمثل مساحة العرض التي يستخدمها المستخدم لتقديم طلب إلى الإجراء.
تمثيل YAML | |
---|---|
capabilities:
- enum ( |
الحقول | |
---|---|
capabilities[] |
مطلوبة. تمثّل هذه السمة إمكانات السطح الذي يمكنه تقديم طلب إلى الإجراء. |
StaticPromptResponse
تمثّل هذه السمة الردود المنظَّمة المطلوب إرسالها إلى المستخدم، مثل النص والكلام والبطاقات وبيانات لوحة الرسم وشرائح الاقتراحات وما إلى ذلك.
تمثيل YAML | |
---|---|
firstSimple: object ( |
الحقول | |
---|---|
firstSimple |
اختياريّ. الاستجابة الأولى بالصوت والنص فقط. |
content |
اختياريّ. محتوى مثل بطاقة أو قائمة أو وسائط يتم عرضها للمستخدم. |
lastSimple |
اختياريّ. الرد الأخير بالصوت والنص فقط. |
suggestions[] |
اختياريّ. الاقتراحات التي يتم عرضها للمستخدم والتي ستظهر دائمًا في نهاية الرد. إذا كان الحقل |
link |
اختياريّ. شريحة اقتراحات إضافية يمكنها توفير رابط إلى التطبيق أو الموقع الإلكتروني المرتبطَين سيتم عرض الشريحة بعنوان "فتح |
override |
اختياريّ. وضع لكيفية دمج هذه الرسائل مع الرسائل المحددة مسبقًا سيمحو " |
canvas |
ردّ يمكن استخدامه لتجربة لوحة تفاعلية. |
StaticSimplePrompt
يمثِّل طلبًا بسيطًا لإرساله إلى أحد المستخدمين.
تمثيل YAML | |
---|---|
variants:
- object ( |
الحقول | |
---|---|
variants[] |
قائمة بالصيغ المحتملة |
الصيغة
تمثيل صيغة تشكل جزءًا من الطلب البسيط
تمثيل YAML | |
---|---|
speech: string text: string |
الحقول | |
---|---|
speech |
اختياريّ. تمثِّل الكلام الذي سيتم قوله إلى المستخدم. يمكن أن يكون تنسيق SSML أو نص إلى كلام. سيتم إلحاق الكلام تلقائيًا بالكلام الخاص بـ Simple Speak. إذا كان الحقل |
text |
اختياريّ. نص لعرضه في فقاعة المحادثة. في حال عدم توفيره، سيتم عرض حقل الكلام أعلاه. تقتصر على 640 حرفًا. سيتم إلحاق النص تلقائيًا بنص رسالة "الطلب البسيط" السابقة. إذا كان الحقل |
StaticContentPrompt
تمثّل هذه السمة عنصرًا نائبًا لجزء المحتوى من StaticPrompt.
تمثيل YAML | |
---|---|
# Union field |
الحقول | ||
---|---|---|
حقل الاتحاد content يمكن توفير نوع واحد فقط من المحتوى في الطلب. يمكن أن تكون السمة "content " واحدة فقط مما يلي: |
||
card |
بطاقة أساسية. |
|
image |
صورة. |
|
table |
بطاقة جدول. |
|
media |
استجابة تشير إلى مجموعة من الوسائط التي سيتم تشغيلها. |
|
list |
بطاقة لمشاركة عرض قائمة خيارات للاختيار من بينها. |
|
collection |
بطاقة تعرِض قائمة بالخيارات التي يمكنك الاختيار من بينها. |
|
collectionBrowse |
بطاقة تعرض مجموعة من صفحات الويب لتفتحها |
StaticCardPrompt
بطاقة أساسية لعرض بعض المعلومات، مثل صورة و/أو نص.
تمثيل YAML | |
---|---|
title: string subtitle: string text: string image: object ( |
الحقول | |
---|---|
title |
اختياريّ. العنوان العام للبطاقة. |
subtitle |
اختياريّ. العنوان الفرعي للبطاقة. |
text |
مطلوبة. النص الأساسي للبطاقة، وهو مطلوب ما لم تكن الصورة متوفّرة. تدعم مجموعة محدودة من بنية markdown للتنسيق. |
image |
اختياريّ. صورة الجزء الرئيسي للبطاقة. ويتم تثبيت الارتفاع على 192 بكسل مستقل الكثافة. |
imageFill |
اختياريّ. كيفية ملء خلفية الصورة |
button |
اختياريّ. زر قابل للنقر يظهر في البطاقة. |
StaticImagePrompt
صورة معروضة في البطاقة.
تمثيل YAML | |
---|---|
url: string alt: string height: integer width: integer |
الحقول | |
---|---|
url |
مطلوبة. عنوان URL المصدر للصورة ويمكن أن تكون الصور بتنسيق JPG وPNG وGIF (الرسوم المتحركة وغير المتحركة). مثلاً، |
alt |
مطلوبة. وصف نصي للصورة الذي سيتم استخدامه لتسهيل الاستخدام، مثل برامج قراءة الشاشة. |
height |
اختياريّ. ارتفاع الصورة بالبكسل. |
width |
اختياريّ. عرض الصورة بالبكسل. |
StaticLinkPrompt
تُحدِّد رابطًا سيتم عرضه كشريحة اقتراح ويمكن للمستخدم فتحه.
تمثيل YAML | |
---|---|
name: string
open:
object ( |
الحقول | |
---|---|
name |
اسم الرابط |
open |
تُحدِّد السلوك عندما يفتح المستخدِم الرابط. |
OpenUrl
تُحدِّد السلوك عندما يفتح المستخدِم الرابط.
تمثيل YAML | |
---|---|
url: string
hint: enum ( |
الحقول | |
---|---|
url |
حقل عنوان URL الذي يمكن أن يكون أيًا مما يلي: - عناوين URL التي تستخدم http/https لفتح تطبيق مرتبط بتطبيق أو صفحة ويب |
hint |
تشير هذه السمة إلى نوع عنوان URL. |
StaticTablePrompt
بطاقة جدول لعرض جدول نصوص.
تمثيل YAML | |
---|---|
title: string subtitle: string image: object ( |
الحقول | |
---|---|
title |
اختياريّ. العنوان العام للجدول. يجب ضبطها في حال ضبط العنوان الفرعي. |
subtitle |
اختياريّ. العنوان الفرعي للجدول. |
image |
اختياريّ. صورة مرتبطة بالجدول |
columns[] |
اختياريّ. العناوين ومحاذاة الأعمدة. |
rows[] |
اختياريّ. بيانات الصف في الجدول. نضمن ظهور أول 3 صفوف، ولكن قد يتم قص بعضها الآخر على مساحات عرض معيّنة. يُرجى الاختبار باستخدام المحاكي لمعرفة الصفوف التي سيتم عرضها لسطح معيّن. على مساحات العرض التي تتيح إمكانية استخدام |
button |
اختياريّ. زرّ |
TableColumn
لوصف عمود في الجدول.
تمثيل YAML | |
---|---|
header: string
align: enum ( |
الحقول | |
---|---|
header |
نص العنوان للعمود. |
align |
محاذاة أفقية للمحتوى w.r.t العمود وإذا لم يتم تحديده، ستتم محاذاة المحتوى مع الحافة البادئة. |
TableRow
تصف صفًا في الجدول.
تمثيل YAML | |
---|---|
cells:
- object ( |
الحقول | |
---|---|
cells[] |
الخلايا في هذا الصف. نضمن ظهور أول 3 خلايا، ولكن قد يتم قص الخلايا الأخرى على أسطح معينة. يُرجى الاختبار باستخدام المحاكي لمعرفة الخلايا التي سيتم عرضها لسطح معين. |
divider |
يشير إلى ما إذا كان يجب وجود مُقسّم بعد كل صف. |
TableCell
لوصف خلية في صف واحد.
تمثيل YAML | |
---|---|
text: string |
الحقول | |
---|---|
text |
المحتوى النصي للخلية. |
StaticMediaPrompt
يحتوي على معلومات عن الوسائط، مثل الاسم والوصف وعنوان URL وما إلى ذلك. المعرّف التالي: 11
تمثيل YAML | |
---|---|
mediaType: enum ( |
الحقول | |
---|---|
mediaType |
نوع الوسائط لهذا الرد |
startOffset |
بدء إزاحة كائن الوسائط الأول مدة بالثواني مؤلفة من تسعة أرقام كسور كحد أقصى، وتم إنهاؤها بـ " |
optionalMediaControls[] |
أنواع عناصر تحكّم اختيارية في الوسائط يمكن أن توفّرها جلسة الاستجابة للوسائط هذه. وفي حال ضبط هذه السياسة، سيتم إرسال الطلب إلى 3p عند وقوع حدث معيّن على الوسائط. إذا لم يتم ضبط السياسة، يجب أن تعالج جهة 3p نوعَي التحكّم التلقائيَّين، وهما "تم الانتهاء" و"تعذّر التحقق". |
mediaObjects[] |
قائمة بكائنات الوسائط |
repeatMode |
وضع التكرار لقائمة كائنات الوسائط. |
MediaObject
يمثل عنصر وسائط واحدًا.
تمثيل YAML | |
---|---|
name: string
description: string
url: string
image:
object ( |
الحقول | |
---|---|
name |
اسم عنصر الوسائط هذا |
description |
وصف عنصر الوسائط هذا. |
url |
تمثّل هذه السمة عنوان URL الذي يشير إلى محتوى الوسائط. |
image |
الصورة التي سيتم عرضها مع بطاقة الوسائط. |
MediaImage
الصورة التي سيتم عرضها داخل MediaPrompt
تمثيل YAML | |
---|---|
# Union field |
الحقول | ||
---|---|---|
حقل الاتحاد image يُسمح بنوع واحد فقط من MediaImage. يمكن أن تكون السمة "image " واحدة فقط مما يلي: |
||
large |
صورة كبيرة، مثل غلاف الألبوم وما إلى ذلك |
|
icon |
رمز صورة صغير معروض على يسار العنوان يتم تغيير حجمه إلى 36x36 بكسل مستقل الكثافة. |
StaticListPrompt
بطاقة لمشاركة عرض قائمة خيارات للاختيار من بينها.
تمثيل YAML | |
---|---|
title: string
subtitle: string
items:
- object ( |
الحقول | |
---|---|
title |
اختياريّ. عنوان القائمة |
subtitle |
اختياريّ. العنوان الفرعي للقائمة. |
items[] |
مطلوبة. عناصر القائمة |
ListItem
عنصر في القائمة
تمثيل YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
الحقول | |
---|---|
key |
مطلوبة. مفتاح NLU الذي يتطابق مع اسم مفتاح الإدخال في النوع المرتبط به. عند النقر على العنصر، ستتم إعادة نشر هذا المفتاح كمَعلَمة خيار تحديد. |
title |
مطلوبة. عنوان السلعة. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة العناصر. |
description |
اختياريّ. النص الأساسي للعنصر. |
image |
اختياريّ. صورة العنصر |
StaticCollectionPrompt
بطاقة لمشاركة عرض مجموعة من الخيارات التي يمكنك الاختيار من بينها.
تمثيل YAML | |
---|---|
title: string subtitle: string items: - object ( |
الحقول | |
---|---|
title |
اختياريّ. عنوان المجموعة |
subtitle |
اختياريّ. العنوان الفرعي للمجموعة. |
items[] |
مطلوبة. عناصر المجموعة |
imageFill |
اختياريّ. نوع خيار عرض الصورة |
CollectionItem
عنصر في المجموعة
تمثيل YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
الحقول | |
---|---|
key |
مطلوبة. مفتاح NLU الذي يطابق اسم مفتاح الإدخال في النوع المرتبط به. عند النقر على العنصر، ستتم إعادة نشر هذا المفتاح كمَعلَمة خيار تحديد. |
title |
مطلوبة. عنوان السلعة. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة العناصر. |
description |
اختياريّ. النص الأساسي للعنصر. |
image |
اختياريّ. صورة العنصر |
StaticCollectionBrowsePrompt
يقدم مجموعة من مستندات الويب كمجموعة من عناصر المربعات الكبيرة. يمكن اختيار عناصر لتشغيل مستند الويب المرتبط بها في عارض الويب.
تمثيل YAML | |
---|---|
items: - object ( |
الحقول | |
---|---|
items[] |
العناصر في مجموعة التصفُّح يجب أن يتراوح حجم القائمة بين النطاق [2 و10]. |
imageFill |
خيار عرض الصور للصور في المجموعة. |
CollectionBrowseItem
العنصر في المجموعة
تمثيل YAML | |
---|---|
title: string description: string footer: string image: object ( |
الحقول | |
---|---|
title |
مطلوبة. عنوان عنصر المجموعة. |
description |
وصف عنصر المجموعة. |
footer |
نص تذييل عنصر المجموعة، معروض أسفل الوصف. سطر واحد من النص، تم اقتطاعه بعلامة حذف. |
image |
صورة لعنصر المجموعة |
openUriAction |
مطلوبة. معرّف موارد منتظم (URI) لفتحه في حال اختيار العنصر. |
الاقتراح
تمثّل هذه السمة شريحة اقتراح، وهي عنصر في واجهة المستخدم يتم عرضه للمستخدم لتسهيل تجربته.
تمثيل YAML | |
---|---|
title: string |
الحقول | |
---|---|
title |
مطلوبة. النص المعروض في شريحة الاقتراح. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة شرائح الاقتراحات. 25 حرفًا بحد أقصى |
StaticCanvasPrompt
يُمثِّل استجابة "لوحة الرسم التفاعلية" التي سيتم إرسالها إلى المستخدم. يمكن استخدام هذا الإجراء إلى جانب الحقل firstSimple
في الطلب الذي يتضمّنه للتحدّث إلى المستخدم بالإضافة إلى عرض ردّ تفاعلي على لوحة الرسم.
تمثيل YAML | |
---|---|
url: string data: - value suppressMic: boolean sendStateDataToCanvasApp: boolean enableFullScreen: boolean continueTtsDuringTouch: boolean |
الحقول | |
---|---|
url |
مطلوبة. عنوان URL لعرض الويب المطلوب تحميله. |
data[] |
اختياريّ. بيانات JSON التي يتم تمريرها إلى صفحة الويب الخاصة بالتجربة الشاملة على أنّها فعالية إذا كان الحقل |
suppressMic |
اختياريّ. وتعني القيمة الحقيقية أنّه لن يتم فتح الميكروفون لالتقاط الإدخال بعد تقديم هذا الاستجابة الشاملة للمستخدم. |
sendStateDataToCanvasApp |
اختياريّ. إذا |
enableFullScreen |
اختياريّ. إذا كان |
continueTtsDuringTouch |
اختياريّ. إذا كانت الإجابة "صحيحة"، لن تؤدي نقرات الشاشة إلى إيقاف تقنية "تحويل النص إلى كلام" (TTS) لجلسة لوحة الرسم بأكملها. القيمة التلقائية: خطأ. |