Method: projects.sendInteraction

يلعب جولة واحدة من المحادثة.

طلب HTTP

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

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

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

المعلمات
project

string

مطلوب. المشروع الذي يتم اختباره، ويُشار إليه برقم تعريف المشروع. التنسيق: projects/{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.

خصائص الجهاز

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

تمثيل 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 دردشة الفيديو
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 إلى صفحة الويب للتجربة الشاملة كفعالية. إذا تم "إلغاء" الحقل في الطلب الذي يتضمّن الطلب هو "false" ستتم إضافة قيم البيانات المحددة في طلب لوحة الرسم هذا بعد قيم البيانات المحددة في طلبات لوحة الرسم السابقة.
suppressMic

boolean

اختياريّ. القيمة التلقائية: false.
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

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

boolean

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

object (Simple)

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

object (Content)

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

object (Simple)

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

object (Suggestion)

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

object (Canvas)

اختياريّ. يمثل هذا النوع رد لوحة رسم تفاعليًا يتم إرساله إلى المستخدم.

بسيط

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

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

string

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

string

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

المحتوى

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

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

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

object (MediaObject)

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

MediaType

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

عمليات التعداد
MEDIA_TYPE_UNSPECIFIED نوع وسائط غير محدَّد
AUDIO ملف صوتي
MEDIA_STATUS_ACK الاستجابة للإقرار بتقرير حالة الوسائط.

OptionalMediaControls

أنواع عناصر التحكم الاختيارية في الوسائط التي يمكن أن تتيحها استجابة الوسائط

عمليات التعداد
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED قيمة غير محدّدة
PAUSED تم إيقاف الحدث مؤقتًا. يتم تشغيله عندما يوقف المستخدم الوسائط مؤقتًا.
STOPPED تم إيقاف الحدث. يتم تشغيله عندما يخرج المستخدم من جلسة الجهات الخارجية أثناء تشغيل الوسائط.

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)

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

مجموعة

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

تمثيل 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)

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

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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

الحدث الذي يُعلمك بإنهاء المحادثة مع موظّف الدعم