Method: projects.sendInteraction

يتم تشغيل جولة واحدة من المحادثة.

طلب HTTP

POST https://actions.googleapis.com/v2/{project=projects/*}:sendInteraction

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
project

string

مطلوبة. المشروع الذي يتم اختباره، ويشار إليه برقم تعريف المشروع. التنسيق: مشاريع/{project}

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "input": {
    object (UserInput)
  },
  "deviceProperties": {
    object (DeviceProperties)
  },
  "conversationToken": string
}
الحقول
input

object (UserInput)

مطلوبة. المعلومات التي أدخلها المستخدم
deviceProperties

object (DeviceProperties)

مطلوبة. خصائص الجهاز المستخدَم للتفاعل مع الإجراء
conversationToken

string

رمز مميّز غير شفاف يجب تمريره وفقًا للاستلام من SendInteractionResponse في التفاعل السابق ويمكن ترك هذا الخيار بدون ضبط لبدء محادثة جديدة، إما كأول تفاعل في جلسة اختبار أو لمغادرة محادثة سابقة وبدء محادثة جديدة.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

رد على جولة من المحادثة.

تمثيل JSON 
{
  "output": {
    object (Output)
  },
  "diagnostics": {
    object (Diagnostics)
  },
  "conversationToken": string
}
الحقول
output

object (Output)

الناتج الذي يتم تقديمه للمستخدم
diagnostics

object (Diagnostics)

معلومات بيانات التشخيص التي توضّح كيفية معالجة الطلب
conversationToken

string

رمز مميز غير شفاف ليتم ضبطه على SendInteractionRequest في الطلب التالي لاستدعاء الإجراء عن بُعد من أجل متابعة المحادثة نفسها

UserInput

البيانات التي أدخلها المستخدم خلال المحادثة

تمثيل JSON 
{
  "query": string,
  "type": enum (InputType)
}
الحقول
query

string

محتوى الإدخال الذي أرسله المستخدم
type

enum (InputType)

نوع الإدخال.

InputType

تشير هذه السمة إلى مصدر الإدخال أو الطلب المكتوب أو الطلب الصوتي.

عمليات التعداد
INPUT_TYPE_UNSPECIFIED مصدر إدخال غير محدَّد.
TOUCH طلب بحث من تفاعل واجهة المستخدم الرسومية
VOICE طلب صوتي
KEYBOARD طلب بحث مكتوب.
URL تم تشغيل الإجراء من خلال رابط عنوان URL.

DeviceProperties

خصائص الجهاز ذات الصلة بجولة محادثة.

تمثيل JSON 
{
  "surface": enum (Surface),
  "location": {
    object (Location)
  },
  "locale": string,
  "timeZone": string
}
الحقول
surface

enum (Surface)

مساحة العرض المستخدَمة للتفاعل مع الإجراء
location

object (Location)

الموقع الجغرافي للجهاز، مثل خط العرض وخط الطول والعنوان،
locale

string

اللغة التي تم ضبطها على الجهاز يجب أن يتّبع التنسيق BCP 47: https://tools.ietf.org/html/bcp47 أمثلة: en وen-US وes-419 (مزيد من الأمثلة على https://tools.ietf.org/html/bcp47#appendix-A).
timeZone

string

المنطقة الزمنية التي تم ضبطها على الجهاز. ويجب أن يتبع التنسيق قاعدة بيانات المناطق الزمنية الصادرة عن منظمة 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 (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string
}
الحقول
coordinates

object (LatLng)

