Message

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

ייצוג ב-JSON 
{
  "timestamp": string,
  "messageId": string,

  // Union field kind can be only one of the following:
  "userMessage": {
    object (UserMessage)
  },
  "systemMessage": {
    object (SystemMessage)
  }
  // End of list of possible types for union field kind.
}
שדות
timestamp

string (Timestamp format)

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

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
messageId

string

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

object (UserMessage)

הודעה מהמשתמש שמקיים אינטראקציה עם המערכת.
systemMessage

object (SystemMessage)

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

UserMessage

הודעה מהמשתמש שמקיים אינטראקציה עם המערכת.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "text": string
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג התוכן בהודעה של המשתמש. הערך kind יכול להיות רק אחד מהבאים:
text

string

צריך להשתמש בשדה הזה במקום ב-blob.

SystemMessage

הודעה מהמערכת בתגובה למשתמש. ההודעה הזו יכולה להיות גם הודעה מהמשתמש כהקשר היסטורי לשיחות מרובות תורות עם המערכת.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "text": {
    object (TextMessage)
  },
  "schema": {
    object (SchemaMessage)
  },
  "data": {
    object (DataMessage)
  },
  "analysis": {
    object (AnalysisMessage)
  },
  "chart": {
    object (ChartMessage)
  },
  "error": {
    object (ErrorMessage)
  },
  "exampleQueries": {
    object (ExampleQueries)
  },
  "clarification": {
    object (ClarificationMessage)
  }
  // End of list of possible types for union field kind.
  "groupId": integer
}
שדות
שדה איחוד kind. סוג התוכן בהודעת המערכת. הערך kind יכול להיות רק אחד מהבאים:
text

object (TextMessage)

תשובה ישירה בשפה טבעית להודעה של המשתמש.
schema

object (SchemaMessage)

הודעה שנוצרת במהלך פתרון סכמה.
data

object (DataMessage)

הודעה שנוצרת במהלך אחזור נתונים.
analysis

object (AnalysisMessage)

הודעה שנוצרה במהלך הניתוח.
chart

object (ChartMessage)

הודעה שנוצרת במהלך יצירת התרשים.
error

object (ErrorMessage)

הודעת שגיאה.
exampleQueries

object (ExampleQueries)

זה שינוי אופציונלי. הודעה שמכילה שאילתות לדוגמה.
clarification
(deprecated)

object (ClarificationMessage)

זה שינוי אופציונלי. הוצא משימוש: במקומו צריך להשתמש ב-TextMessage עם TextType.FINAL_RESPONSE. הודעה עם שאלות הבהרה.
groupId

integer

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

TextMessage

הודעת טקסט מרובת חלקים.

ייצוג ב-JSON 
{
  "parts": [
    string
  ],
  "textType": enum (TextType),
  "thoughtSignature": string
}
שדות
parts[]

string

זה שינוי אופציונלי. החלקים של ההודעה.
textType

enum (TextType)

זה שינוי אופציונלי. סוג הודעת הטקסט.
thoughtSignature

string (bytes format)

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

מחרוזת בקידוד Base64.

TextType

סוג הודעת הטקסט.

טיפוסים בני מנייה (enum)
TEXT_TYPE_UNSPECIFIED סוג ברירת המחדל של הטקסט.
FINAL_RESPONSE הטקסט הוא תשובה סופית לשאלה של המשתמש.
THOUGHT הטקסט הוא מחשבה של המודל.
PROGRESS הטקסט הוא הודעת מידע על ההתקדמות של הסוכן, למשל הפעלה של כלי. ההודעה הזו שונה מתהליך החשיבה הפנימי של הסוכן (THOUGHT) ומהתשובה הסופית למשתמש (FINAL_RESPONSE). ההודעות האלה מספקות תובנות לגבי הפעולות של הסוכן.

SchemaMessage

