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 أو نص إلى كلام. سيتم إلحاق الكلام تلقائيًا بالكلام الخاص بـ Simple Speak. إذا كان الحقل 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 بكسل مستقل الكثافة.

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 الذي يمكن أن يكون أيًا مما يلي: - عناوين URL التي تستخدم http/https لفتح تطبيق مرتبط بتطبيق أو صفحة ويب

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)

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

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)

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

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

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