الإحداثيات الجغرافية. يتطلب ذلك [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

formattedAddress

string

العنوان المعروض، على سبيل المثال "1600 Amphitheatre Pkwy, Mountain View, CA 94043". يتطلب ذلك [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

zipCode

string

الرمز البريدي يتطلب إذن [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] أو [DEVICE_COARSE_LOCATION] إذن [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].
city

string

المدينة يتطلب إذن [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

number

تمثّل هذه السمة خط العرض بالدرجات. يجب أن يكون ضِمن نطاق [ -90.0 أو +90.0].
longitude

number

خط الطول بالدرجات. يجب أن يكون ضمن النطاق [-180.0، +180.0].

الناتج

نتيجة مرئية للمستخدم في جولة المحادثة

تمثيل JSON 
{
  "text": string,
  "speech": [
    string
  ],
  "canvas": {
    object (Canvas)
  },
  "actionsBuilderPrompt": {
    object (Prompt)
  }
}
الحقول
text

string

يتم إرسال الرد الشفهي للمستخدم كسلسلة عادية.
speech[]

string

محتوى الكلام الذي أنتجته مجموعة "الإجراء". قد يشمل ذلك عناصر الترميز مثل SSML.
canvas

object (Canvas)

محتوى "لوحة الرسم" التفاعلي
actionsBuilderPrompt

object (Prompt)

حالة المطالبة في نهاية جولة المحادثة. مزيد من المعلومات حول الطلب: https://developers.google.com/assistant/conversational/prompts

اللوحة

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

تمثيل JSON 
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "enableFullScreen": boolean
}
الحقول
url

string

عنوان URL لتطبيق الويب التفاعلي للوحة الرسم الذي تريد تحميله. إذا لم يتم ضبط السياسة، ستتم إعادة استخدام عنوان URL من لوحة الرسم النشطة الحالية.
data[]

value (Value format)

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

boolean

اختياريّ. القيمة التلقائية: خطأ.
enableFullScreen

boolean

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

سؤال

تمثيل رد لمستخدم.

تمثيل JSON 
{
  "append": boolean,
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  }
}
الحقول
append
(deprecated)

boolean

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

boolean

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

object (Simple)

اختياريّ. الاستجابة الأولى بالصوت والنص فقط.
content

object (Content)

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

object (Simple)

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

object (Suggestion)

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

object (Canvas)

اختياريّ. يُمثِّل استجابة "لوحة الرسم التفاعلية" التي سيتم إرسالها إلى المستخدم.

بسيط

يمثِّل طلبًا بسيطًا لإرساله إلى أحد المستخدمين.

تمثيل JSON 
{
  "speech": string,
  "text": string
}
الحقول
speech

string

اختياريّ. تمثِّل الكلام الذي سيتم قوله إلى المستخدم. يمكن أن يكون تنسيق SSML أو نص إلى كلام. إذا كان الحقل "إلغاء" في الطلب الذي يتضمّن النص "صحيحًا"، سيحلّ الخطاب المحدّد في هذا الحقل محلّ الكلام السابق لـ "الطلب البسيط".
text

string

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

المحتوى

المحتوى الذي سيتم عرضه.

تمثيل JSON 
{

  // Union field content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "canvas": {
    object (Canvas)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  }
  // End of list of possible types for union field content.
}
الحقول
حقل الاتحاد content المحتوى. يمكن أن تكون السمة "content" واحدة فقط مما يلي:
card

object (Card)

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

object (Image)

صورة.
table

object (Table)

بطاقة جدول.
media

object (Media)

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

object (Canvas)

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

object (Collection)

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

object (List)

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

بطاقة

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

تمثيل JSON 
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
الحقول
title

string

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

string

اختياريّ.
text

string

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

object (Image)

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

enum (ImageFill)

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

object (Link)

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

صورة

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

