EventHandler

لتحديد معالجًا سيتم تنفيذه بعد حدث. ومن الأمثلة على الأحداث هي الأحداث القائمة على النية والحالة في مشهد.

تمثيل YAML 
webhookHandler: string

# Union field prompt can be only one of the following:
staticPrompt: 
  object (StaticPrompt)
staticPromptName: string
# End of list of possible types for union field prompt.
الحقول
webhookHandler

string

اسم معالِج الرد التلقائي على الويب المطلوب طلبه.
حقل الاتحاد prompt. يمكن تضمين المطالبات أو الإشارة إليها بالاسم. يمكن أن يكون prompt واحدًا فقط مما يلي:
staticPrompt

object (StaticPrompt)

طلب ثابت مضمّن ويمكن أن يحتوي على مراجع لموارد السلسلة في الحِزم.
staticPromptName

string

اسم الطلب الثابت الذي سيتم استدعاؤه

StaticPrompt

يمثّل هذا الحقل قائمة باقتراحات طلبات البحث، وسيتم اختيار إحداها كطلب لعرضها في الردّ على المستخدم. هذه الرسالة قابلة للترجمة.

تمثيل YAML 
candidates: 
  - object (StaticPromptCandidate)
الحقول
candidates[]

object (StaticPromptCandidate)

قائمة بالطلبات المرشحة التي سيتم إرسالها إلى العميل. ويتضمّن كل طلب أداة اختيار لتحديد وقت استخدامه. سيتم إرسال أداة الاختيار الأولى التي تطابق أحد الطلبات وتجاهل الباقي.

StaticPromptCandidate

لتمثيل عنصر مرشّح للطلب الثابت

تمثيل YAML 
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
الحقول
selector

object (Selector)

اختياريّ. معايير ما إذا كان هذا الطلب يتطابق مع طلب معيّن. إذا كانت أداة الاختيار فارغة، سيتم دائمًا تشغيل هذا الطلب.
promptResponse

object (StaticPromptResponse)

تمثّل هذه السمة استجابة الطلب المرتبطة بأداة الاختيار.

أداة الاختيار

تحدِّد هذه السياسة معايير ما إذا كان الطلب يتطابق مع طلب.

تمثيل YAML 
surfaceCapabilities: 
  object (SurfaceCapabilities)
الحقول
surfaceCapabilities

object (SurfaceCapabilities)

مجموعة إمكانيات العرض المطلوبة

SurfaceCapabilities

يمثل المساحة التي يستخدمها المستخدم لتقديم طلب إلى الإجراء.

تمثيل YAML 
capabilities: 
  - enum (Capability)
الحقول
capabilities[]

enum (Capability)

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

StaticPromptResponse

تمثل هذه الميزة الردود المنظَّمة لإرسالها إلى المستخدم، مثل النصوص والكلام والبطاقات وبيانات لوحة الرسم وشرائح الاقتراحات وما إلى ذلك.

تمثيل YAML 
firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
الحقول
firstSimple

object (StaticSimplePrompt)

اختياريّ. أول رد صوتي ونص فقط.
content

object (StaticContentPrompt)

اختياريّ. محتوى مثل بطاقة أو قائمة أو وسائط لعرضها للمستخدم.
lastSimple

object (StaticSimplePrompt)

اختياريّ. آخر رد صوتي ونص فقط.
suggestions[]

object (Suggestion)

اختياريّ. سيتم عرض الاقتراحات للمستخدم والتي ستظهر دائمًا في نهاية الردّ. إذا كان الحقل append في الطلب الذي يتضمّن الطلب هو true، ستتم إضافة العناوين المحدَّدة في هذا الحقل إلى العناوين المحدَّدة في أي طلبات اقتراحات محدَّدة مسبقًا، وستتم إزالة القيم المكرّرة.
override

boolean

