- 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 |
اختياريّ. وضع لكيفية دمج هذه الرسائل مع الرسائل المحددة مسبقًا. "صحيح" سيؤدي هذا الإجراء إلى محو جميع الرسائل المحدَّدة مسبقًا (الأولى والأخيرة، ورابط المحتوى والاقتراحات، ولوحة الرسم) وإضافة الرسائل المحدَّدة في هذا الطلب. "خطأ" ستتم إضافة الرسائل المحدَّدة في هذا الطلب إلى الرسائل المحدَّدة في الردود السابقة. ضبط هذا الحقل على "خطأ" سيتم أيضًا تمكين الإلحاق ببعض الحقول داخل الطلبات البسيطة ومطالبة الاقتراحات ومطالبة لوحة الرسم (جزء من مطالبة المحتوى). سيتم دائمًا استبدال رسائل "المحتوى" و"الروابط" إذا تم تحديدها في الطلب. القيمة التلقائية هي "خطأ". |
canvas |
رد يتم استخدامه في تجربة اللوحة التفاعلية. |
StaticSimplePrompt
يمثل طلبًا بسيطًا لإرساله إلى مستخدم.
تمثيل JSON | |
---|---|
{
"variants": [
{
object ( |
الحقول | |
---|---|
variants[] |
قائمة بالصيغ المحتملة |
الصيغة
يمثل هذا المتغير جزءًا من الطلب البسيط.
تمثيل JSON | |
---|---|
{ "speech": string, "text": string } |
الحقول | |
---|---|
speech |
اختياريّ. تمثل الكلام الذي سيتم قوله للمستخدم. يمكن أن يكون SSML أو تحويل النص إلى كلام. إذا كانت السمة "append" الحقل في الطلب الذي يتضمّن الرسالة هو "صحيح" سيتم إلحاق الكلام المحدد في هذا الحقل بالكلام في الطلب البسيط السابق. |
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 وحدة بكسل مستقلة الكثافة (dp). |
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 الذي يمكن أن يكون أيًا مما يلي: - http/https عناوين URL لفتح تطبيق مرتبط بتطبيق أو صفحة ويب |
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[] |
أنواع عناصر التحكم الاختيارية في الوسائط التي يمكن أن تدعمها جلسة الاستجابة للوسائط هذه. في حال ضبطها، سيتم تقديم الطلب إلى جهة خارجية عند وقوع حدث معيّن للوسائط. في حال ترك هذه السياسة بدون ضبط، يجب أن يتعامل الطرف الثالث مع نوعَي التحكّم التلقائيَّين، "تم الانتهاء" و"تعذّر الإجراء". |
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 |
رمز صورة صغير يتم عرضه على يمين العنوان. ويتم تغيير حجمها إلى 36×36 بكسل مستقل الكثافة. |
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 إلى صفحة الويب للتجربة الشاملة كفعالية. إذا تم "إلغاء" الحقل في الطلب الذي يتضمّن الطلب هو "false" ستتم إضافة قيم البيانات المحددة في طلب لوحة الرسم هذا بعد قيم البيانات المحددة في طلبات لوحة الرسم السابقة. |
suppressMic |
اختياريّ. وتعني القيمة الحقيقية أنّه لن يتم فتح الميكروفون لالتقاط الإدخال بعد تقديم هذا الردّ الغامر للمستخدم. |