تمثيل JSON 
{
  "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

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

ImageFill

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

عمليات التعداد
UNSPECIFIED تعبئة غير محدّدة للصورة.
GRAY املأ الفجوات بين الصورة وحاوية الصورة بأشرطة رمادية.
WHITE املأ الفجوات بين الصورة وحاوية الصورة باستخدام أشرطة بيضاء.
CROPPED يتم تغيير حجم الصورة بحيث يتطابق عرض الصورة وارتفاعها مع أبعاد الحاوية أو يتجاوزها. قد يؤدي ذلك إلى اقتصاص الجزء العلوي والسفلي من الصورة إذا كان ارتفاع الصورة التي تم تغيير حجمها أكبر من ارتفاع الحاوية، أو اقتصاص الجزء الأيسر والأيمن من الصورة إذا كان عرض الصورة التي تم تغيير حجمها أكبر من عرض الحاوية. يشبه هذا "وضع التكبير/التصغير" على تلفزيون بشاشة عريضة عند تشغيل فيديو بنسبة عرض إلى ارتفاع 4:3.

OpenUrl

الإجراء الذي يتم اتخاذه عندما يفتح المستخدم رابطًا.

تمثيل JSON 
{
  "url": string,
  "hint": enum (UrlHint)
}
الحقول
url

string

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

enum (UrlHint)

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

UrlHint

أنواع مختلفة من تلميحات عناوين URL.

عمليات التعداد
AMP عنوان URL يشير مباشرةً إلى محتوى AMP أو إلى عنوان URL أساسي يشير إلى محتوى AMP عبر .

جدول

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

تمثيل JSON 
{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
الحقول
title

string

العنوان العام للجدول. اختيارية، ولكن يجب ضبطها في حال ضبط الترجمة.
subtitle

string

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

object (Image)

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

object (TableColumn)

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

object (TableRow)

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

object (Link)

زرّ

TableColumn

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

تمثيل JSON 
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
الحقول
header

string

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

enum (HorizontalAlignment)

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

HorizontalAlignment

محاذاة المحتوى داخل الخلية.

عمليات التعداد
UNSPECIFIED محاذاة أفقية غير محددة.
LEADING الحافة البادئة للخلية. وهذا هو الخيار التلقائي.
CENTER تتم محاذاة المحتوى مع وسط العمود.
TRAILING تتم محاذاة المحتوى مع حافة العمود.

TableRow

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

تمثيل JSON 
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
الحقول
cells[]

object (TableCell)

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

boolean

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

TableCell

لوصف خلية في صف واحد.

تمثيل JSON 
{
  "text": string
}
الحقول
text

string

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

الوسائط

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

تمثيل JSON 
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}
الحقول
mediaType

enum (MediaType)

نوع الوسائط
startOffset

string (Duration format)

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

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

enum (OptionalMediaControls)

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

object (MediaObject)

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

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 (MediaImage)
  }
}
الحقول
name

string

اسم عنصر الوسائط هذا
description

string

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

string

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

object (MediaImage)

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

MediaImage

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

تمثيل JSON 
{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}
الحقول
حقل الاتحاد image صورة: يمكن أن تكون السمة "image" واحدة فقط مما يلي:
large

object (Image)

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

object (Image)

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

المجموعة

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

تمثيل JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
الحقول
title

string

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

string

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

object (CollectionItem)

الحد الأدنى: 2 الحد الأقصى: 10
imageFill

enum (ImageFill)

كيفية ملء خلفيات الصورة لعناصر المجموعة اختياريّ.

CollectionItem

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

تمثيل JSON 
{
  "key": string
}
الحقول
key

string

مطلوبة. مفتاح NLU الذي يطابق اسم مفتاح الإدخال في النوع المرتبط به.

قائمة

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

تمثيل JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
الحقول
title

string

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

string

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

object (ListItem)

الحد الأدنى: 2 الحد الأقصى: 30

ListItem

عنصر في القائمة

تمثيل JSON 
{
  "key": string
}
الحقول
key

string

مطلوبة. مفتاح NLU الذي يطابق اسم مفتاح الإدخال في النوع المرتبط به.

الاقتراح

إدخال اقتراح يتم تقديمه للمستخدم

تمثيل JSON 
{
  "title": string
}
الحقول
title

string

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

بيانات التشخيص

معلومات التشخيص ذات الصلة بجولة المحادثة.

تمثيل JSON 
{
  "actionsBuilderEvents": [
    {
      object (ExecutionEvent)
    }
  ]
}
الحقول
actionsBuilderEvents[]

