- StaticPromptCandidate
- סלקטור
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- וריאציה
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- הצעה
- StaticCanvasPrompt
מייצג רשימה של הצעות להנחיה, שאחד מהן ייבחר כהצעה להופיע בתשובה למשתמש. ניתן להתאים את ההודעה הזו לשוק המקומי.
ייצוג JSON | |
---|---|
{
"candidates": [
{
object ( |
שדות | |
---|---|
candidates[] |
רשימת ההצעות שיש לשלוח ללקוח. בכל הצעה יש בורר שקובע מתי אפשר להשתמש בה. הבורר הראשון שתואם לבקשה יישלח, והמערכת תתעלם מהשאר. |
StaticPromptCandidate
מייצג מועמד להנחיה סטטית.
ייצוג JSON | |
---|---|
{ "selector": { object ( |
שדות | |
---|---|
selector |
אפשרות. הקריטריונים לקביעה אם ההנחיה הזו תואמת לבקשה. אם הבורר ריק, ההנחיה הזו תופעל תמיד. |
promptResponse |
התגובה לפעולה שמשויכת לבורר. |
בורר
מגדיר את הקריטריונים להתאמה של בקשה לבקשה.
ייצוג JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
שדות | |
---|---|
surfaceCapabilities |
קבוצת יכולות השטח הנדרשות. |
SurfaceCapabilities
מייצג את הפלטפורמה שבה המשתמש משתמש כדי לשלוח בקשה לפעולה.
ייצוג JSON | |
---|---|
{
"capabilities": [
enum ( |
שדות | |
---|---|
capabilities[] |
חובה. היכולות של הפלטפורמה ששולחים בקשה לפעולה. |
StaticPromptResponse
מייצגות תשובות מובנות לשליחה למשתמש, כמו טקסט, דיבור, כרטיסים, נתוני קנבס, צ'יפים של הצעות וכו'.
ייצוג JSON | |
---|---|
{ "firstSimple": { object ( |
שדות | |
---|---|
firstSimple |
אפשרות. התגובה הראשונה בקול ובטקסט בלבד. |
content |
אפשרות. תוכן כמו כרטיס, רשימה או מדיה שאפשר להציג למשתמש. |
lastSimple |
אפשרות. התגובה האחרונה בהודעה קולית וטקסט בלבד. |
suggestions[] |
אפשרות. הצעות שיוצגו למשתמש שתמיד יופיעו בסוף התשובה. אם השדה "append" (הוספה) בהנחיה שמכילה את הערך "true", הכותרות שהוגדרו בשדה הזה יתווספו לכותרות שהוגדרו בכל ההצעות שהוגדרו קודם לכן, וערכים כפולים יוסרו. |
link |
אפשרות. צ'יפ של הצעה נוסף, שיכול לקשר לאפליקציה או לאתר המשויכים. הצ'יפ יוצג עם הכותרת "פתיחה |
override |
אפשרות. מצב האופן שבו יש למזג את ההודעה הזו עם הודעות שהוגדרו קודם לכן. הערך "true" ינקה את כל ההודעות שהוגדרו קודם לכן (הראשונה והאחרונה, תוכן, קישור להצעות ולוח הציור) ויוסיף הודעות שהוגדרו בהודעה הזו. הערך 'false' יוסיף הודעות שהוגדרו בהודעה הזו להודעות שהוגדרו בתשובות הקודמות. הגדרת השדה הזה כ-'false' תאפשר גם הוספה לשדות מסוימים ב'הנחיות פשוטות', בהנחיה 'הצעות' ובהנחיה 'בד ציור' (חלק משורת התוכן). הודעות התוכן והקישור תמיד יוחלפו, אם הן הוגדרו בהודעה. ערך ברירת המחדל הוא 'false'. |
canvas |
תשובה שתשמש לחוויית שימוש אינטראקטיבית באזור העריכה. |
StaticSimplePrompt
מייצג הנחיה פשוטה לשליחה למשתמש.
ייצוג JSON | |
---|---|
{
"variants": [
{
object ( |
שדות | |
---|---|
variants[] |
רשימת וריאציות אפשריות. |
וריאנט
מייצג וריאנט שהוא חלק מההנחיה הפשוטה.
ייצוג JSON | |
---|---|
{ "speech": string, "text": string } |
שדות | |
---|---|
speech |
אפשרות. מייצג את הדיבור שיש לומר למשתמש. אפשר להשתמש בפורמט SSML או המרת טקסט לדיבור. אם השדה "append" בהנחיה שמכילה הוא "true", הדיבור שמוגדר בשדה יצורף לדיבור של ההנחיה הפשוטה הקודמת. |
text |
אפשרות. טקסט שיוצג בבועת הצ'אט. אם לא תספקו, ייעשה שימוש בתצוגה של שדה הדיבור שלמעלה. מוגבל ל-640 תווים. אם השדה append בהנחיה שמכילה הוא "true", הטקסט שמוגדר בשדה הזה יצורף לטקסט של ההנחיה הפשוטה הקודמת. |
StaticContentPrompt
placeholder לחלק התוכן של StaticPrompt.
ייצוג JSON | |
---|---|
{ // Union field |
שדות | ||
---|---|---|
שדה איחוד content . בהנחיה אפשר לכלול רק סוג אחד של תוכן. הערך של content יכול להיות רק אחת מהאפשרויות הבאות: |
||
card |
כרטיס בסיסי. |
|
image |
תמונה. |
|
table |
כרטיס טבלה. |
|
media |
תגובה שמציינת קבוצת מדיה להפעלה. |
|
list |
כרטיס להצגת רשימה של אפשרויות לבחירה. |
|
collection |
כרטיס שמציג רשימה של אפשרויות לבחירה. |
StaticCardPrompt
כרטיס בסיסי להצגת מידע מסוים, כמו תמונה או טקסט.
ייצוג JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
שדות | |
---|---|
title |
אפשרות. השם הכולל של הכרטיס. |
subtitle |
אפשרות. כותרת המשנה של הכרטיס. |
text |
חובה. טקסט גוף הכרטיס, אם אין תמונה. יש תמיכה בקבוצה מוגבלת של תחביר Markdown לעיצוב. |
image |
אפשרות. תמונה ראשית (Hero) של הכרטיס. הגובה קבוע ל-192dp. |
imageFill |
אפשרות. איך ימולאו הרקע של התמונה. |
button |
אפשרות. לחצן שניתן ללחוץ עליו שיוצג בכרטיס. |
StaticImagePrompt
תמונה שמוצגת בכרטיס.
ייצוג JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
שדות | |
---|---|
url |
חובה. כתובת ה-URL המקורית של התמונה. התמונות יכולות להיות בפורמט JPG, PNG ו-GIF (מונפשים או ללא אנימציה). לדוגמה, |
alt |
חובה. תיאור טקסטואלי של התמונה שתשמש לצורך נגישות, למשל קוראי מסך. |
height |
אפשרות. גובה התמונה בפיקסלים. |
width |
אפשרות. רוחב התמונה בפיקסלים. |
StaticLinkPrompt
הגדרת קישור שיוצג כצ'יפ של הצעה והמשתמש יוכל לפתוח אותו.
ייצוג JSON | |
---|---|
{
"name": string,
"open": {
object ( |
שדות | |
---|---|
name |
שם הקישור |
open |
הגדרת ההתנהגות כשהמשתמש פותח את הקישור. |
OpenUrl
הגדרת ההתנהגות כשהמשתמש פותח את הקישור.
ייצוג JSON | |
---|---|
{
"url": string,
"hint": enum ( |
שדות | |
---|---|
url |
שדה כתובת ה-URL שיכול להיות כל אחד מהפרטים הבאים: - כתובות URL מסוג http/https לפתיחת אפליקציה או דף אינטרנט שמקושרים לאפליקציה |
hint |
מציין רמז לסוג כתובת האתר. |
StaticTablePrompt
כרטיס טבלה להצגת טבלה של טקסט.
ייצוג JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
שדות | |
---|---|
title |
אפשרות. הכותרת הכוללת של הטבלה. יש להגדיר אם מוגדרת כותרת משנה. |
subtitle |
אפשרות. כותרת משנה של הטבלה. |
image |
אפשרות. תמונה שמשויכת לטבלה. |
columns[] |
אפשרות. כותרות ויישור של עמודות. |
rows[] |
אפשרות. נתוני שורות בטבלה. 3 השורות הראשונות יוצגו בהכרח, אבל יכול להיות שאחרות ייחתכו בפלטפורמות מסוימות. אתם יכולים לבדוק באמצעות הסימולטור אילו שורות יוצגו עבור משטח נתון. בפלטפורמות שתומכות ביכולת WEB_BROWSER, אפשר להפנות את המשתמש לדף אינטרנט שמכיל יותר נתונים. |
button |
אפשרות. לחצן. |
TableColumn
מתאר עמודה בטבלה.
ייצוג JSON | |
---|---|
{
"header": string,
"align": enum ( |
שדות | |
---|---|
header |
טקסט הכותרת לעמודה. |
align |
יישור אופקי של עמודת w.r.t של התוכן. אם לא צוין אחרת, התוכן יושר לקצה העליון. |
TableRow
מתאר שורה בטבלה.
ייצוג JSON | |
---|---|
{
"cells": [
{
object ( |
שדות | |
---|---|
cells[] |
תאים בשורה הזו. 3 התאים הראשונים יוצגו, אבל אחרים עשויים להיחתך בפלטפורמות מסוימות. השתמשו בסימולטור כדי לבדוק אילו תאים יוצגו עבור משטח נתון. |
divider |
מציינת אם צריך להיות קו מפריד אחרי כל שורה. |
TableCell
מתאר תא בשורה.
ייצוג JSON | |
---|---|
{ "text": string } |
שדות | |
---|---|
text |
תוכן הטקסט של התא. |
StaticMediaPrompt
מכיל מידע על המדיה, כמו שם, תיאור, כתובת URL וכו'. המזהה הבא: 9
ייצוג JSON | |
---|---|
{ "mediaType": enum ( |
שדות | |
---|---|
mediaType |
סוג המדיה של התשובה הזו. |
startOffset |
היסט ההתחלה של אובייקט המדיה הראשון. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-' |
optionalMediaControls[] |
סוגים אופציונליים של פקדי מדיה שסשן התגובה הזה למדיה יכול לתמוך בהם. אם המדיניות מוגדרת, הבקשה תישלח על ידי צד שלישי כשמתרחש אירוע מדיה מסוים. אם היא לא מוגדרת, צד שלישי עדיין צריך לטפל בשני סוגי פקדים שמוגדרים כברירת מחדל, FINISHED ו-FAILED. |
mediaObjects[] |
רשימה של אובייקטי מדיה. |
MediaObject
מייצג אובייקט מדיה אחד.
ייצוג JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
שדות | |
---|---|
name |
השם של אובייקט המדיה הזה. |
description |
תיאור של אובייקט המדיה. |
url |
כתובת ה-URL שמפנה לתוכן המדיה. |
image |
תמונה שתוצג עם כרטיס המדיה. |
MediaImage
תמונה שתוצג בתוך MediaPrompt.
ייצוג JSON | |
---|---|
{ // Union field |
שדות | ||
---|---|---|
שדה איחוד image . מותר להשתמש רק בסוג אחד של MediaImage. הערך של image יכול להיות רק אחת מהאפשרויות הבאות: |
||
large |
תמונה גדולה, כמו עטיפת האלבום וכו' |
|
icon |
סמל תמונה קטן שמוצג משמאל לכותרת. הוא הוקטן ל-36x36dp. |
StaticListPrompt
כרטיס להצגת רשימה של אפשרויות לבחירה.
ייצוג JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
שדות | |
---|---|
title |
אפשרות. שם הרשימה. |
subtitle |
אפשרות. כותרת המשנה של הרשימה. |
items[] |
חובה. פריטים ברשימה. |
ListItem
פריט ברשימה.
ייצוג JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
שדות | |
---|---|
key |
חובה. מפתח ה-NLU שתואם לשם מפתח הכניסה בסוג המשויך. כשמקישים על פריט, המפתח הזה יפורסם שוב כפרמטר לאפשרות בחירה. |
title |
חובה. שם הפריט. כשמקישים על קיצור הדרך, אפשר לחזור לשיחה מילה במילה, כאילו המשתמש הקליד אותו. כל שם פריט צריך להיות ייחודי בקבוצת הפריטים. |
description |
אפשרות. טקסט גוף הפריט. |
image |
אפשרות. תמונת פריט. |
StaticCollectionPrompt
כרטיס להצגת מגוון אפשרויות לבחירה.
ייצוג JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
שדות | |
---|---|
title |
אפשרות. שם האוסף. |
subtitle |
אפשרות. כותרת המשנה של האוסף. |
items[] |
חובה. פריטים באוסף. |
imageFill |
אפשרות. סוג אפשרות תצוגת התמונה. |
CollectionItem
פריט באוסף.
ייצוג JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
שדות | |
---|---|
key |
חובה. מפתח NLU שתואם לשם מפתח הכניסה בסוג המשויך. כשמקישים על פריט, המפתח הזה יפורסם שוב כפרמטר לאפשרות בחירה. |
title |
חובה. שם הפריט. כשמקישים על קיצור הדרך, אפשר לחזור לשיחה מילה במילה, כאילו המשתמש הקליד אותו. כל שם פריט צריך להיות ייחודי בקבוצת הפריטים. |
description |
אפשרות. טקסט גוף הפריט. |
image |
אפשרות. תמונת פריט. |
הצעה
מייצג צ'יפ של הצעה, רכיב בממשק המשתמש שמוצג למשתמש לנוחותו.
ייצוג JSON | |
---|---|
{ "title": string } |
שדות | |
---|---|
title |
חובה. הטקסט שמוצג בצ'יפ ההצעות. כשמקישים על קיצור הדרך, אפשר לחזור לשיחה מילה במילה, כאילו המשתמש הקליד אותו. כל שם צריך להיות ייחודי בקבוצת הצ'יפים של ההצעות. 25 תווים לכל היותר |
StaticCanvasPrompt
מייצג את התגובה האינטראקטיבית של לוח הציור שתישלח למשתמש. אפשר להשתמש בערך הזה בשילוב עם השדה 'firstSimple' בהנחיה שמכילה כדי לדבר אל המשתמש, בנוסף להצגת תגובה אינטראקטיבית בבד ציור.
ייצוג JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean } |
שדות | |
---|---|
url |
חובה. כתובת ה-URL של תצוגת האינטרנט לטעינה. |
data[] |
אפשרות. נתוני JSON שיועברו לדף האינטרנט של החוויה הסוחפת כאירוע. אם השדה 'שינוי' בהנחיה שמכילה הוא 'FALSE', ערכי הנתונים שהוגדרו בבקשת ההדפסה על קנבס יתווספו אחרי ערכי הנתונים שהוגדרו בהנחיות הקודמות של לוח הציור. |
suppressMic |
אפשרות. ערך אמיתי פירושו שהמיקרופון לא ייפתח לצורך הקלטת קלט אחרי שהתגובה העשירה הזו תוצג למשתמש. |