הודעה שנוצרת במהלך פתרון סכמה.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "query": {
    object (SchemaQuery)
  },
  "result": {
    object (SchemaResult)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. האם ההודעה הזו מכילה את השאילתה או את התוצאה של פתרון הסכימה. הערך kind יכול להיות רק אחד מהבאים:
query

object (SchemaQuery)

שאילתה לפתרון סכימה.
result

object (SchemaResult)

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

SchemaQuery

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

ייצוג ב-JSON 
{
  "question": string
}
שדות
question

string

זה שינוי אופציונלי. השאלה שצריך לשלוח למערכת כדי לפתור את הסכימה.

SchemaResult

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

ייצוג ב-JSON 
{
  "datasources": [
    {
      object (Datasource)
    }
  ]
}
שדות
datasources[]

object (Datasource)

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

מקור נתונים

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

ייצוג ב-JSON 
{
  "schema": {
    object (Schema)
  },
  "structSchema": {
    object
  },

  // Union field reference can be only one of the following:
  "bigqueryTableReference": {
    object (BigQueryTableReference)
  },
  "studioDatasourceId": string,
  "lookerExploreReference": {
    object (LookerExploreReference)
  },
  "alloyDbReference": {
    object (AlloyDbReference)
  },
  "spannerReference": {
    object (SpannerReference)
  },
  "cloudSqlReference": {
    object (CloudSqlReference)
  }
  // End of list of possible types for union field reference.
}
שדות
schema

object (Schema)

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

object (Struct format)

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

במקורות נתונים של Looker, המיפוי הזה מתבצע לסוג LookmlModelExplore: https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore
שדה איחוד reference. ההפניה למקור הנתונים. הערך reference יכול להיות רק אחד מהבאים:
bigqueryTableReference

object (BigQueryTableReference)

הפניה לטבלה ב-BigQuery.
studioDatasourceId

string

הפניה למקור נתונים ב-Looker Studio.
lookerExploreReference

object (LookerExploreReference)

הפניה ל-Looker Explore.
alloyDbReference

object (AlloyDbReference)

הפניה למסד נתונים של AlloyDB.
spannerReference

object (SpannerReference)

הפניה למסד נתונים של Spanner.
cloudSqlReference

object (CloudSqlReference)

הפניה למסד נתונים של CloudSQL.

DataMessage

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

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "query": {
    object (DataQuery)
  },
  "generatedSql": string,
  "result": {
    object (DataResult)
  },
  "generatedLookerQuery": {
    object (LookerQuery)
  },
  "bigQueryJob": {
    object (BigQueryJob)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. האם ההודעה הזו מכילה את השאילתה, את התוצאה או את ה-SQL שנוצר לאחזור הנתונים. הערך kind יכול להיות רק אחד מהבאים:
query

object (DataQuery)

שאילתה לאחזור נתונים.
generatedSql

string

SQL שנוצר על ידי המערכת כדי לאחזר נתונים.
result

object (DataResult)

הנתונים שאוחזרו.
generatedLookerQuery
(deprecated)

object (LookerQuery)

שאילתת Looker שנוצרה על ידי המערכת כדי לאחזר נתונים. הוצא משימוש: שאילתת Looker שנוצרה נמצאת עכשיו ב-DataQuery.looker.
bigQueryJob

object (BigQueryJob)

עבודת BigQuery שהמערכת מבצעת כדי לאחזר נתונים.

DataQuery

שאילתה לאחזור נתונים.

ייצוג ב-JSON 
{
  "question": string,
  "name": string,
  "datasources": [
    {
      object (Datasource)
    }
  ],

  // Union field query_type can be only one of the following:
  "looker": {
    object (LookerQuery)
  }
  // End of list of possible types for union field query_type.
}
שדות
question

string

זה שינוי אופציונלי. שאלה בשפה טבעית שצריך לענות עליה.
name

string

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

  • דוגמה: "total_sales_by_product"
  • דוגמה: sales_for_product_12345
datasources[]

object (Datasource)

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

object (LookerQuery)

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

DataResult

הנתונים שאוחזרו.

ייצוג ב-JSON 
{
  "name": string,
  "schema": {
    object (Schema)
  },
  "data": [
    {
      object
    }
  ],
  "formattedData": [
    {
      object
    }
  ]
}
שדות
name

string

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

  • דוגמה: "total_sales_by_product"
  • דוגמה: sales_for_product_12345
schema

object (Schema)

זה שינוי אופציונלי. הסכימה של הנתונים.
data[]

object (Struct format)

זה שינוי אופציונלי. התוכן של הנתונים. כל שורה היא מבנה שתואם לסכימה. ערכים פשוטים מיוצגים כמחרוזות, ומבנים מוטמעים מיוצגים כרשימות או כמבנים.
formattedData[]

object (Struct format)

זה שינוי אופציונלי. ייצוג מעוצב של הנתונים, אם רלוונטי. כל שורה היא מבנה שתואם ישירות לשורה באותו אינדקס בשדה data. הערכים שלו הם ייצוגים של הנתונים המקוריים כמחרוזת, בפורמט שנקבע במפרט של מקור הנתונים (לדוגמה, ‎"$1,234.56" למטבע). בעמודות ללא עיצוב יוצג ערך ברירת המחדל שלהן. אם לא הוגדרו כללי עיצוב לעמודות, השדה הזה יהיה ריק.

BigQueryJob

עבודה ב-BigQuery שהמערכת מבצעת.

ייצוג ב-JSON 
{
  "projectId": string,
  "jobId": string,
  "location": string,
  "destinationTable": {
    object (BigQueryTableReference)
  },
  "schema": {
    object (Schema)
  }
}
שדות
projectId

string

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

מידע נוסף זמין במאמר בנושא JobReference.
jobId

string

חובה. המזהה של המשרה.

מידע נוסף זמין במאמר בנושא JobReference.
location

string

זה שינוי אופציונלי. מיקום המשרה.

מידע נוסף זמין במאמר בנושא JobReference.
destinationTable

object (BigQueryTableReference)

זה שינוי אופציונלי. הפניה לטבלת היעד של תוצאות השאילתה של העבודה.

מידע נוסף זמין במאמר בנושא JobConfigurationQuery.
schema

object (Schema)

זה שינוי אופציונלי. הסכימה של תוצאות השאילתה של העבודה.

ראו JobStatistics2.

AnalysisMessage

הודעה שנוצרה במהלך הניתוח.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "query": {
    object (AnalysisQuery)
  },
  "progressEvent": {
    object (AnalysisEvent)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. האם ההודעה מכילה את השאילתה או אחד מהאירועים מהניתוח. הערך kind יכול להיות רק אחד מהבאים:
query

object (AnalysisQuery)

שאילתת ניתוח.
progressEvent

object (AnalysisEvent)

אירוע שמציין את התקדמות הניתוח.

AnalysisQuery

שאילתה לביצוע ניתוח.

ייצוג ב-JSON 
{
  "question": string,
  "dataResultNames": [
    string
  ]
}
שדות
question

string

זה שינוי אופציונלי. שאלת ניתוח שתעזור לענות על השאלה המקורית של המשתמש.
dataResultNames[]

string

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

AnalysisEvent

אירוע שמציין את התקדמות הניתוח.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "plannerReasoning": string,
  "coderInstruction": string,
  "code": string,
  "executionOutput": string,
  "executionError": string,
  "resultVegaChartJson": string,
  "resultNaturalLanguage": string,
  "resultCsvData": string,
  "resultReferenceData": string,
  "error": string
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג האירוע שהתרחש במהלך הניתוח. הערך kind יכול להיות רק אחד מהבאים:
plannerReasoning

string

ההיגיון של מתכנן יצירת הקוד ב-Python.
coderInstruction

string

הוראות שניתנו ליצירת קוד.
code

string

קוד שנוצר.
executionOutput

string

פלט מהרצת הקוד.
executionError

string

שגיאה בהפעלת הקוד.
resultVegaChartJson

string

התוצאה כמחרוזת JSON של תרשים Vega.
resultNaturalLanguage

string

התוצאה כמחרוזת בשפה טבעית.
resultCsvData

string

התוצאה כמחרוזת CSV.
resultReferenceData

string

התוצאה כהפניה למקור נתונים.
error

string

הודעת שגיאה כללית.

ChartMessage

הודעה שנוצרת במהלך יצירת התרשים.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "query": {
    object (ChartQuery)
  },
  "result": {
    object (ChartResult)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. האם ההודעה הזו מכילה את השאילתה או את התוצאה של יצירת התרשים. הערך kind יכול להיות רק אחד מהבאים:
query

object (ChartQuery)

שאילתה ליצירת תרשים.
result

object (ChartResult)

התוצאה של שאילתה ליצירת תרשים.

ChartQuery

שאילתה ליצירת תרשים.

ייצוג ב-JSON 
{
  "instructions": string,
  "dataResultName": string
}
שדות
instructions

string

זה שינוי אופציונלי. הוראות בשפה טבעית ליצירת התרשים.
dataResultName

string

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

ChartResult

התוצאה של שאילתה ליצירת תרשים.

ייצוג ב-JSON 
{
  "vegaConfig": {
    object
  },
  "image": {
    object (Blob)
  }
}
שדות
vegaConfig

object (Struct format)

זה שינוי אופציונלי. הגדרת תרשים Vega שנוצרה. מידע נוסף זמין בכתובת https://vega.github.io/vega/docs/config/
image

object (Blob)

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

Blob

בלוב של נתונים עם סוג MIME.

ייצוג ב-JSON 
{
  "mimeType": string,
  "data": string
}
שדות
mimeType

string

חובה. סוג ה-MIME של נתוני ההודעה לפי תקן IANA.
data

string (bytes format)

חובה. הנתונים מיוצגים בבייטים.

מחרוזת בקידוד Base64.

ErrorMessage

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

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

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

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

string

פלט בלבד. הטקסט של השגיאה.

ExampleQueries

הודעה שמכילה שאילתות לדוגמה שנוצרו או נגזרו.

ייצוג ב-JSON 
{
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
שדות
exampleQueries[]

object (ExampleQuery)

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

ClarificationMessage

הוצא משימוש: במקומו צריך להשתמש ב-TextMessage עם TextType.FINAL_RESPONSE. הודעה עם שאלות שיעזרו להבהיר את השאילתה של המשתמש. התשובה הזו מוחזרת כשהמערכת לא יכולה לענות על השאלה של המשתמש בוודאות.

ייצוג ב-JSON 
{
  "questions": [
    {
      object (ClarificationQuestion)
    }
  ]
}
שדות
questions[]
(deprecated)

object (ClarificationQuestion)

חובה. הוצאה משימוש: הודעת ההורה הוצאה משימוש. קבוצה של שאלות הבהרה שצריך לשאול את המשתמש.

ClarificationQuestion

הוצא משימוש: במקומו צריך להשתמש ב-TextMessage עם TextType.FINAL_RESPONSE. מייצג שאלה אחת שמוצגת למשתמש כדי להבהיר את השאילתה שלו.

ייצוג ב-JSON 
{
  "question": string,
  "selectionMode": enum (SelectionMode),
  "options": [
    string
  ],
  "clarificationQuestionType": enum (ClarificationQuestionType)
}
שדות
question
(deprecated)

string

חובה. הוצאה משימוש: הודעת ההורה הוצאה משימוש. השאלה בשפה טבעית שמוצגת למשתמש.
selectionMode
(deprecated)

enum (SelectionMode)

חובה. הוצאה משימוש: הודעת ההורה הוצאה משימוש. מצב הבחירה של השאלה.
options[]
(deprecated)

string

חובה. הוצאה משימוש: הודעת ההורה הוצאה משימוש. רשימה של אפשרויות שונות שהמשתמש יכול לבחור מתוכן. מספר האפשרויות מוגבל ל-5 לכל היותר.
clarificationQuestionType
(deprecated)

enum (ClarificationQuestionType)

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

SelectionMode

הוצאה משימוש: הודעת ההורה הוצאה משימוש. מצב הבחירה של שאלת ההבהרה.

טיפוסים בני מנייה (enum)
SELECTION_MODE_UNSPECIFIED

הוצאה משימוש: הודעת ההורה הוצאה משימוש. מצב הבחירה לא צוין.
SINGLE_SELECT

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

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

ClarificationQuestionType

הוצאה משימוש: הודעת ההורה הוצאה משימוש. סוג שאלת ההבהרה. יכול להיות שבעתיד יתווספו ערכים חדשים ל-enum הזה.

טיפוסים בני מנייה (enum)
CLARIFICATION_QUESTION_TYPE_UNSPECIFIED

הוצאה משימוש: הודעת ההורה הוצאה משימוש. סוג השאלה להבהרה לא צוין.
FILTER_VALUES

הוצאה משימוש: הודעת ההורה הוצאה משימוש. שאלת ההבהרה היא לגבי ערכי המסנן.
FIELDS

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