object (ExecutionEvent)

قائمة بالأحداث التي تتضمّن تفاصيل عن معالجة جولة المحادثة من خلال مراحل نموذج تفاعل "أداة إنشاء الإجراءات". تتم تعبئة هذا الحقل لتطبيقَي "أداة إنشاء المهام" و"SDK للإجراءات" فقط.

ExecutionEvent

تحتوي على معلومات عن حدث التنفيذ الذي حدث أثناء معالجة طلب محادثة "أداة إنشاء الإجراءات". لإلقاء نظرة عامة على المراحل التي يتضمّنها طلب المحادثة، يُرجى الاطّلاع على https://developers.google.com/assistant/conversational/actions.

تمثيل JSON 
{
  "eventTime": string,
  "executionState": {
    object (ExecutionState)
  },
  "status": {
    object (Status)
  },
  "warningMessages": [
    string
  ],

  // Union field EventData can be only one of the following:
  "userInput": {
    object (UserConversationInput)
  },
  "intentMatch": {
    object (IntentMatch)
  },
  "conditionsEvaluated": {
    object (ConditionsEvaluated)
  },
  "onSceneEnter": {
    object (OnSceneEnter)
  },
  "webhookRequest": {
    object (WebhookRequest)
  },
  "webhookResponse": {
    object (WebhookResponse)
  },
  "webhookInitiatedTransition": {
    object (WebhookInitiatedTransition)
  },
  "slotMatch": {
    object (SlotMatch)
  },
  "slotRequested": {
    object (SlotRequested)
  },
  "slotValidated": {
    object (SlotValidated)
  },
  "formFilled": {
    object (FormFilled)
  },
  "waitingUserInput": {
    object (WaitingForUserInput)
  },
  "endConversation": {
    object (EndConversation)
  }
  // End of list of possible types for union field EventData.
}
الحقول
eventTime

string (Timestamp format)

الطابع الزمني لوقت وقوع الحدث

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"
executionState

object (ExecutionState)

حالة التنفيذ أثناء هذا الحدث.
status

object (Status)

الحالة الناتجة لخطوة تنفيذ معينة.
warningMessages[]

string

قائمة التحذيرات التي ظهرت أثناء تنفيذ هذا الحدث التحذيرات هي نصائح اكتشفها مطوِّر البرامج أثناء طلب المحادثة. وعادةً ما تكون هذه المشاكل غير بالغة الأهمية ولا تؤدي إلى إيقاف تنفيذ الطلب. على سبيل المثال، قد يتم إنشاء تحذيرات عندما يحاول الردّ التلقائي على الويب إلغاء نوع مخصّص غير متوفر. يتم الإبلاغ عن الأخطاء كرمز حالة "تعذّر التحقق"، ولكن يمكن أن تظهر التحذيرات حتى عندما تكون الحالة على ما يرام.
حقل الاتحاد EventData معلومات تفصيلية خاصة بمختلف الأحداث التي يمكن أن تشارك في معالجة جولة من المحادثة. يحدّد الحقل المحدَّد هنا نوع هذا الحدث. يمكن أن تكون السمة "EventData" واحدة فقط مما يلي:
userInput

object (UserConversationInput)

حدث معالجة البيانات التي أدخلها المستخدم
intentMatch

object (IntentMatch)

حدث مطابقة النية
conditionsEvaluated

object (ConditionsEvaluated)

حدث تقييم الحالة
onSceneEnter

object (OnSceneEnter)

حدث تنفيذ OnSceneEnter
webhookRequest

object (WebhookRequest)

حدث إرسال طلب الردّ التلقائي على الويب.
webhookResponse

object (WebhookResponse)

حدث استلام الردّ التلقائي على الويب.
webhookInitiatedTransition

object (WebhookInitiatedTransition)

حدث نقل تم بدء الردّ التلقائي على الويب.
slotMatch

object (SlotMatch)

