EventHandler

מגדירה handler שצריך לבצע אחרי אירוע. דוגמאות לאירועים: אירועים שמבוססים על כוונת רכישה ותנאים בסצנה.

ייצוג YAML 
webhookHandler: string

# Union field prompt can be only one of the following:
staticPrompt: 
  object (StaticPrompt)
staticPromptName: string
# End of list of possible types for union field prompt.
שדות
webhookHandler

string

השם של ה-handler של תגובה לפעולה מאתר אחר (webhook) שאליו רוצים לקרוא.
שדה איחוד prompt. אפשר להוסיף הנחיות בתוך השורה או להפנות אליהן לפי השם. הערך של prompt יכול להיות רק אחת מהאפשרויות הבאות:
staticPrompt

object (StaticPrompt)

הנחיה סטטית בשורת הטקסט. יכול להכיל הפניות למשאבי מחרוזת בחבילות.
staticPromptName

string

שם ההנחיה הסטטית להפעלה.

StaticPrompt

מייצג רשימה של הצעות להנחיה, שאחד מהן ייבחר כהצעה להופיע בתשובה למשתמש. ניתן להתאים את ההודעה הזו לשוק המקומי.

ייצוג YAML 
candidates: 
  - object (StaticPromptCandidate)
שדות
candidates[]

object (StaticPromptCandidate)

רשימת ההצעות שיש לשלוח ללקוח. בכל הצעה יש בורר שקובע מתי אפשר להשתמש בה. הבורר הראשון שתואם לבקשה יישלח, והמערכת תתעלם מהשאר.

StaticPromptCandidate

מייצג מועמד להנחיה סטטית.

ייצוג YAML 
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
שדות
selector

object (Selector)

אפשרות. הקריטריונים לקביעה אם ההנחיה הזו תואמת לבקשה. אם הבורר ריק, ההנחיה הזו תופעל תמיד.
promptResponse

object (StaticPromptResponse)

התגובה לפעולה שמשויכת לבורר.

בורר

מגדיר את הקריטריונים להתאמה של בקשה לבקשה.

ייצוג YAML 
surfaceCapabilities: 
  object (SurfaceCapabilities)
שדות
surfaceCapabilities

object (SurfaceCapabilities)

קבוצת יכולות השטח הנדרשות.

SurfaceCapabilities

מייצג את הפלטפורמה שבה המשתמש משתמש כדי לשלוח בקשה לפעולה.

ייצוג YAML 
capabilities: 
  - enum (Capability)
שדות
capabilities[]

enum (Capability)

חובה. היכולות של הפלטפורמה ששולחים בקשה לפעולה.

StaticPromptResponse

מייצגות תשובות מובנות לשליחה למשתמש, כמו טקסט, דיבור, כרטיסים, נתוני קנבס, צ'יפים של הצעות וכו'.

ייצוג YAML 
firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
שדות
firstSimple

object (StaticSimplePrompt)

אפשרות. התגובה הראשונה בקול ובטקסט בלבד.
content

object (StaticContentPrompt)

אפשרות. תוכן כמו כרטיס, רשימה או מדיה שאפשר להציג למשתמש.
lastSimple

object (StaticSimplePrompt)

אפשרות. התגובה האחרונה בהודעה קולית וטקסט בלבד.
suggestions[]

object (Suggestion)

אפשרות. הצעות שיוצגו למשתמש שתמיד יופיעו בסוף התשובה. אם השדה append בהנחיה שמכילה את הטקסט true, הכותרות שהוגדרו בשדה הזה יתווספו לכותרות שהוגדרו בכל ההצעות שהוגדרו קודם לכן, וערכים כפולים יוסרו.
override

boolean

