StaticPrompt

نشان دهنده لیستی از نامزدهای درخواستی است که یکی از آنها به عنوان درخواستی که در پاسخ به کاربر نشان داده می شود انتخاب می شود. این پیام قابل بومی سازی است.

نمایندگی JSON 
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
فیلدها
candidates[]

object ( StaticPromptCandidate )

لیست کاندیداها درخواست می کند که برای مشتری ارسال شود. هر اعلان دارای یک انتخابگر برای تعیین زمان قابل استفاده است. اولین انتخابی که با یک درخواست مطابقت داشته باشد ارسال می شود و بقیه نادیده گرفته می شوند.

StaticPromptCandidate

یک کاندیدای سریع ثابت را نشان می دهد.

نمایندگی JSON 
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
فیلدها
selector

object ( Selector )

اختیاری. معیارهایی برای مطابقت این درخواست با یک درخواست. اگر انتخابگر خالی باشد، این اعلان همیشه فعال می شود.

promptResponse

object ( StaticPromptResponse )

پاسخ سریع مرتبط با انتخابگر.

انتخابگر

معیارهایی را برای مطابقت یک درخواست با یک درخواست تعریف می کند.

نمایندگی JSON 
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
فیلدها
surfaceCapabilities

object ( SurfaceCapabilities )

مجموعه ای از قابلیت های سطح مورد نیاز.

قابلیت های سطحی

نمایانگر سطحی است که کاربر برای ارسال درخواست به Action از آن استفاده می کند.

نمایندگی JSON 
{
  "capabilities": [
    enum (Capability)
  ]
}
فیلدها
capabilities[]

enum ( Capability )

مورد نیاز. قابلیت های سطح درخواست به اکشن.

StaticPromptResponse

نشان دهنده پاسخ های ساختاریافته برای ارسال به کاربر، مانند متن، گفتار، کارت ها، داده های بوم، تراشه های پیشنهاد و غیره.

نمایندگی JSON 
{
  "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 )

اختیاری. پیشنهاداتی برای نمایش به کاربر که همیشه در انتهای پاسخ ظاهر می شوند. اگر فیلد "الحاق" در فرمان حاوی "درست" باشد، عناوین تعریف شده در این قسمت به عناوین تعریف شده در هر فرمان پیشنهادی تعریف شده قبلی اضافه می شوند و مقادیر تکراری حذف خواهند شد.

override

boolean

اختیاری. حالت نحوه ادغام این پیام‌ها با پیام‌های تعریف‌شده قبلی. "true" همه پیام‌های تعریف شده قبلی (اولین و آخرین ساده، محتوا، پیوند پیشنهادات و بوم) را پاک می‌کند و پیام‌های تعریف‌شده در این فرمان را اضافه می‌کند. "false" پیام های تعریف شده در این اعلان را به پیام های تعریف شده در پاسخ های قبلی اضافه می کند. تنظیم این فیلد روی "نادرست" همچنین افزودن به برخی از فیلدهای داخل فرمان های ساده، اعلان پیشنهادات و فرمان Canvas (بخشی از اعلان محتوا) را نیز فعال می کند. اگر در اعلان تعریف شده باشد، پیام‌های محتوا و پیوند همیشه بازنویسی می‌شوند. مقدار پیش فرض "نادرست" است.

canvas

object ( StaticCanvasPrompt )

پاسخی که برای تجربه بوم تعاملی استفاده می شود.

StaticSimplePrompt

نشان دهنده یک اعلان ساده برای ارسال به کاربر است.

نمایندگی JSON 
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
فیلدها
variants[]

object ( Variant )

لیست انواع احتمالی

نوع

یک نوع را نشان می دهد که بخشی از دستور ساده است.

نمایندگی JSON 
{
  "speech": string,
  "text": string
}
فیلدها
speech

string

اختیاری. بیانگر گفتاری است که باید به کاربر گفته شود. می تواند SSML یا متن به گفتار باشد. اگر فیلد "پیوست" در فرمان حاوی "درست" باشد، گفتار تعریف شده در این قسمت به گفتار دستور ساده قبلی اضافه می شود.

text

string

اختیاری. متن برای نمایش در حباب چت. در صورت عدم ارائه، یک نمایش نمایشی از قسمت گفتار بالا استفاده خواهد شد. محدود به 640 کاراکتر. اگر فیلد "الحاق" در دستور حاوی "درست" باشد، متن تعریف شده در این قسمت به متن دستور ساده قبلی اضافه می شود.

StaticContentPrompt

یک مکان نگهدار برای قسمت محتوای یک StaticPrompt.

نمایندگی JSON 
{

  // 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)
  }
  // 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 )

کارتی که فهرستی از گزینه ها را برای انتخاب ارائه می دهد.

StaticCardPrompt

یک کارت اصلی برای نمایش برخی از اطلاعات، به عنوان مثال یک تصویر و/یا متن.

نمایندگی JSON 
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (StaticImagePrompt)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (StaticLinkPrompt)
  }
}
فیلدها
title