حدث مطابقة الخانة
slotRequested

object (SlotRequested)

حدث طلب الشريحة
slotValidated

object (SlotValidated)

حدث التحقّق من الخانة
formFilled

object (FormFilled)

حدث ملء نموذج
waitingUserInput

object (WaitingForUserInput)

في انتظار حدث إدخال المستخدم
endConversation

object (EndConversation)

حدث نهاية المحادثة.

ExecutionState

الحالة الحالية لعملية التنفيذ

تمثيل JSON 
{
  "currentSceneId": string,
  "sessionStorage": {
    object
  },
  "slots": {
    object (Slots)
  },
  "promptQueue": [
    {
      object (Prompt)
    }
  ],
  "userStorage": {
    object
  },
  "householdStorage": {
    object
  }
}
الحقول
currentSceneId

string

رقم تعريف المشهد النشط حاليًا.
sessionStorage

object (Struct format)

حالة مساحة تخزين الجلسة: https://developers.google.com/assistant/conversational/storage-session
slots

object (Slots)

حالة ملء الخانات، إن أمكن: https://developers.google.com/assistant/conversational/scenes#slot_filling
promptQueue[]

object (Prompt)

قائمة انتظار الطلبات: https://developers.google.com/assistant/conversational/prompts
userStorage

object (Struct format)

حالة مساحة تخزين المستخدم: https://developers.google.com/assistant/conversational/storage-user
householdStorage

object (Struct format)

حالة مساحة التخزين المنزلية: https://developers.google.com/assistant/conversational/storage-home

ألعاب المقامرة

تُمثِّل الحالة الحالية لخانات المشهد.

تمثيل JSON 
{
  "status": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  }
}
الحقول
status

enum (SlotFillingStatus)

الحالة الحالية لملء الخانة.
slots

map (key: string, value: object (Slot))

الخانات المرتبطة بالمشهد الحالي.

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

SlotFillingStatus

تُمثِّل هذه السمة الحالة الحالية لملء الخانة.

عمليات التعداد
UNSPECIFIED القيمة الاحتياطية عند عدم تعبئة حقل الاستخدام.
INITIALIZED تم إعداد الخانات ولكن لم يبدأ ملء الخانات.
COLLECTING يجري جمع قيم الخانات.
FINAL جميع قيم الخانات نهائية ولا يمكن تغييرها.

الحيز

يمثّل هذا النوع خانة.