אפשרות. מצב האופן שבו יש למזג את ההודעה הזו עם הודעות שהוגדרו קודם לכן. true ינקה את כל ההודעות שהוגדרו קודם (קודם כל, תוכן, קישור להצעות וקנבס) ויוסיף הודעות שהוגדרו בהודעה הזו. הודעות שהוגדרו בהנחיה הזו יתווספו על ידי false להודעות שהוגדרו בתשובות הקודמות. אם השדה הזה מוגדר לערך false, ניתן יהיה להוסיף גם שדות מסוימים לשדות ב'הנחיות פשוטות', בהנחיה 'הצעות' ובהנחיה 'בד ציור' (חלק מהודעת התוכן). הודעות התוכן והקישור תמיד יוחלפו, אם הן הוגדרו בהודעה. ערך ברירת המחדל הוא false.
canvas

object (StaticCanvasPrompt)

תשובה שתשמש לחוויית שימוש אינטראקטיבית באזור העריכה.

StaticSimplePrompt

מייצג הנחיה פשוטה לשליחה למשתמש.

ייצוג YAML 
variants: 
  - object (Variant)
שדות
variants[]

object (Variant)

רשימת וריאציות אפשריות.

וריאנט

מייצג וריאנט שהוא חלק מההנחיה הפשוטה.

ייצוג YAML 
speech: string
text: string
שדות
speech

string

אפשרות. מייצג את הדיבור שיש לומר למשתמש. אפשר להשתמש בפורמט SSML או המרת טקסט לדיבור. כברירת מחדל, הדיבור יתווסף לדיבור של ההנחיה הפשוטה הקודמת. אם השדה override בהנחיה שמכילה הוא true, הדיבור שמוגדר בשדה הזה יבטל את הדיבור של ההנחיה הפשוטה הקודמת.
text

string

אפשרות. טקסט שיוצג בבועת הצ'אט. אם לא תספקו, ייעשה שימוש בתצוגה של שדה הדיבור שלמעלה. מוגבל ל-640 תווים. כברירת מחדל, הטקסט יצורף לטקסט של ההנחיה הפשוטה הקודמת. אם השדה override בהנחיה שמכילה הוא true, הטקסט שמוגדר בשדה הזה יחליף את הטקסט של ההנחיה הפשוטה הקודמת.

StaticContentPrompt

placeholder לחלק התוכן של StaticPrompt.

ייצוג YAML 
# Union field content can be only one of the following:
card: 
  object (StaticCardPrompt)
image: 
  object (StaticImagePrompt)
table: 
  object (StaticTablePrompt)
media: 
  object (StaticMediaPrompt)
list: 
  object (StaticListPrompt)
collection: 
  object (StaticCollectionPrompt)
collectionBrowse: 
  object (StaticCollectionBrowsePrompt)
# End of list of possible types for union field content.
שדות
שדה איחוד content. בהנחיה אפשר לכלול רק סוג אחד של תוכן. הערך של content יכול להיות רק אחת מהאפשרויות הבאות:
card

object (StaticCardPrompt)

כרטיס בסיסי.
image

object (StaticImagePrompt)

תמונה.
table

object (StaticTablePrompt)

כרטיס טבלה.
media

object (StaticMediaPrompt)

תגובה שמציינת קבוצת מדיה להפעלה.
list

object (StaticListPrompt)

כרטיס להצגת רשימה של אפשרויות לבחירה.
collection

object (StaticCollectionPrompt)

כרטיס שמציג רשימה של אפשרויות לבחירה.
collectionBrowse

object (StaticCollectionBrowsePrompt)

כרטיס שמציג אוסף של דפי אינטרנט לפתיחה.

StaticCardPrompt

כרטיס בסיסי להצגת מידע מסוים, כמו תמונה או טקסט.

ייצוג YAML 
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
שדות
title

string

אפשרות. השם הכולל של הכרטיס.
subtitle

string

אפשרות. כותרת המשנה של הכרטיס.
text

string

חובה. טקסט גוף הכרטיס, אם אין תמונה. יש תמיכה בקבוצה מוגבלת של תחביר Markdown לעיצוב.
image