string

اختیاری. عنوان کلی کارت

subtitle

string

اختیاری. زیرنویس کارت

text

string

مورد نیاز. متن اصلی کارت که مورد نیاز است مگر اینکه تصویر موجود باشد. از مجموعه محدودی از نحو نشانه گذاری برای قالب بندی پشتیبانی می کند.

image

object ( StaticImagePrompt )

اختیاری. تصویر قهرمان برای کارت. ارتفاع روی 192dp ثابت شده است.

imageFill

enum ( ImageFill )

اختیاری. پس زمینه تصویر چگونه پر می شود.

button

object ( StaticLinkPrompt )

اختیاری. یک دکمه قابل کلیک برای نمایش در کارت.

StaticImagePrompt

تصویری که در کارت نمایش داده می شود.

نمایندگی JSON 
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
فیلدها
url

string

مورد نیاز. آدرس منبع تصویر تصاویر می توانند JPG، PNG و GIF (متحرک و غیر متحرک) باشند. برای مثال، https://www.agentx.com/logo.png .

alt

string

مورد نیاز. شرح متنی از تصویر که برای دسترسی استفاده می شود، به عنوان مثال صفحه خوان.

height

integer

اختیاری. ارتفاع تصویر بر حسب پیکسل

width

integer

اختیاری. عرض تصویر بر حسب پیکسل

StaticLinkPrompt

پیوندی را تعریف می کند که به عنوان یک تراشه پیشنهاد نمایش داده می شود و کاربر می تواند آن را باز کند.

نمایندگی JSON 
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
فیلدها
name

string

نام لینک

open

object ( OpenUrl )

وقتی کاربر پیوند را باز می کند رفتار را تعریف می کند.

OpenUrl

وقتی کاربر پیوند را باز می کند رفتار را تعریف می کند.

نمایندگی JSON 
{
  "url": string,
  "hint": enum (UrlHint)
}
فیلدها
url

string

فیلد url که می تواند یکی از این موارد باشد: - آدرس های http/https برای باز کردن یک برنامه مرتبط با برنامه یا یک صفحه وب

hint

enum ( UrlHint )

یک اشاره برای نوع URL را نشان می دهد.

StaticTablePrompt

کارت جدول برای نمایش جدول متن.