تمثيل JSON 
{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
الحقول
mode

enum (SlotMode)

وضع الخانة (مطلوب أو اختياري). يمكن ضبطه من قِبل مطوّر البرامج.
status

enum (SlotStatus)

حالة الخانة.
value

value (Value format)

قيمة الخانة. سيؤدي تغيير هذه القيمة في الاستجابة إلى تعديل القيمة في تعبئة الخانة.
updated

boolean

يشير إلى ما إذا كان قد تم جمع قيمة الخانة عند المنعطف الأخير. هذا الحقل للقراءة فقط.
prompt

object (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

integer

رمز الحالة، الذي يجب أن يكون قيمة تعداد google.rpc.Code
message

string

رسالة خطأ موجّهة للمطوّر، ويجب أن تكون باللغة الإنجليزية. يجب ترجمة أي رسالة خطأ تظهر للمستخدمين وإرسالها في حقل google.rpc.Status.details أو ترجمتها من خلال البرنامج.
details[]

object

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

كائن يحتوي على حقول من نوع عشوائي. يحتوي الحقل الإضافي "@type" على معرّف موارد منتظم (URI) يحدّد النوع. مثال: { "id": 1234, "@type": "types.example.com/standard/id" }

UserConversationInput

تمثّل هذه السمة المعلومات المتعلقة بإدخال المستخدم.

تمثيل JSON 
{
  "type": string,
  "originalQuery": string
}
الحقول
type

string

نوع البيانات التي أدخلها المستخدم مثلاً لوحة المفاتيح والصوت واللمس وما إلى ذلك
originalQuery

string

تم إدخال النص الأصلي من المستخدم.

IntentMatch

معلومات حول مطابقة النية بالشراء (شاملة أو داخل مشهد): https://developers.google.com/assistant/conversational/intents

تمثيل JSON 
{
  "intentId": string,
  "intentParameters": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "handler": string,
  "nextSceneId": string
}
الحقول
intentId

string

رقم تعريف الهدف الذي أدّى إلى هذا التفاعل.
intentParameters

map (key: string, value: object (IntentParameterValue))

معلّمات النية التي أدّت إلى هذا التفاعل.

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }
handler

string

اسم المعالج المرتبط بهذا التفاعل.
nextSceneId

string

المشهد الذي يؤدي إليه هذا التفاعل.

ConditionsEvaluated

تقييم نتائج الشروط: https://developers.google.com/assistant/conversational/scenes#conditions

تمثيل JSON 
{
  "failedConditions": [
    {
      object (Condition)
    }
  ],
  "successCondition": {
    object (Condition)
  }
}
الحقول
failedConditions[]

object (Condition)

قائمة الشروط التي تم تقييمها إلى "خطأ".
successCondition

object (Condition)

الشرط الأول الذي تم تقييمه إلى "true"، إن وجد.

الشرط

شرط تم تقييمه.

تمثيل JSON 
{
  "expression": string,
  "handler": string,
  "nextSceneId": string
}
الحقول
expression

string

التعبير المحدد في هذا الشرط.
handler

string

اسم المعالج المحدّد في الشرط الذي تم تقييمه.
nextSceneId

string

مشهد الوجهة محدد في شرط تم تقييمه.

OnSceneEnter

معلومات عن تنفيذ مرحلة onSceneEnter: https://developers.google.com/assistant/conversational/scenes#onEnter

تمثيل JSON 
{
  "handler": string
}
الحقول
handler

string

اسم المعالج المحدّد في حدث onSceneEnter.

WebhookRequest

معلومات عن طلب تم إرساله إلى الرد التلقائي على الويب للإجراء: https://developers.google.com/assistant/conversational/webhooks#payloads

تمثيل JSON 
{
  "requestJson": string
}
الحقول
requestJson

string

حمولة طلب الرد التلقائي على الويب.

WebhookResponse

معلومات عن ردّ تم تلقّيه من الردّ التلقائي على الويب للإجراء: https://developers.google.com/assistant/conversational/webhooks#payloads

تمثيل JSON 
{
  "responseJson": string
}
الحقول
responseJson

string

حمولة استجابة الرد التلقائي على الويب.

WebhookInitiatedTransition

الحدث الذي تم تشغيله من خلال مشهد الوجهة المعروض من الردّ التلقائي على الويب: https://developers.google.com/assistant/conversational/webhooks#transition_scenes

تمثيل JSON 
{
  "nextSceneId": string
}
الحقول
nextSceneId

string

رقم تعريف المشهد الذي يؤدي الانتقال إليه.

SlotMatch

معلومات عن الخانات المطابقة: https://developers.google.com/assistant/conversational/scenes#slot_filling

تمثيل JSON 
{
  "nluParameters": {
    string: {
      object (IntentParameterValue)
    },
    ...
  }
}
الحقول
nluParameters

map (key: string, value: object (IntentParameterValue))

المعلَمات المستخرجة من NLU من البيانات التي أدخلها المستخدم

عنصر يحتوي على قائمة من أزواج "key": value. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

SlotRequested

معلومات عن الخانة المطلوبة حاليًا: https://developers.google.com/assistant/conversational/scenes#slot_filling

تمثيل JSON 
{
  "slot": string,
  "prompt": {
    object (Prompt)
  }
}
الحقول
slot

string

اسم الخانة المطلوبة.
prompt

object (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

تم إنهاء الحدث الذي يتم إعلامه بأنّ المحادثة مع موظّف الدعم قد تم إنهاؤها.