object (StaticImagePrompt)

אפשרות. תמונה ראשית (Hero) של הכרטיס. הגובה קבוע ל-192dp.
imageFill

enum (ImageFill)

אפשרות. איך ימולאו הרקע של התמונה.
button

object (StaticLinkPrompt)

אפשרות. לחצן שניתן ללחוץ עליו שיוצג בכרטיס.

StaticImagePrompt

תמונה שמוצגת בכרטיס.

ייצוג YAML 
url: string
alt: string
height: integer
width: integer
שדות
url

string

חובה. כתובת ה-URL המקורית של התמונה. התמונות יכולות להיות בפורמט JPG, PNG ו-GIF (מונפשים או ללא אנימציה). לדוגמה,https://www.agentx.com/logo.png.
alt

string

חובה. תיאור טקסטואלי של התמונה שתשמש לצורך נגישות, למשל קוראי מסך.
height

integer

אפשרות. גובה התמונה בפיקסלים.
width

integer

אפשרות. רוחב התמונה בפיקסלים.

StaticLinkPrompt

הגדרת קישור שיוצג כצ'יפ של הצעה והמשתמש יוכל לפתוח אותו.

ייצוג YAML 
name: string
open: 
  object (OpenUrl)
שדות
name

string

שם הקישור
open

object (OpenUrl)

הגדרת ההתנהגות כשהמשתמש פותח את הקישור.

OpenUrl

הגדרת ההתנהגות כשהמשתמש פותח את הקישור.

ייצוג YAML 
url: string
hint: enum (UrlHint)
שדות
url

string

שדה כתובת ה-URL שיכול להיות כל אחד מהפרטים הבאים: - כתובות URL מסוג http/https לפתיחת אפליקציה או דף אינטרנט שמקושרים לאפליקציה
hint

enum (UrlHint)

מציין רמז לסוג כתובת האתר.

StaticTablePrompt

כרטיס טבלה להצגת טבלה של טקסט.

ייצוג YAML 
title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
שדות
title

string

אפשרות. הכותרת הכוללת של הטבלה. יש להגדיר אם מוגדרת כותרת משנה.
subtitle

string

אפשרות. כותרת משנה של הטבלה.
image

object (StaticImagePrompt)

אפשרות. תמונה שמשויכת לטבלה.
columns[]

object (TableColumn)

אפשרות. כותרות ויישור של עמודות.
rows[]

object (TableRow)

אפשרות. נתוני שורות בטבלה. 3 השורות הראשונות יוצגו בהכרח, אבל יכול להיות שאחרות ייחתכו בפלטפורמות מסוימות. אתם יכולים לבדוק באמצעות הסימולטור אילו שורות יוצגו עבור משטח נתון. בפלטפורמות שתומכות ביכולת WEB_BROWSER, אפשר להפנות את המשתמשים לדף אינטרנט עם יותר נתונים.
button

object (StaticLinkPrompt)

אפשרות. לחצן.

TableColumn

מתאר עמודה בטבלה.

ייצוג YAML 
header: string
align: enum (HorizontalAlignment)
שדות
header

string

טקסט הכותרת לעמודה.
align

enum (HorizontalAlignment)

יישור אופקי של עמודת w.r.t של התוכן. אם לא צוין אחרת, התוכן יושר לקצה העליון.

TableRow

מתאר שורה בטבלה.

ייצוג YAML 
cells: 
  - object (TableCell)
divider: boolean
שדות
cells[]

object (TableCell)

תאים בשורה הזו. 3 התאים הראשונים יוצגו, אבל אחרים עשויים להיחתך בפלטפורמות מסוימות. השתמשו בסימולטור כדי לבדוק אילו תאים יוצגו עבור משטח נתון.
divider

boolean

מציינת אם צריך להיות קו מפריד אחרי כל שורה.

TableCell

מתאר תא בשורה.

ייצוג YAML 
text: string
שדות
text

string