نمایندگی JSON 
{
  "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 )

اختیاری. دکمه.

ستون جدول

ستونی را در جدول توصیف می کند.

نمایندگی JSON 
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
فیلدها
header

string

متن سرصفحه برای ستون.

align

enum ( HorizontalAlignment )

تراز افقی ستون wrt محتوا. اگر مشخص نباشد، محتوا با لبه اصلی تراز می شود.

TableRow

یک ردیف را در جدول توصیف می کند.

نمایندگی JSON 
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
فیلدها
cells[]

object ( TableCell )

سلول های این ردیف نمایش 3 سلول اول تضمین شده است، اما سایر سلول ها ممکن است بر روی سطوح خاصی بریده شوند. لطفاً با شبیه ساز تست کنید تا ببینید کدام سلول برای یک سطح مشخص نشان داده می شود.

divider

boolean

نشان می دهد که آیا بعد از هر ردیف باید یک تقسیم کننده وجود داشته باشد.

TableCell

یک سلول را در یک ردیف توصیف می کند.

نمایندگی JSON 
{
  "text": string
}
فیلدها
text

string

محتوای متن سلول

StaticMediaPrompt

حاوی اطلاعاتی در مورد رسانه مانند نام، توضیحات، آدرس اینترنتی و غیره است. شناسه بعدی: 9

نمایندگی 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 همچنان باید دو نوع کنترل پیش‌فرض، FINISHED و FAILED را کنترل کند.

mediaObjects[]

object ( MediaObject )

فهرست اشیاء رسانه ای

MediaObject

یک شی رسانه واحد را نشان می دهد.

نمایندگی JSON 
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
فیلدها
name

string

نام این شی رسانه ای.

description

string

شرح این شی رسانه ای.

url

string

نشانی اینترنتی که به محتوای رسانه اشاره دارد.

image

object ( MediaImage )

تصویر برای نمایش با کارت رسانه.

MediaImage

تصویر در داخل MediaPrompt نشان داده شود.

نمایندگی JSON 
{

  // 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 dp تغییر یافته است.

StaticListPrompt

کارتی برای ارائه لیستی از گزینه ها برای انتخاب.

نمایندگی JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
فیلدها
title

string

اختیاری. عنوان لیست

subtitle

string

اختیاری. زیرنویس لیست

items[]

object ( ListItem )

مورد نیاز. فهرست موارد

List Item

یک مورد در لیست

نمایندگی JSON 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
فیلدها
key

string

مورد نیاز. کلید NLU که با نام کلید ورودی در نوع مرتبط مطابقت دارد. هنگامی که روی مورد ضربه بزنید، این کلید به عنوان پارامتر انتخاب گزینه ارسال می شود.

title

string

مورد نیاز. عنوان مورد. وقتی روی آن ضربه بزنید، این متن به طور کلمه به مکالمه ارسال می شود، گویی که کاربر آن را تایپ کرده است. هر عنوان باید در میان مجموعه موارد منحصر به فرد باشد.

description

string

اختیاری. متن متن مورد

image

object ( StaticImagePrompt )

اختیاری. تصویر مورد.

StaticCollectionPrompt

کارتی برای ارائه مجموعه ای از گزینه ها برای انتخاب.

نمایندگی JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
فیلدها
title

string

اختیاری. عنوان مجموعه.

subtitle

string

اختیاری. زیرنویس مجموعه.

items[]

object ( CollectionItem )

مورد نیاز. اقلام مجموعه

imageFill

enum ( ImageFill )

اختیاری. گزینه نوع نمایش تصویر

مجموعه آیتم

یک مورد در مجموعه

نمایندگی JSON 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
فیلدها
key

string

مورد نیاز. کلید NLU که با نام کلید ورودی در نوع مرتبط مطابقت دارد. هنگامی که روی مورد ضربه بزنید، این کلید به عنوان پارامتر انتخاب گزینه ارسال می شود.

title

string

مورد نیاز. عنوان مورد. وقتی روی آن ضربه بزنید، این متن به طور کلمه به مکالمه ارسال می شود، گویی که کاربر آن را تایپ کرده است. هر عنوان باید در میان مجموعه موارد منحصر به فرد باشد.

description

string

اختیاری. متن متن مورد

image

object ( StaticImagePrompt )

اختیاری. تصویر مورد.

پیشنهاد

نشان دهنده یک تراشه پیشنهاد است، یک عنصر UI که برای راحتی به کاربر نشان داده می شود.

نمایندگی JSON 
{
  "title": string
}
فیلدها
title

string

مورد نیاز. متن نشان داده شده در تراشه پیشنهاد. وقتی روی آن ضربه بزنید، این متن به طور کلمه به مکالمه ارسال می شود، گویی که کاربر آن را تایپ کرده است. هر عنوان باید در میان مجموعه تراشه های پیشنهادی منحصر به فرد باشد. حداکثر 25 کاراکتر

StaticCanvasPrompt

نشان دهنده یک پاسخ بوم تعاملی برای ارسال به کاربر است. این می تواند همراه با فیلد "firstSimple" در اعلان حاوی برای صحبت با کاربر علاوه بر نمایش پاسخ بوم تعاملی استفاده شود.

نمایندگی JSON 
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean
}
فیلدها
url

string

مورد نیاز. URL نمای وب برای بارگیری.

data[]

value ( Value format)

اختیاری. داده های JSON به عنوان یک رویداد به صفحه وب تجربه همهجانبه منتقل می شود. اگر فیلد «نسخ» در فرمان حاوی «نادرست» باشد، مقادیر داده‌های تعریف‌شده در این فرمان Canvas پس از مقادیر داده‌های تعریف‌شده در درخواست‌های قبلی Canvas اضافه می‌شوند.

suppressMic

boolean

اختیاری. یک مقدار واقعی به این معنی است که پس از ارائه این پاسخ همه جانبه به کاربر، میکروفون برای گرفتن ورودی باز نمی شود.