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)

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

SurfaceCapabilities

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

ייצוג 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)

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

boolean

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

object (StaticCanvasPrompt)

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

StaticSimplePrompt

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

ייצוג JSON 
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
שדות
variants[]

object (Variant)

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

וריאנט

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

ייצוג JSON 
{
  "speech": string,
  "text": string
}
שדות
speech

string

זה שינוי אופציונלי. מייצג את הדיבור שייאמר בפני המשתמש. הקובץ יכול להיות בפורמט SSML או המרת טקסט לדיבור (TTS). אם הפונקציה 'append' בשדה שמכיל את ההנחיה הוא 'true' הדיבור שהוגדר בשדה הזה יצורף לדיבור של ההנחיה הפשוטה הקודמת.
text

string

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

StaticContentPrompt

placeholder של החלק 'תוכן' של הנחיה סטטית.

ייצוג 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

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

object (StaticImagePrompt)

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

enum (ImageFill)

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

object (StaticLinkPrompt)

זה שינוי אופציונלי. לחצן קליקבילי שיוצג בכרטיס.

StaticImagePrompt

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

ייצוג 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

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

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)

זה שינוי אופציונלי. לחצן.

TableColumn

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

ייצוג JSON 
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
שדות
header

string

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

enum (HorizontalAlignment)

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

TableRow

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

ייצוג JSON 
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
שדות
cells[]

object (TableCell)

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

boolean

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

TableCell

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

ייצוג JSON 
{
  "text": string
}
שדות
text

string

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

StaticMediaPrompt

מכילה מידע על המדיה, כמו שם, תיאור, כתובת URL וכו'. המזהה הבא: 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 עדיין צריך לטפל בשני סוגי בקרה שמוגדרים כברירת מחדל: FINISHED ו-FAILED.
mediaObjects[]

object (MediaObject)

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

MediaObject

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

ייצוג JSON 
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
שדות
name

string

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

string

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

string

כתובת ה-URL שמפנה לתוכן המדיה.
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)

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

StaticListPrompt

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

ייצוג JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
שדות
title

string

זה שינוי אופציונלי. כותרת הרשימה.
subtitle

string

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

object (ListItem)

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

ListItem

פריט ברשימה.

ייצוג 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)

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

CollectionItem

פריט באוסף.

ייצוג JSON 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
שדות
key

string

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

string

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

string

זה שינוי אופציונלי. הטקסט של תוכן הפריט.
image

object (StaticImagePrompt)

זה שינוי אופציונלי. תמונת פריט.

הצעה

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

ייצוג JSON 
{
  "title": string
}
שדות
title

string

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

StaticCanvasPrompt

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

ייצוג JSON 
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean
}
שדות
url

string

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

value (Value format)

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

boolean

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