תוכן הטקסט של התא.

StaticMediaPrompt

מכיל מידע על המדיה, כמו שם, תיאור, כתובת URL וכו'. המזהה הבא: 11

ייצוג YAML 
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
שדות
mediaType

enum (MediaType)

סוג המדיה של התשובה הזו.
startOffset

string (Duration format)

היסט ההתחלה של אובייקט המדיה הראשון.

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. דוגמה: "3.5s".
optionalMediaControls[]

enum (OptionalMediaControls)

סוגים אופציונליים של פקדי מדיה שסשן התגובה הזה למדיה יכול לתמוך בהם. אם המדיניות מוגדרת, הבקשה תישלח על ידי צד שלישי כשמתרחש אירוע מדיה מסוים. אם היא לא מוגדרת, צד שלישי עדיין צריך לטפל בשני סוגי פקדים שמוגדרים כברירת מחדל, FINISHED ו-FAILED.
mediaObjects[]

object (MediaObject)

רשימה של אובייקטי מדיה.
repeatMode

enum (RepeatMode)

מצב חזרה על רשימת אובייקטים של מדיה.

MediaObject

מייצג אובייקט מדיה אחד.

ייצוג YAML 
name: string
description: string
url: string
image: 
  object (MediaImage)
שדות
name

string

השם של אובייקט המדיה הזה.
description

string

תיאור של אובייקט המדיה.
url

string

כתובת ה-URL שמפנה לתוכן המדיה.
image

object (MediaImage)

תמונה שתוצג עם כרטיס המדיה.

MediaImage

תמונה שתוצג בתוך MediaPrompt.

ייצוג YAML 
# Union field image can be only one of the following:
large: 
  object (StaticImagePrompt)
icon: 
  object (StaticImagePrompt)
# End of list of possible types for union field image.
שדות
שדה איחוד image. מותר להשתמש רק בסוג אחד של MediaImage. הערך של image יכול להיות רק אחת מהאפשרויות הבאות:
large

object (StaticImagePrompt)

תמונה גדולה, כמו עטיפת האלבום וכו'
icon

object (StaticImagePrompt)

סמל תמונה קטן שמוצג משמאל לכותרת. הוא הוקטן ל-36x36dp.

StaticListPrompt

כרטיס להצגת רשימה של אפשרויות לבחירה.

ייצוג YAML 
title: string
subtitle: string
items: 
  - object (ListItem)
שדות
title

string

אפשרות. שם הרשימה.
subtitle

string

אפשרות. כותרת המשנה של הרשימה.
items[]

object (ListItem)

חובה. פריטים ברשימה.

ListItem

פריט ברשימה.

ייצוג YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
שדות
key

string

חובה. מפתח ה-NLU שתואם לשם מפתח הכניסה בסוג המשויך. כשמקישים על פריט, המפתח הזה יפורסם שוב כפרמטר לאפשרות בחירה.
title

string

חובה. שם הפריט. כשמקישים על קיצור הדרך, אפשר לחזור לשיחה מילה במילה, כאילו המשתמש הקליד אותו. כל שם פריט צריך להיות ייחודי בקבוצת הפריטים.
description

string

אפשרות. טקסט גוף הפריט.
image

object (StaticImagePrompt)

אפשרות. תמונת פריט.

StaticCollectionPrompt

כרטיס להצגת מגוון אפשרויות לבחירה.

ייצוג YAML 
title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)
שדות
title

string

אפשרות. שם האוסף.
subtitle

string

אפשרות. כותרת המשנה של האוסף.
items[]

object (CollectionItem)

חובה. פריטים באוסף.
imageFill

enum (ImageFill)

אפשרות. סוג אפשרות תצוגת התמונה.

CollectionItem

פריט באוסף.

ייצוג YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
שדות
key

string

חובה. מפתח NLU שתואם לשם מפתח הכניסה בסוג המשויך. כשמקישים על פריט, המפתח הזה יפורסם שוב כפרמטר לאפשרות בחירה.
title