اختياريّ. وضع لكيفية دمج هذه الرسائل مع الرسائل المحددة مسبقًا. سيمحو true جميع الرسائل المحدَّدة مسبقًا (الأولى والأخيرة البسيطة والأخيرة ورابط المحتوى والاقتراحات ولوحة الرسم) وسيضيف الرسائل المحدَّدة في هذا الطلب. سيضيف false الرسائل المحدَّدة في هذا الطلب إلى الرسائل المحدَّدة في الردود السابقة. سيؤدي ضبط هذا الحقل على false إلى تفعيل الإلحاق ببعض الحقول داخل "الطلبات البسيطة" ومطالبة "الاقتراحات" و"طلب لوحة الرسم" (جزء من مطالبة المحتوى). سيتم دائمًا استبدال رسائل "المحتوى" و"الروابط" إذا تم تحديدها في الطلب. القيمة التلقائية هي false.
canvas

object (StaticCanvasPrompt)

رد يتم استخدامه في تجربة اللوحة التفاعلية.

StaticSimplePrompt

يمثل طلبًا بسيطًا لإرساله إلى مستخدم.

تمثيل YAML 
variants: 
  - object (Variant)
الحقول
variants[]

object (Variant)

قائمة بالصيغ المحتملة

الصيغة

يمثل هذا المتغير جزءًا من الطلب البسيط.

تمثيل YAML 
speech: string
text: string
الحقول
speech

string

اختياريّ. تمثل الكلام الذي سيتم قوله للمستخدم. يمكن أن يكون SSML أو تحويل النص إلى كلام. سيتم تلقائيًا إلحاق الكلام بالكلام في الطلب البسيط السابق. إذا كان الحقل override في الطلب الذي يتضمّن الرسالة هو true، سيلغي الكلام المحدَّد في هذا الحقل كلام الطلب البسيط السابق.
text

string

اختياريّ. النص الذي سيتم عرضه في فقاعة المحادثة. وفي حال عدم إتاحته، سيتم عرض عرض لحقل الكلام أعلاه. يقتصر على 640 حرفًا. سيتم تلقائيًا إلحاق النص بنص الطلب البسيط السابق. إذا كان الحقل override في الطلب الذي يتضمّن الطلب هو true، سيلغي النص المحدَّد في هذا الحقل نص الطلب البسيط السابق.

StaticContentPrompt

تمثّل هذه السمة عنصرًا نائبًا لجزء "المحتوى" من StaticPrompt.

تمثيل YAML 
# Union field content can be only one of the following:
card: 
  object (StaticCardPrompt)
image: 
  object (StaticImagePrompt)
table: 
  object (StaticTablePrompt)
media: 
  object (StaticMediaPrompt)
list: 
  object (StaticListPrompt)
collection: 
  object (StaticCollectionPrompt)
collectionBrowse: 
  object (StaticCollectionBrowsePrompt)
# End of list of possible types for union field content.
الحقول
حقل الاتحاد content. لا يمكن عرض سوى نوع واحد من المحتوى في الطلب. يمكن أن يكون content واحدًا فقط مما يلي:
card

object (StaticCardPrompt)

بطاقة أساسية
image

object (StaticImagePrompt)

صورة.
table

object (StaticTablePrompt)

بطاقة جدول.
media

object (StaticMediaPrompt)

استجابة تشير إلى مجموعة من الوسائط التي سيتم تشغيلها.
list

object (StaticListPrompt)

بطاقة لعرض قائمة بالخيارات للاختيار منها
collection

object (StaticCollectionPrompt)

بطاقة تعرض قائمة بالخيارات للاختيار منها.
collectionBrowse

object (StaticCollectionBrowsePrompt)

بطاقة تعرض مجموعة من صفحات الويب المراد فتحها

StaticCardPrompt

بطاقة أساسية لعرض بعض المعلومات، على سبيل المثال: صورة و/أو نص.

تمثيل YAML 
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
الحقول
title

string

اختياريّ. العنوان العام للبطاقة.
subtitle

string

اختياريّ. العنوان الفرعي للبطاقة
text

string

مطلوب. النص الأساسي للبطاقة مطلوب ما لم تكن الصورة موجودة. تتيح مجموعة محدودة من بنية markdown للتنسيق.
image

object (StaticImagePrompt)

