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