string

חובה. שם הפריט. כשמקישים על קיצור הדרך, אפשר לחזור לשיחה מילה במילה, כאילו המשתמש הקליד אותו. כל שם פריט צריך להיות ייחודי בקבוצת הפריטים.
description

string

אפשרות. טקסט גוף הפריט.
image

object (StaticImagePrompt)

אפשרות. תמונת פריט.

StaticCollectionBrowsePrompt

הצגת קבוצה של מסמכי אינטרנט כאוסף של פריטי אריח גדול. ניתן לבחור פריטים כדי להפעיל את מסמך האינטרנט המשויך אליהם במציג אינטרנט.

ייצוג YAML 
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
שדות
items[]

object (CollectionBrowseItem)

פריטים באוסף העיון. גודל הרשימה צריך להיות בטווח [2, 10].
imageFill

enum (ImageFill)

אפשרות להצגת תמונות בקולקציה.

CollectionBrowseItem

פריט באוסף.

ייצוג YAML 
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
שדות
title

string

חובה. שם הפריט באוסף.
description

string

תיאור של פריט האוסף.
footer

string

טקסט הכותרת התחתונה של פריט האוסף, מוצג מתחת לתיאור. שורת טקסט אחת קטועה עם שלוש נקודות.
image

object (StaticImagePrompt)

תמונה של הפריט באוסף.
openUriAction

object (OpenUrl)

חובה. URI לפתיחה אם הפריט נבחר.

הצעה

מייצג צ'יפ של הצעה, רכיב בממשק המשתמש שמוצג למשתמש לנוחותו.

ייצוג YAML 
title: string
שדות
title

string

חובה. הטקסט שמוצג בצ'יפ ההצעות. כשמקישים על קיצור הדרך, אפשר לחזור לשיחה מילה במילה, כאילו המשתמש הקליד אותו. כל שם צריך להיות ייחודי בקבוצת הצ'יפים של ההצעות. 25 תווים לכל היותר

StaticCanvasPrompt

מייצג את התגובה האינטראקטיבית של לוח הציור שתישלח למשתמש. אפשר להשתמש בערך הזה בשילוב עם השדה firstSimple בהנחיה שמכילה כדי לדבר עם המשתמש בנוסף להצגת תגובה אינטראקטיבית של לוח הציור.

ייצוג YAML 
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
שדות
url

string

חובה. כתובת ה-URL של תצוגת האינטרנט לטעינה.
data[]

value (Value format)

אפשרות. נתוני JSON שיועברו לדף האינטרנט של החוויה הסוחפת כאירוע. אם השדה override בהנחיה שמכילה הוא false, ערכי נתונים שהוגדרו בהצעה הזו של לוח הציור יתווספו אחרי שערכי הנתונים שהוגדרו בהנחיות הקודמות של לוח הציור יתווספו.
suppressMic

boolean

אפשרות. ערך אמיתי פירושו שהמיקרופון לא ייפתח לצורך הקלטת קלט אחרי שהתגובה העשירה הזו תוצג למשתמש.
sendStateDataToCanvasApp

boolean

אפשרות. אם הטבלה true, נכללים מטא-נתונים שקשורים לשיחות ונשלחים בחזרה לאפליקציית לוח הציור.
enableFullScreen

boolean

אפשרות. אם true, אפליקציית ההדפסה על קנבס תופסת את כל המסך ולא תהיה כותרת בחלק העליון. במסך הטעינה תוצג גם הודעת השקה שכוללת את השם המוצג של הפעולה, שם המפתח והוראות ליציאה מהפעולה. ערך ברירת המחדל: false.
continueTtsDuringTouch

boolean

אפשרות. אם הערך הוא True, הקשה על המסך לא תוביל להפסקת ה-TTS בכל הסשן של ההדפסה על קנבס. ערך ברירת המחדל: false.