اختياريّ. صورة الجزء الرئيسي للبطاقة تم تثبيت الارتفاع على 192 وحدة بكسل مستقلة الكثافة (dp).
imageFill

enum (ImageFill)

اختياريّ. طريقة ملء خلفية الصورة
button

object (StaticLinkPrompt)

اختياريّ. زرّ يمكن النقر عليه لعرضه في البطاقة

StaticImagePrompt

صورة معروضة في البطاقة

تمثيل YAML 
url: string
alt: string
height: integer
width: integer
الحقول
url

string

مطلوب. عنوان URL المصدر الخاص بالصورة يمكن أن تكون الصور بتنسيق JPG وPNG وGIF (متحرّكة وغير متحركة). مثلاً: https://www.agentx.com/logo.png
alt

string

مطلوب. وصف نصي للصورة التي سيتم استخدامها لتسهيل الاستخدام، على سبيل المثال قارئات الشاشة.
height

integer

اختياريّ. ارتفاع الصورة بالبكسل.
width

integer

اختياريّ. عرض الصورة بالبكسل.

StaticLinkPrompt

تحدّد هذه السمة رابطًا سيتم عرضه كشريحة اقتراح ويمكن للمستخدم فتحه.

تمثيل YAML 
name: string
open: 
  object (OpenUrl)
الحقول
name

string

اسم الرابط
open

object (OpenUrl)

تحدِّد هذه السياسة السلوك عندما يفتح المستخدم الرابط.

OpenUrl

تحدِّد هذه السياسة السلوك عندما يفتح المستخدم الرابط.

تمثيل YAML 
url: string
hint: enum (UrlHint)
الحقول
url

string

حقل عنوان URL الذي يمكن أن يكون أيًا مما يلي: - http/https عناوين URL لفتح تطبيق مرتبط بتطبيق أو صفحة ويب
hint

enum (UrlHint)

يشير هذا الحقل إلى تلميح لنوع عنوان URL.

StaticTablePrompt

بطاقة جدول لعرض جدول نصوص

تمثيل YAML 
title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
الحقول
title

string

اختياريّ. تمثّل هذه السمة العنوان العام للجدول. يجب تعيينه في حال ضبط الترجمة.
subtitle

string

اختياريّ. عنوان فرعي للجدول.
image

object (StaticImagePrompt)

اختياريّ. صورة مرتبطة بالجدول
columns[]

object (TableColumn)

اختياريّ. عناوين الأعمدة ومحاذاة الأعمدة
rows[]

object (TableRow)

اختياريّ. بيانات الصف في الجدول يمكن ضمان عرض أول 3 صفوف، ولكن قد يتم اقتصاص الصفوف الأخرى على أسطح معيّنة. يُرجى إجراء الاختبار باستخدام المحاكي لمعرفة الصفوف التي سيتم عرضها لسطح معيَّن. وفي مساحات العرض التي تتيح ميزة WEB_BROWSER، يمكنك توجيه المستخدم إلى صفحة ويب تحتوي على المزيد من البيانات.
button

object (StaticLinkPrompt)

اختياريّ. زرّ

TableColumn

تصف عمودًا في الجدول.

تمثيل YAML 
header: string
align: enum (HorizontalAlignment)
الحقول
header

string

نص عنوان العمود
align

enum (HorizontalAlignment)

محاذاة أفقية لعمود w.r.t المحتوى إذا لم يتم تحديد ذلك، ستتم محاذاة المحتوى مع الحافة الأمامية.

TableRow

تصف صفًا في الجدول.

تمثيل YAML 
cells: 
  - object (TableCell)
divider: boolean
الحقول
cells[]

object (TableCell)

الخلايا في هذا الصف. يتم ضمان عرض أول 3 خلايا، ولكن قد يتم اقتصاص الخلايا الأخرى على أسطح معيّنة. يُرجى الاختبار باستخدام المحاكي لمعرفة الخلايا التي سيتم عرضها على سطح معيَّن.
divider

boolean

يشير إلى ما إذا كان يجب أن يكون هناك مُقسّم بعد كل صف.

TableCell

لوصف خلية على التوالي.

تمثيل YAML 
text: string
الحقول
text

