- طلب HTTP
- مَعلمات المسار
- نص الطلب
- نص الاستجابة
- UserInput
- InputType
- DeviceProperties
- سطح المكتب
- الموقع الجغرافي
- LatLng
- الناتج
- لوحة الرسم
- الطلب
- بسيط
- المحتوى
- البطاقة
- الصورة
- ImageFill
- الرابط
- OpenUrl
- UrlHint
- جدول
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- الوسائط
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- التجميع
- CollectionItem
- القائمة
- ListItem
- اقتراح
- بيانات التشخيص
- ExecutionEvent
- ExecutionState
- الخانات
- SlotFillingStatus
- الفتحة
- SlotMode
- SlotStatus
- الحالة
- UserConversationInput
- IntentMatch
- ConditionsEvaluated
- الحالة
- OnSceneEnter
- WebhookRequest
- WebhookResponse
- WebhookInitiatedTransition
- SlotMatch
- SlotRequested
- SlotValidated
- FormFilled
- WaitingForUserInput
- EndConversation
يتم تشغيل جولة واحدة من المحادثة.
طلب HTTP
POST https://actions.googleapis.com/v2/{project=projects/*}:sendInteraction
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
project |
مطلوبة. المشروع الذي يتم اختباره، ويشار إليه برقم تعريف المشروع. التنسيق: مشاريع/{project} |
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON | |
---|---|
{ "input": { object ( |
الحقول | |
---|---|
input |
مطلوبة. المعلومات التي أدخلها المستخدم |
deviceProperties |
مطلوبة. خصائص الجهاز المستخدَم للتفاعل مع الإجراء |
conversationToken |
رمز مميّز غير شفاف يجب تمريره وفقًا للاستلام من SendInteractionResponse في التفاعل السابق ويمكن ترك هذا الخيار بدون ضبط لبدء محادثة جديدة، إما كأول تفاعل في جلسة اختبار أو لمغادرة محادثة سابقة وبدء محادثة جديدة. |
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
رد على جولة من المحادثة.
تمثيل JSON | |
---|---|
{ "output": { object ( |
الحقول | |
---|---|
output |
الناتج الذي يتم تقديمه للمستخدم |
diagnostics |
معلومات بيانات التشخيص التي توضّح كيفية معالجة الطلب |
conversationToken |
رمز مميز غير شفاف ليتم ضبطه على SendInteractionRequest في الطلب التالي لاستدعاء الإجراء عن بُعد من أجل متابعة المحادثة نفسها |
UserInput
البيانات التي أدخلها المستخدم خلال المحادثة
تمثيل JSON | |
---|---|
{
"query": string,
"type": enum ( |
الحقول | |
---|---|
query |
محتوى الإدخال الذي أرسله المستخدم |
type |
نوع الإدخال. |
InputType
تشير هذه السمة إلى مصدر الإدخال أو الطلب المكتوب أو الطلب الصوتي.
عمليات التعداد | |
---|---|
INPUT_TYPE_UNSPECIFIED |
مصدر إدخال غير محدَّد. |
TOUCH |
طلب بحث من تفاعل واجهة المستخدم الرسومية |
VOICE |
طلب صوتي |
KEYBOARD |
طلب بحث مكتوب. |
URL |
تم تشغيل الإجراء من خلال رابط عنوان URL. |
DeviceProperties
خصائص الجهاز ذات الصلة بجولة محادثة.
تمثيل JSON | |
---|---|
{ "surface": enum ( |
الحقول | |
---|---|
surface |
مساحة العرض المستخدَمة للتفاعل مع الإجراء |
location |
الموقع الجغرافي للجهاز، مثل خط العرض وخط الطول والعنوان، |
locale |
اللغة التي تم ضبطها على الجهاز يجب أن يتّبع التنسيق BCP 47: https://tools.ietf.org/html/bcp47 أمثلة: en وen-US وes-419 (مزيد من الأمثلة على https://tools.ietf.org/html/bcp47#appendix-A). |
timeZone |
المنطقة الزمنية التي تم ضبطها على الجهاز. ويجب أن يتبع التنسيق قاعدة بيانات المناطق الزمنية الصادرة عن منظمة IANA (المنظمة المعنية بأرقام الإنترنت المخصصة)، على سبيل المثال: "America/New_York": https://www.iana.org/time-zones |
مساحات العرض
مساحات العرض المحتملة المستخدَمة للتفاعل مع الإجراء قد يتم تضمين قيم إضافية في المستقبل.
عمليات التعداد | |
---|---|
SURFACE_UNSPECIFIED |
القيمة التلقائية. هذه القيمة غير مستخدَمة. |
SPEAKER |
مكبّر صوت (مثل Google Home) |
PHONE |
الهاتف. |
ALLO |
Chat. |
SMART_DISPLAY |
جهاز عرض ذكي. |
KAI_OS |
KaiOS. |
الموقع الجغرافي
حاوية تمثّل موقعًا جغرافيًا.
تمثيل JSON | |
---|---|
{
"coordinates": {
object ( |
الحقول | |
---|---|
coordinates |
الإحداثيات الجغرافية. يتطلب ذلك [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress |
العنوان المعروض، على سبيل المثال "1600 Amphitheatre Pkwy, Mountain View, CA 94043". يتطلب ذلك [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode |
الرمز البريدي يتطلب إذن [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
city |
المدينة يتطلب إذن [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
LatLng
تمثّل هذه السمة كائنًا يمثّل زوجًا من خطوط الطول/العرض. يتم التعبير عن ذلك كزوج من الازدواج لتمثيل درجات خطوط الطول والعرض. يجب أن يتوافق هذا الكائن مع معيار WGS84 ما لم يتم تحديد خلاف ذلك. يجب أن تكون القيم ضمن نطاقات تمت تسويتها.
تمثيل JSON | |
---|---|
{ "latitude": number, "longitude": number } |
الحقول | |
---|---|
latitude |
تمثّل هذه السمة خط العرض بالدرجات. يجب أن يكون ضِمن نطاق [ -90.0 أو +90.0]. |
longitude |
خط الطول بالدرجات. يجب أن يكون ضمن النطاق [-180.0، +180.0]. |
الناتج
نتيجة مرئية للمستخدم في جولة المحادثة
تمثيل JSON | |
---|---|
{ "text": string, "speech": [ string ], "canvas": { object ( |
الحقول | |
---|---|
text |
يتم إرسال الرد الشفهي للمستخدم كسلسلة عادية. |
speech[] |
محتوى الكلام الذي أنتجته مجموعة "الإجراء". قد يشمل ذلك عناصر الترميز مثل SSML. |
canvas |
محتوى "لوحة الرسم" التفاعلي |
actionsBuilderPrompt |
حالة المطالبة في نهاية جولة المحادثة. مزيد من المعلومات حول الطلب: https://developers.google.com/assistant/conversational/prompts |
اللوحة
يُمثِّل ردّ "لوحة الرسم التفاعلية" لإرسالها إلى المستخدِم. ويمكن استخدامه إلى جانب الحقل "firstSimple" في الطلب الذي يتضمن للتحدث إلى المستخدم بالإضافة إلى عرض استجابة لوحة رسم تفاعلية. الحد الأقصى لحجم الاستجابة هو 50 كيلو بايت.
تمثيل JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "enableFullScreen": boolean } |
الحقول | |
---|---|
url |
عنوان URL لتطبيق الويب التفاعلي للوحة الرسم الذي تريد تحميله. إذا لم يتم ضبط السياسة، ستتم إعادة استخدام عنوان URL من لوحة الرسم النشطة الحالية. |
data[] |
اختياريّ. بيانات JSON التي يتم تمريرها إلى صفحة الويب الخاصة بالتجربة الشاملة على أنّها فعالية إذا كان الحقل "إلغاء" في الطلب الذي يتضمّن تلك اللوحة هو "خطأ"، ستتم إضافة قيم البيانات المحدّدة في هذا الطلب بعد قيم البيانات المحدّدة في طلبات لوحة الرسم السابقة. |
suppressMic |
اختياريّ. القيمة التلقائية: خطأ. |
enableFullScreen |
إذا كان |
سؤال
تمثيل رد لمستخدم.
تمثيل JSON | |
---|---|
{ "append": boolean, "override": boolean, "firstSimple": { object ( |
الحقول | |
---|---|
append |
اختياريّ. وضع لكيفية دمج هذه الرسائل مع الرسائل المحددة مسبقًا ستؤدي القيمة "خطأ" إلى محو جميع الرسائل المحددة مسبقًا (الأولى والأخيرة، رابط المحتوى، ورابط الاقتراحات، ولوحة الرسم) وإضافة الرسائل المحددة في هذا الطلب. سيؤدي الخيار "true" إلى إضافة الرسائل المحددة في هذا الطلب إلى الرسائل التي تم تحديدها في الردود السابقة. يؤدي ضبط هذا الحقل على "صحيح" أيضًا إلى تفعيل الإضافة إلى بعض الحقول داخل "المطالبات البسيطة" ومطالبة "الاقتراح" ومطالبة "لوحة الرسم" (جزء من مطالبة المحتوى). سيتم دائمًا استبدال رسائل المحتوى والرابط إذا تم تحديدها في الطلب. والقيمة التلقائية هي "خطأ". |
override |
اختياريّ. وضع لكيفية دمج هذه الرسائل مع الرسائل المحددة مسبقًا يؤدي تحديد الخيار "true" إلى محو جميع الرسائل المحددة مسبقًا (الأولى والأخير، ورابط المحتوى ورابط الاقتراحات، ولوحة الرسم) وإضافة الرسائل المحددة في هذا الطلب. تضيف القيمة "خطأ" الرسائل المحددة في هذا الطلب إلى الرسائل المحددة في الردود السابقة. يؤدي ترك هذا الحقل على "خطأ" أيضًا إلى تفعيل إمكانية إلحاق بعض الحقول داخل "المطالبات البسيطة" ومطالبة "الاقتراحات" ومطالبة "لوحة الرسم" (جزء من مطالبة المحتوى). يتم دائمًا استبدال رسائل المحتوى والرابط إذا تم تحديدها في الطلب. والقيمة التلقائية هي "خطأ". |
firstSimple |
اختياريّ. الاستجابة الأولى بالصوت والنص فقط. |
content |
اختياريّ. محتوى مثل بطاقة أو قائمة أو وسائط يتم عرضها للمستخدم. |
lastSimple |
اختياريّ. الرد الأخير بالصوت والنص فقط. |
suggestions[] |
اختياريّ. الاقتراحات التي يتم عرضها للمستخدم والتي ستظهر دائمًا في نهاية الرد. إذا كان الحقل "إلغاء" في الطلب الذي يتضمّن عبارة "خطأ"، ستتم إضافة العناوين المحدّدة في هذا الحقل إلى العناوين المحدّدة في أي طلبات مقترَحة تم تحديدها سابقًا، وستتم إزالة القيم المكرّرة. |
link |
اختياريّ. شريحة اقتراحات إضافية يمكنها توفير رابط إلى التطبيق أو الموقع الإلكتروني المرتبطَين سيتم عرض الشريحة بعنوان "فتح |
canvas |
اختياريّ. يُمثِّل استجابة "لوحة الرسم التفاعلية" التي سيتم إرسالها إلى المستخدم. |
بسيط
يمثِّل طلبًا بسيطًا لإرساله إلى أحد المستخدمين.
تمثيل JSON | |
---|---|
{ "speech": string, "text": string } |
الحقول | |
---|---|
speech |
اختياريّ. تمثِّل الكلام الذي سيتم قوله إلى المستخدم. يمكن أن يكون تنسيق SSML أو نص إلى كلام. إذا كان الحقل "إلغاء" في الطلب الذي يتضمّن النص "صحيحًا"، سيحلّ الخطاب المحدّد في هذا الحقل محلّ الكلام السابق لـ "الطلب البسيط". |
text |
نص اختياري يتم عرضه في فقاعة المحادثة. في حال عدم توفيره، سيتم عرض حقل الكلام أعلاه. تقتصر على 640 حرفًا. إذا كان الحقل "إلغاء" في الطلب الذي يتضمّن الطلب هو "صحيح"، يتم استبدال النص المحدّد في هذا الحقل بنص "الطلب البسيط" السابق. |
المحتوى
المحتوى الذي سيتم عرضه.
تمثيل JSON | |
---|---|
{ // Union field |
الحقول | ||
---|---|---|
حقل الاتحاد content المحتوى. يمكن أن تكون السمة "content " واحدة فقط مما يلي: |
||
card |
بطاقة أساسية. |
|
image |
صورة. |
|
table |
بطاقة جدول. |
|
media |
استجابة تشير إلى مجموعة من الوسائط التي سيتم تشغيلها. |
|
canvas |
ردّ يمكن استخدامه لتجربة لوحة تفاعلية. |
|
collection |
بطاقة تعرِض مجموعة من الخيارات للاختيار من بينها. |
|
list |
بطاقة تعرِض قائمة بالخيارات التي يمكنك الاختيار من بينها. |
بطاقة
بطاقة أساسية لعرض بعض المعلومات، مثل صورة و/أو نص.
تمثيل JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
الحقول | |
---|---|
title |
العنوان العام للبطاقة. اختياريّ. |
subtitle |
اختياريّ. |
text |
النص الأساسي للبطاقة. تدعم مجموعة محدودة من بنية markdown للتنسيق. مطلوبة ما لم تكن الصورة متوفّرة. |
image |
صورة الجزء الرئيسي للبطاقة. ويتم تثبيت الارتفاع على 192 بكسل مستقل الكثافة. اختياريّ. |
imageFill |
كيفية ملء خلفية الصورة اختياريّ. |
button |
زرّ اختياريّ. |
صورة
صورة معروضة في البطاقة.
تمثيل JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
الحقول | |
---|---|
url |
عنوان URL المصدر للصورة ويمكن أن تكون الصور بتنسيق JPG وPNG وGIF (الرسوم المتحركة وغير المتحركة). مثلاً، |
alt |
وصف نصي للصورة الذي سيتم استخدامه لتسهيل الاستخدام، مثل برامج قراءة الشاشة. مطلوبة. |
height |
ارتفاع الصورة بالبكسل. اختياريّ. |
width |
عرض الصورة بالبكسل. اختياريّ. |
ImageFill
خيارات عرض الصورة الممكنة للتأثير في عرض الصورة. يجب استخدام هذا الخيار عندما لا تتطابق نسبة العرض إلى الارتفاع للصورة مع نسبة العرض إلى الارتفاع لحاوية الصورة.
عمليات التعداد | |
---|---|
UNSPECIFIED |
تعبئة غير محدّدة للصورة. |
GRAY |
املأ الفجوات بين الصورة وحاوية الصورة بأشرطة رمادية. |
WHITE |
املأ الفجوات بين الصورة وحاوية الصورة باستخدام أشرطة بيضاء. |
CROPPED |
يتم تغيير حجم الصورة بحيث يتطابق عرض الصورة وارتفاعها مع أبعاد الحاوية أو يتجاوزها. قد يؤدي ذلك إلى اقتصاص الجزء العلوي والسفلي من الصورة إذا كان ارتفاع الصورة التي تم تغيير حجمها أكبر من ارتفاع الحاوية، أو اقتصاص الجزء الأيسر والأيمن من الصورة إذا كان عرض الصورة التي تم تغيير حجمها أكبر من عرض الحاوية. يشبه هذا "وضع التكبير/التصغير" على تلفزيون بشاشة عريضة عند تشغيل فيديو بنسبة عرض إلى ارتفاع 4:3. |
رابط
ربط المحتوى
تمثيل JSON | |
---|---|
{
"name": string,
"open": {
object ( |
الحقول | |
---|---|
name |
اسم الرابط |
open |
ما يحدث عندما يفتح المستخدِم الرابط |
OpenUrl
الإجراء الذي يتم اتخاذه عندما يفتح المستخدم رابطًا.
تمثيل JSON | |
---|---|
{
"url": string,
"hint": enum ( |
الحقول | |
---|---|
url |
حقل عنوان URL الذي يمكن أن يكون أيًا مما يلي: - عناوين URL التي تستخدم http/https لفتح تطبيق مرتبط بتطبيق أو صفحة ويب |
hint |
تشير هذه السمة إلى نوع عنوان URL. |
UrlHint
أنواع مختلفة من تلميحات عناوين URL.
عمليات التعداد | |
---|---|
LINK_UNSPECIFIED |
غير محدّدة |
AMP |
عنوان URL يشير مباشرةً إلى محتوى AMP أو إلى عنوان URL أساسي يشير إلى محتوى AMP عبر . |
جدول
بطاقة جدول لعرض جدول نصوص.
تمثيل 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 العمود وإذا لم يتم تحديده، ستتم محاذاة المحتوى مع الحافة البادئة. |
HorizontalAlignment
محاذاة المحتوى داخل الخلية.
عمليات التعداد | |
---|---|
UNSPECIFIED |
محاذاة أفقية غير محددة. |
LEADING |
الحافة البادئة للخلية. وهذا هو الخيار التلقائي. |
CENTER |
تتم محاذاة المحتوى مع وسط العمود. |
TRAILING |
تتم محاذاة المحتوى مع حافة العمود. |
TableRow
تصف صفًا في الجدول.
تمثيل JSON | |
---|---|
{
"cells": [
{
object ( |
الحقول | |
---|---|
cells[] |
الخلايا في هذا الصف. نضمن ظهور أول 3 خلايا، ولكن قد يتم قص الخلايا الأخرى على أسطح معينة. يُرجى الاختبار باستخدام المحاكي لمعرفة الخلايا التي سيتم عرضها لسطح معين. |
divider |
يشير إلى ما إذا كان يجب وجود مُقسّم بعد كل صف. |
TableCell
لوصف خلية في صف واحد.
تمثيل JSON | |
---|---|
{ "text": string } |
الحقول | |
---|---|
text |
المحتوى النصي للخلية. |
الوسائط
ويمثل عنصر وسائط واحدًا. يحتوي على معلومات عن الوسائط، مثل الاسم والوصف وعنوان URL وما إلى ذلك.
تمثيل JSON | |
---|---|
{ "mediaType": enum ( |
الحقول | |
---|---|
mediaType |
نوع الوسائط |
startOffset |
بدء إزاحة كائن الوسائط الأول مدة بالثواني مؤلفة من تسعة أرقام كسور كحد أقصى، وتم إنهاؤها بـ " |
optionalMediaControls[] |
أنواع عناصر تحكّم اختيارية في الوسائط يمكن أن توفّرها جلسة الاستجابة للوسائط هذه. وفي حال ضبط هذه السياسة، سيتم إرسال الطلب إلى 3p عند وقوع حدث معيّن على الوسائط. إذا لم يتم ضبط السياسة، يجب أن تعالج جهة 3p نوعَي التحكّم التلقائيَّين، وهما "تم الانتهاء" و"تعذّر التحقق". |
mediaObjects[] |
قائمة كائنات الوسائط |
MediaType
نوع الوسائط لهذا الرد
عمليات التعداد | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
نوع الوسائط غير محدَّد. |
AUDIO |
ملف صوتي |
MEDIA_STATUS_ACK |
ردّ للإقرار بتقرير حالة الوسائط |
OptionalMediaControls
أنواع التحكّم في الوسائط الاختيارية التي يمكن الاستجابة لها في الوسائط
عمليات التعداد | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
قيمة غير محدّدة |
PAUSED |
حدث متوقف مؤقتًا. يتم تشغيله عندما يوقِف المستخدم الوسائط مؤقتًا. |
STOPPED |
تم إيقاف الحدث. يتم تشغيله عندما يخرج المستخدم من جلسة 3p أثناء تشغيل الوسائط. |
MediaObject
يمثل عنصر وسائط واحدًا
تمثيل JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
الحقول | |
---|---|
name |
اسم عنصر الوسائط هذا |
description |
وصف عنصر الوسائط هذا. |
url |
تمثّل هذه السمة عنوان URL الذي يشير إلى محتوى الوسائط. |
image |
الصورة التي سيتم عرضها مع بطاقة الوسائط. |
MediaImage
الصورة التي سيتم عرضها مع بطاقة الوسائط.
تمثيل JSON | |
---|---|
{ // Union field |
الحقول | ||
---|---|---|
حقل الاتحاد image صورة: يمكن أن تكون السمة "image " واحدة فقط مما يلي: |
||
large |
صورة كبيرة، مثل غلاف الألبوم وما إلى ذلك |
|
icon |
رمز صورة صغير معروض على يسار العنوان يتم تغيير حجمه إلى 36x36 بكسل مستقل الكثافة. |
المجموعة
بطاقة لمشاركة عرض مجموعة من الخيارات التي يمكنك الاختيار من بينها.
تمثيل JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
الحقول | |
---|---|
title |
عنوان المجموعة اختياريّ. |
subtitle |
العنوان الفرعي للمجموعة. اختياريّ. |
items[] |
الحد الأدنى: 2 الحد الأقصى: 10 |
imageFill |
كيفية ملء خلفيات الصورة لعناصر المجموعة اختياريّ. |
CollectionItem
عنصر في المجموعة
تمثيل JSON | |
---|---|
{ "key": string } |
الحقول | |
---|---|
key |
مطلوبة. مفتاح NLU الذي يطابق اسم مفتاح الإدخال في النوع المرتبط به. |
قائمة
بطاقة لمشاركة عرض قائمة خيارات للاختيار من بينها.
تمثيل JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
الحقول | |
---|---|
title |
عنوان القائمة اختياريّ. |
subtitle |
العنوان الفرعي للقائمة. اختياريّ. |
items[] |
الحد الأدنى: 2 الحد الأقصى: 30 |
ListItem
عنصر في القائمة
تمثيل JSON | |
---|---|
{ "key": string } |
الحقول | |
---|---|
key |
مطلوبة. مفتاح NLU الذي يطابق اسم مفتاح الإدخال في النوع المرتبط به. |
الاقتراح
إدخال اقتراح يتم تقديمه للمستخدم
تمثيل JSON | |
---|---|
{ "title": string } |
الحقول | |
---|---|
title |
مطلوبة. النص المعروض في شريحة الاقتراح. عند النقر على هذا النص، سيتم مشاركته مرة أخرى في المحادثة كما لو كان المستخدم قد كتبه. يجب أن يكون كل عنوان فريدًا بين مجموعة شرائح الاقتراحات. 25 حرفًا بحد أقصى |
بيانات التشخيص
معلومات التشخيص ذات الصلة بجولة المحادثة.
تمثيل JSON | |
---|---|
{
"actionsBuilderEvents": [
{
object ( |
الحقول | |
---|---|
actionsBuilderEvents[] |
قائمة بالأحداث التي تتضمّن تفاصيل عن معالجة جولة المحادثة من خلال مراحل نموذج تفاعل "أداة إنشاء الإجراءات". تتم تعبئة هذا الحقل لتطبيقَي "أداة إنشاء المهام" و"SDK للإجراءات" فقط. |
ExecutionEvent
تحتوي على معلومات عن حدث التنفيذ الذي حدث أثناء معالجة طلب محادثة "أداة إنشاء الإجراءات". لإلقاء نظرة عامة على المراحل التي يتضمّنها طلب المحادثة، يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/actions.
تمثيل JSON | |
---|---|
{ "eventTime": string, "executionState": { object ( |
الحقول | ||
---|---|---|
eventTime |
الطابع الزمني لوقت وقوع الحدث طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
|
executionState |
حالة التنفيذ أثناء هذا الحدث. |
|
status |
الحالة الناتجة لخطوة تنفيذ معينة. |
|
warningMessages[] |
قائمة التحذيرات التي ظهرت أثناء تنفيذ هذا الحدث التحذيرات هي نصائح اكتشفها مطوِّر البرامج أثناء طلب المحادثة. وعادةً ما تكون هذه المشاكل غير بالغة الأهمية ولا تؤدي إلى إيقاف تنفيذ الطلب. على سبيل المثال، قد يتم إنشاء تحذيرات عندما يحاول الردّ التلقائي على الويب إلغاء نوع مخصّص غير متوفر. يتم الإبلاغ عن الأخطاء كرمز حالة "تعذّر التحقق"، ولكن يمكن أن تظهر التحذيرات حتى عندما تكون الحالة على ما يرام. |
|
حقل الاتحاد EventData معلومات تفصيلية خاصة بمختلف الأحداث التي يمكن أن تشارك في معالجة جولة من المحادثة. يحدّد الحقل المحدَّد هنا نوع هذا الحدث. يمكن أن تكون السمة "EventData " واحدة فقط مما يلي: |
||
userInput |
حدث معالجة البيانات التي أدخلها المستخدم |
|
intentMatch |
حدث مطابقة النية |
|
conditionsEvaluated |
حدث تقييم الحالة |
|
onSceneEnter |
حدث تنفيذ OnSceneEnter |
|
webhookRequest |
حدث إرسال طلب الردّ التلقائي على الويب. |
|
webhookResponse |
حدث استلام الردّ التلقائي على الويب. |
|
webhookInitiatedTransition |
حدث نقل تم بدء الردّ التلقائي على الويب. |
|
slotMatch |
حدث مطابقة الخانة |
|
slotRequested |
حدث طلب الشريحة |
|
slotValidated |
حدث التحقّق من الخانة |
|
formFilled |
حدث ملء نموذج |
|
waitingUserInput |
في انتظار حدث إدخال المستخدم |
|
endConversation |
حدث نهاية المحادثة. |
ExecutionState
الحالة الحالية لعملية التنفيذ
تمثيل JSON | |
---|---|
{ "currentSceneId": string, "sessionStorage": { object }, "slots": { object ( |
الحقول | |
---|---|
currentSceneId |
رقم تعريف المشهد النشط حاليًا. |
sessionStorage |
حالة مساحة تخزين الجلسة: https://developers.google.com/assistant/conversational/storage-session |
slots |
حالة ملء الخانات، إن أمكن: https://developers.google.com/assistant/conversational/scenes#slot_filling |
promptQueue[] |
قائمة انتظار الطلبات: https://developers.google.com/assistant/conversational/prompts |
userStorage |
حالة مساحة تخزين المستخدم: https://developers.google.com/assistant/conversational/storage-user |
householdStorage |
حالة مساحة التخزين المنزلية: https://developers.google.com/assistant/conversational/storage-home |
ألعاب المقامرة
تُمثِّل الحالة الحالية لخانات المشهد.
تمثيل JSON | |
---|---|
{ "status": enum ( |
الحقول | |
---|---|
status |
الحالة الحالية لملء الخانة. |
slots |
الخانات المرتبطة بالمشهد الحالي. عنصر يحتوي على قائمة من أزواج |
SlotFillingStatus
تُمثِّل هذه السمة الحالة الحالية لملء الخانة.
عمليات التعداد | |
---|---|
UNSPECIFIED |
القيمة الاحتياطية عند عدم تعبئة حقل الاستخدام. |
INITIALIZED |
تم إعداد الخانات ولكن لم يبدأ ملء الخانات. |
COLLECTING |
يجري جمع قيم الخانات. |
FINAL |
جميع قيم الخانات نهائية ولا يمكن تغييرها. |
الحيز
يمثّل هذا النوع خانة.
تمثيل JSON | |
---|---|
{ "mode": enum ( |
الحقول | |
---|---|
mode |
وضع الخانة (مطلوب أو اختياري). يمكن ضبطه من قِبل مطوّر البرامج. |
status |
حالة الخانة. |
value |
قيمة الخانة. سيؤدي تغيير هذه القيمة في الاستجابة إلى تعديل القيمة في تعبئة الخانة. |
updated |
يشير إلى ما إذا كان قد تم جمع قيمة الخانة عند المنعطف الأخير. هذا الحقل للقراءة فقط. |
prompt |
اختياريّ. يتم إرسال هذه المطالبة إلى المستخدم عند الحاجة لملء خانة مطلوبة. تلغي هذه المطالبة الطلب الحالي المحدّد في وحدة التحكّم. لم يتم تضمين هذا الحقل في طلب الرد التلقائي على الويب. |
SlotMode
تمثّل هذه السمة وضع الخانة، أي ما إذا كانت مطلوبة أم لا.
عمليات التعداد | |
---|---|
MODE_UNSPECIFIED |
القيمة الاحتياطية عند عدم تعبئة حقل الاستخدام. |
OPTIONAL |
تشير هذه السمة إلى أنّ هذه الفتحة غير مطلوبة لإكمال ملء الخانة. |
REQUIRED |
تشير هذه السمة إلى أنّ المساحة مطلوبة لإكمال ملء الخانة. |
SlotStatus
تُمثِّل هذه السمة حالة الخانة.
عمليات التعداد | |
---|---|
SLOT_UNSPECIFIED |
القيمة الاحتياطية عند عدم تعبئة حقل الاستخدام. |
EMPTY |
يشير إلى عدم احتواء الخانة على أي قيم. لا يمكن تعديل هذه الحالة من خلال الردّ. |
INVALID |
يشير إلى أن قيمة الخانة غير صالحة. ويمكن تحديد هذه الحالة من خلال الردّ. |
FILLED |
يشير إلى أن الخانة تتضمن قيمة. لا يمكن تعديل هذه الحالة من خلال الردّ. |
الحالة
يحدد النوع Status
نموذج خطأ منطقي مناسب لبيئات البرمجة المختلفة، بما في ذلك واجهات برمجة تطبيقات REST وواجهات برمجة التطبيقات RPC. ويتم استخدامه من قِبل gRPC. تحتوي كل رسالة Status
على ثلاث أجزاء من البيانات: رمز الخطأ ورسالة الخطأ وتفاصيل الخطأ.
يمكنك معرفة المزيد حول نموذج الخطأ هذا وكيفية التعامل معه في دليل تصميم واجهة برمجة التطبيقات.
تمثيل JSON | |
---|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
الحقول | |
---|---|
code |
رمز الحالة، الذي يجب أن يكون قيمة تعداد |
message |
رسالة خطأ موجّهة للمطوّر، ويجب أن تكون باللغة الإنجليزية. يجب ترجمة أي رسالة خطأ تظهر للمستخدمين وإرسالها في حقل |
details[] |
قائمة بالرسائل التي تتضمن تفاصيل الخطأ. هناك مجموعة شائعة من أنواع الرسائل التي يمكن أن تستخدمها واجهات برمجة التطبيقات. كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي |
UserConversationInput
تمثّل هذه السمة المعلومات المتعلقة بإدخال المستخدم.
تمثيل JSON | |
---|---|
{ "type": string, "originalQuery": string } |
الحقول | |
---|---|
type |
نوع البيانات التي أدخلها المستخدم مثلاً لوحة المفاتيح والصوت واللمس وما إلى ذلك |
originalQuery |
تم إدخال النص الأصلي من المستخدم. |
IntentMatch
معلومات حول مطابقة النية بالشراء (شاملة أو داخل مشهد): https://developers.google.com/assistant/conversational/intents
تمثيل JSON | |
---|---|
{
"intentId": string,
"intentParameters": {
string: {
object ( |
الحقول | |
---|---|
intentId |
رقم تعريف الهدف الذي أدّى إلى هذا التفاعل. |
intentParameters |
معلّمات النية التي أدّت إلى هذا التفاعل. عنصر يحتوي على قائمة من أزواج |
handler |
اسم المعالج المرتبط بهذا التفاعل. |
nextSceneId |
المشهد الذي يؤدي إليه هذا التفاعل. |
ConditionsEvaluated
تقييم نتائج الشروط: https://developers.google.com/assistant/conversational/scenes#conditions
تمثيل JSON | |
---|---|
{ "failedConditions": [ { object ( |
الحقول | |
---|---|
failedConditions[] |
قائمة الشروط التي تم تقييمها إلى "خطأ". |
successCondition |
الشرط الأول الذي تم تقييمه إلى "true"، إن وجد. |
الشرط
شرط تم تقييمه.
تمثيل JSON | |
---|---|
{ "expression": string, "handler": string, "nextSceneId": string } |
الحقول | |
---|---|
expression |
التعبير المحدد في هذا الشرط. |
handler |
اسم المعالج المحدّد في الشرط الذي تم تقييمه. |
nextSceneId |
مشهد الوجهة محدد في شرط تم تقييمه. |
OnSceneEnter
معلومات عن تنفيذ مرحلة onSceneEnter: https://developers.google.com/assistant/conversational/scenes#onEnter
تمثيل JSON | |
---|---|
{ "handler": string } |
الحقول | |
---|---|
handler |
اسم المعالج المحدّد في حدث onSceneEnter. |
WebhookRequest
معلومات عن طلب تم إرساله إلى الرد التلقائي على الويب للإجراء: https://developers.google.com/assistant/conversational/webhooks#payloads
تمثيل JSON | |
---|---|
{ "requestJson": string } |
الحقول | |
---|---|
requestJson |
حمولة طلب الرد التلقائي على الويب. |
WebhookResponse
معلومات عن ردّ تم تلقّيه من الردّ التلقائي على الويب للإجراء: https://developers.google.com/assistant/conversational/webhooks#payloads
تمثيل JSON | |
---|---|
{ "responseJson": string } |
الحقول | |
---|---|
responseJson |
حمولة استجابة الرد التلقائي على الويب. |
WebhookInitiatedTransition
الحدث الذي تم تشغيله من خلال مشهد الوجهة المعروض من الردّ التلقائي على الويب: https://developers.google.com/assistant/conversational/webhooks#transition_scenes
تمثيل JSON | |
---|---|
{ "nextSceneId": string } |
الحقول | |
---|---|
nextSceneId |
رقم تعريف المشهد الذي يؤدي الانتقال إليه. |
SlotMatch
معلومات عن الخانات المطابقة: https://developers.google.com/assistant/conversational/scenes#slot_filling
تمثيل JSON | |
---|---|
{
"nluParameters": {
string: {
object ( |
الحقول | |
---|---|
nluParameters |
المعلَمات المستخرجة من NLU من البيانات التي أدخلها المستخدم عنصر يحتوي على قائمة من أزواج |
SlotRequested
معلومات عن الخانة المطلوبة حاليًا: https://developers.google.com/assistant/conversational/scenes#slot_filling
تمثيل JSON | |
---|---|
{
"slot": string,
"prompt": {
object ( |
الحقول | |
---|---|
slot |
اسم الخانة المطلوبة. |
prompt |
رسالة مطالبة الفتحة |
SlotValidated
الحدث الذي يحدث بعد الانتهاء من التحقّق من الردّ التلقائي على الويب للخانات: https://developers.google.com/assistant/conversational/scenes#slot_filling
FormFilled
الحدث الذي يحدث عند ملء النموذج بالكامل: https://developers.google.com/assistant/conversational/scenes#slot_filling
WaitingForUserInput
الحدث الذي يحدث عندما يحتاج النظام إلى البيانات التي أدخلها المستخدم: https://developers.google.com/assistant/conversational/scenes#input
EndConversation
تم إنهاء الحدث الذي يتم إعلامه بأنّ المحادثة مع موظّف الدعم قد تم إنهاؤها.