string

المحتوى النصي للخلية.

StaticMediaPrompt

يحتوي على معلومات عن الوسائط، مثل الاسم والوصف وعنوان URL وما إلى ذلك. رقم التعريف التالي: 11

تمثيل YAML 
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
الحقول
mediaType

enum (MediaType)

نوع الوسائط لهذا الردّ.
startOffset

string (Duration format)

إزاحة بدء كائن الوسائط الأول.

مدة بالثواني مكونة من تسعة أرقام كسور كحد أقصى، ويتم إنهاؤها بعبارة "s". مثال: "3.5s"
optionalMediaControls[]

enum (OptionalMediaControls)

أنواع عناصر التحكم الاختيارية في الوسائط التي يمكن أن تدعمها جلسة الاستجابة للوسائط هذه. في حال ضبطها، سيتم تقديم الطلب إلى جهة خارجية عند وقوع حدث معيّن للوسائط. في حال ترك هذه السياسة بدون ضبط، يجب أن يتعامل الطرف الثالث مع نوعَي التحكّم التلقائيَّين، "تم الانتهاء" و"تعذّر الإجراء".
mediaObjects[]

object (MediaObject)

قائمة بكائنات الوسائط.
repeatMode

enum (RepeatMode)

وضع التكرار لقائمة عناصر الوسائط.

MediaObject

يمثل كائن وسائط واحدًا.

تمثيل YAML 
name: string
description: string
url: string
image: 
  object (MediaImage)
الحقول
name

string

اسم كائن الوسائط هذا.
description

string

وصف عنصر الوسائط هذا.
url

string

تمثّل هذه السمة عنوان URL الذي يشير إلى محتوى الوسائط.
image

object (MediaImage)

الصورة التي سيتم عرضها مع بطاقة الوسائط.

MediaImage

الصورة التي سيتم عرضها داخل MediaPrompt

تمثيل YAML 
# Union field image can be only one of the following:
large: 
  object (StaticImagePrompt)
icon: 
  object (StaticImagePrompt)
# End of list of possible types for union field image.
الحقول
حقل الاتحاد image. يُسمح باستخدام نوع واحد فقط من MediaImage. يمكن أن يكون image واحدًا فقط مما يلي:
large

object (StaticImagePrompt)

صورة كبيرة، مثل غلاف الألبوم، وما إلى ذلك
icon

object (StaticImagePrompt)

رمز صورة صغير يتم عرضه على يمين العنوان. ويتم تغيير حجمها إلى 36×36 بكسل مستقل الكثافة.

StaticListPrompt

بطاقة لعرض قائمة بالخيارات للاختيار منها

تمثيل YAML 
title: string
subtitle: string
items: 
  - object (ListItem)
الحقول
title

string

اختياريّ. عنوان القائمة
subtitle

string

اختياريّ. العنوان الفرعي للقائمة.
items[]

object (ListItem)

مطلوب. عناصر القائمة.

ListItem

تمثّل هذه السمة عنصرًا في القائمة.

تمثيل YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
الحقول
key

string

مطلوب. مفتاح NLU الذي يتطابق مع اسم مفتاح الإدخال في النوع المرتبط. عند النقر على العنصر، ستتم إعادة نشر هذا المفتاح كمَعلمة خيار تحديد.
title

string

مطلوب. عنوان السلعة عند النقر على هذا النص، سيتم نشره مرة أخرى على المحادثة حرفيًا كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا من بين مجموعة العناصر.
description

string

اختياريّ. النص الأساسي للعنصر
image

object (StaticImagePrompt)

اختياريّ. صورة العنصر

StaticCollectionPrompt

بطاقة لعرض مجموعة من الخيارات للاختيار منها

تمثيل YAML 
title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)
الحقول
title

string

اختياريّ. تمثّل هذه السمة عنوان المجموعة.
subtitle

string

اختياريّ. العنوان الفرعي للمجموعة.
items[]

object (CollectionItem)

مطلوب. عناصر المجموعة
imageFill

enum (ImageFill)

اختياريّ. خيار عرض نوع الصورة

CollectionItem

تمثّل هذه السمة عنصرًا في المجموعة.

تمثيل YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
الحقول
key

string

مطلوب. مفتاح NLU الذي يتطابق مع اسم مفتاح الإدخال في النوع المرتبط. عند النقر على العنصر، ستتم إعادة نشر هذا المفتاح كمَعلمة خيار تحديد.
title

string

مطلوب. عنوان السلعة عند النقر على هذا النص، سيتم نشره مرة أخرى على المحادثة حرفيًا كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا من بين مجموعة العناصر.
description

string

اختياريّ. النص الأساسي للعنصر
image

object (StaticImagePrompt)

اختياريّ. صورة العنصر

StaticCollectionBrowsePrompt

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

تمثيل YAML 
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
الحقول
items[]

object (CollectionBrowseItem)

العناصر في مجموعة التصفّح يجب أن يكون حجم القائمة في النطاق [2، 10].
imageFill

enum (ImageFill)

خيار عرض الصور للصور في المجموعة.

CollectionBrowseItem

عنصر في المجموعة

تمثيل YAML 
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
الحقول
title

string

مطلوب. عنوان عنصر المجموعة
description

string

تمثّل هذه السمة وصف عنصر المجموعة.
footer

string

نص التذييل لعنصر المجموعة، ويتم عرضه أسفل الوصف. سطر واحد من النص، تم اقتطاعه بعلامة الحذف.
image

object (StaticImagePrompt)

صورة للسلعة في المجموعة
openUriAction

object (OpenUrl)

مطلوب. معرف موارد منتظم (URI) للفتح إذا تم تحديد العنصر.

اقتراح

تمثل شريحة اقتراح، عنصر واجهة مستخدم يظهر للمستخدم لتيسير الأمر.

تمثيل YAML 
title: string
الحقول
title

string

مطلوب. النص المعروض في شريحة الاقتراح عند النقر على هذا النص، سيتم نشره مرة أخرى على المحادثة حرفيًا كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا من بين مجموعة شرائح الاقتراحات. 25 حرفًا بحد أقصى

StaticCanvasPrompt

يمثل هذا النوع رد "لوحة الرسم" التفاعلي الذي سيتم إرساله إلى المستخدم. يمكن استخدامه مع الحقل firstSimple في الطلب الذي يتضمّن الطلب للتحدّث إلى المستخدم بالإضافة إلى عرض ردّ تفاعلي على اللوحة.

تمثيل YAML 
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
الحقول
url

string

مطلوب. عنوان URL لعرض الويب المطلوب تحميله.
data[]

value (Value format)

اختياريّ. يتم تمرير بيانات JSON إلى صفحة الويب للتجربة الشاملة كفعالية. إذا كان الحقل override في الطلب الذي يتضمّن الطلب هو false من قيم البيانات المحدّدة في طلب لوحة الرسم هذا، ستتم إضافة قيم البيانات المحدّدة في طلبات "لوحة الرسم" السابقة.
suppressMic

boolean

اختياريّ. وتعني القيمة الحقيقية أنّه لن يتم فتح الميكروفون لالتقاط الإدخال بعد تقديم هذا الردّ الغامر للمستخدم.
sendStateDataToCanvasApp

boolean

اختياريّ. في حال true، يتم تضمين البيانات الوصفية المتعلقة بالمحادثة وإرسالها إلى تطبيق لوحة الرسم.
enableFullScreen

boolean

اختياريّ. في حال true، شغل تطبيق لوحة الرسم وضع ملء الشاشة ولن يكون له عنوان في أعلى الشاشة. وستظهر أيضًا رسالة إشعار منبثق على شاشة التحميل تتضمّن الاسم المعروض للإجراء واسم المطوّر وتعليمات عن كيفية الخروج منه. القيمة التلقائية: false.
continueTtsDuringTouch

boolean

اختياريّ. إذا كانت القيمة هي true، لن تؤدي نقرات الشاشة إلى إيقاف ميزة "تحويل النص إلى كلام" في جلسة لوحة الرسم بأكملها. القيمة التلقائية: false.