- ייצוג ב-JSON
- UserMessage
- SystemMessage
- TextMessage
- TextType
- SchemaMessage
- SchemaQuery
- SchemaResult
- מקור נתונים
- DataMessage
- DataQuery
- DataResult
- BigQueryJob
- MatchedQuery
- QueryParameterValues
- AnalysisMessage
- AnalysisQuery
- AnalysisEvent
- ChartMessage
- ChartQuery
- ChartResult
- Blob
- ErrorMessage
- ExampleQueries
- ציטוט
- CitationSource
- CitationAnchor
- TextMessageCitationAnchor
הודעה שנוצרת כתוצאה מאינטראקציה בין המשתמש לבין המערכת.
| ייצוג ב-JSON |
|---|
{ "timestamp": string, "messageId": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "userMessage": { object ( |
| שדות | |
|---|---|
timestamp |
פלט בלבד. בהודעות של משתמשים, זה הזמן שבו המערכת קיבלה את ההודעה. בהודעות מערכת, זהו הזמן שבו המערכת יצרה את ההודעה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
messageId |
אופציונלי. מזהה ייחודי של ההודעה בשיחה לצורך שמירה. |
| סוג ההודעה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
userMessage |
הודעה מהמשתמש שמקיים אינטראקציה עם המערכת. |
systemMessage |
הודעה מהמערכת בתגובה למשתמש. |
| סוף השדות הבלעדיים. | |
UserMessage
הודעה מהמשתמש שמקיים אינטראקציה עם המערכת.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string // End of mutually exclusive fields. } |
| שדות | |
|---|---|
| סוג התוכן בהודעה של המשתמש. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
text |
צריך להשתמש בשדה הזה במקום ב-blob. |
| סוף השדות הבלעדיים. | |
SystemMessage
הודעה מהמערכת בתגובה למשתמש. ההודעה הזו יכולה להיות גם הודעה מהמשתמש כהקשר היסטורי לשיחות רב-שלביות עם המערכת.
| ייצוג ב-JSON |
|---|
{ "citation": { object ( |
| שדות | |
|---|---|
citation |
פלט בלבד. פרטי הציטוט של הודעת המערכת. |
| סוג התוכן בהודעת המערכת. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
text |
תגובה ישירה בשפה טבעית להודעה של המשתמש. |
schema |
הודעה שנוצרת במהלך פתרון סכמה. |
data |
הודעה שנוצרת במהלך אחזור נתונים. |
analysis |
הודעה שנוצרה במהלך הניתוח. |
chart |
הודעה שמוצגת במהלך יצירת התרשים. |
error |
הודעת שגיאה. |
exampleQueries |
זה שינוי אופציונלי. הודעה שמכילה שאילתות לדוגמה. |
| סוף השדות הבלעדיים. | |
groupId |
מזהה את הקבוצה שאליה האירוע שייך. אירועים דומים נחשבים כרלוונטיים זה לזה מבחינה לוגית, ולכן הם צריכים להופיע יחד בממשק המשתמש. |
TextMessage
הודעת טקסט מרובת חלקים.
| ייצוג ב-JSON |
|---|
{
"parts": [
string
],
"textType": enum ( |
| שדות | |
|---|---|
parts[] |
זה שינוי אופציונלי. החלקים של ההודעה. |
textType |
זה שינוי אופציונלי. סוג הודעת הטקסט. |
thoughtSignature |
זה שינוי אופציונלי. חתימה אטומה למחשבה, כדי שאפשר יהיה לעשות בה שימוש חוזר בבקשות הבאות. מחרוזת בקידוד Base64. |
TextType
סוג הודעת הטקסט.
| טיפוסים בני מנייה (enum) | |
|---|---|
TEXT_TYPE_UNSPECIFIED |
סוג הטקסט שמוגדר כברירת מחדל. |
FINAL_RESPONSE |
הטקסט הוא תשובה סופית לשאלה של המשתמש. |
THOUGHT |
הטקסט הוא מחשבה של המודל. |
PROGRESS |
הטקסט הוא הודעת מידע על ההתקדמות של הסוכן, למשל הפעלה של כלי. ההודעות האלה שונות מתהליך החשיבה הפנימי של הסוכן (THOUGHT) ומהתשובה הסופית למשתמש (FINAL_RESPONSE). הן מספקות תובנות לגבי הפעולות של הסוכן. |
FOLLOWUP_QUESTIONS |
הטקסט הוא רשימה של הצעות לשאלות המשך. כל פריט ב-parts הוא שאלת המשך. |
SchemaMessage
הודעה שנוצרת במהלך פתרון סכמה.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| שדות | |
|---|---|
| האם ההודעה הזו מכילה את השאילתה או את התוצאה של פתרון הסכימה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
query |
שאילתה לפתרון סכמה. |
result |
התוצאה של שאילתת פתרון סכימה. |
| סוף השדות הבלעדיים. | |
SchemaQuery
שאילתה לפתרון הסכימה שרלוונטית לשאלה שהוצגה.
| ייצוג ב-JSON |
|---|
{ "question": string } |
| שדות | |
|---|---|
question |
זה שינוי אופציונלי. השאלה לשליחה למערכת לפתרון סכימה. |
SchemaResult
התוצאה של פתרון הסכימה.
| ייצוג ב-JSON |
|---|
{
"datasources": [
{
object ( |
| שדות | |
|---|---|
datasources[] |
זה שינוי אופציונלי. מקורות הנתונים שמשמשים לפתרון שאילתת הסכימה. |
מקור נתונים
מקור נתונים שאפשר להשתמש בו כדי לענות על שאלות.
| ייצוג ב-JSON |
|---|
{ "schema": { object ( |
| שדות | |
|---|---|
schema |
זה שינוי אופציונלי. הסכימה של מקור הנתונים. |
structSchema |
זה שינוי אופציונלי. ייצוג של הסכימה במבנה. השדה הזה מאוכלס במקורות נתונים עם סכימות שלא ניתן לייצג באופן מלא באמצעות השדה במקורות נתונים של Looker, המיפוי הוא לסוג LookmlModelExplore: https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore |
| ההפניה למקור הנתונים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
bigqueryTableReference |
הפניה לטבלה ב-BigQuery. |
studioDatasourceId |
הפניה למקור נתונים ב-Looker Studio. |
lookerExploreReference |
הפניה ל-Explore ב-Looker. |
bigqueryPropertyGraphReference |
הפניה לגרף נכס ב-BigQuery. |
| סוף השדות הבלעדיים. | |
DataMessage
הודעה שנוצרת במהלך אחזור נתונים.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| שדות | |
|---|---|
| האם ההודעה מכילה את השאילתה, את התוצאה או את ה-SQL שנוצר לאחזור הנתונים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
query |
שאילתה לאחזור נתונים. |
generatedSql |
שאילתת SQL שנוצרה על ידי המערכת כדי לאחזר נתונים. |
result |
הנתונים אוחזרו. |
bigQueryJob |
עבודת BigQuery שהמערכת מבצעת כדי לאחזר נתונים. |
matchedQuery |
שאילתה קיימת שהותאמה לאחזור נתונים. |
| סוף השדות הבלעדיים. | |
DataQuery
שאילתה לאחזור נתונים.
| ייצוג ב-JSON |
|---|
{ "question": string, "name": string, "datasources": [ { object ( |
| שדות | |
|---|---|
question |
זה שינוי אופציונלי. שאלה בשפה טבעית שצריך לענות עליה. |
name |
זה שינוי אופציונלי. שם בפורמט snake_case לשאילתה, שמשקף את הכוונה שלה. הוא משמש למתן שם לתוצאת הנתונים המתאימה, כדי שאפשר יהיה להפנות אליה בשלבים מאוחרים יותר.
|
datasources[] |
זה שינוי אופציונלי. מקורות הנתונים שזמינים למענה על השאלה. |
| סוג השאילתה להרצה. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
looker |
זה שינוי אופציונלי. שאילתה לאחזור נתונים מ-Looker Explore. |
| סוף השדות הבלעדיים. | |
DataResult
הנתונים אוחזרו.
| ייצוג ב-JSON |
|---|
{
"name": string,
"schema": {
object ( |
| שדות | |
|---|---|
name |
זה שינוי אופציונלי. שם בפורמט snake_case לתוצאת הנתונים שמשקף את התוכן שלה. השם משמש להעברת התוצאה באמצעות הפניה, ומשמש כסימן לגבי המשמעות שלה.
|
schema |
זה שינוי אופציונלי. הסכימה של הנתונים. |
data[] |
זה שינוי אופציונלי. התוכן של הנתונים. כל שורה היא מבנה שתואם לסכימה. ערכים פשוטים מיוצגים כמחרוזות, ומבנים מוטמעים מיוצגים כרשימות או כמבנים. |
formattedData[] |
זה שינוי אופציונלי. ייצוג מעוצב של הנתונים, כשזה רלוונטי. כל שורה היא מבנה שמתאים ישירות לשורה באותו אינדקס בשדה |
BigQueryJob
משימה ב-BigQuery שהמערכת מבצעת.
| ייצוג ב-JSON |
|---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
| שדות | |
|---|---|
projectId |
חובה. הפרויקט שאליו שייכת המשימה. מידע נוסף על JobReference |
jobId |
חובה. המזהה של העבודה. מידע נוסף על JobReference |
location |
זה שינוי אופציונלי. המיקום של המשרה. מידע נוסף על JobReference |
destinationTable |
זה שינוי אופציונלי. הפניה לטבלת היעד של תוצאות השאילתה של העבודה. מידע נוסף זמין במאמר בנושא JobConfigurationQuery. |
schema |
זה שינוי אופציונלי. הסכימה של תוצאות השאילתה של העבודה. אפשר לעיין ב-JobStatistics2. |
MatchedQuery
הודעה על שאילתה תואמת מייצגת את העובדה שהסוכן מצא שאחת מהשאילתות לדוגמה שסופקו בהקשר רלוונטית לשאלה הנוכחית. הוא יכיל גם מידע נוסף במהלך תהליך ההתאמה.
| ייצוג ב-JSON |
|---|
{ "exampleQuery": { object ( |
| שדות | |
|---|---|
exampleQuery |
השאילתה שהותאמה על סמך שאילתה לדוגמה. |
queryParameterValues[] |
הערכים שחולצו לפרמטרים של השאילתה. |
QueryParameterValues
הודעה עם ערכים של פרמטרים של שאילתה מייצגת את הערכים של הפרמטרים של השאילתה שחולצו משאלת המשתמש על ידי מודל שפה גדולה, על סמך השאילתה לדוגמה.
| ייצוג ב-JSON |
|---|
{ "name": string, "value": string } |
| שדות | |
|---|---|
name |
חובה. שם הפרמטר. |
value |
חובה. הערך של הפרמטר. |
AnalysisMessage
הודעה שנוצרה במהלך הניתוח.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| שדות | |
|---|---|
| האם ההודעה מכילה את השאילתה או אחד מהאירועים מהניתוח. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
query |
שאילתת ניתוח. |
progressEvent |
אירוע שמציין את התקדמות הניתוח. |
| סוף השדות הבלעדיים. | |
AnalysisQuery
שאילתה לביצוע ניתוח.
| ייצוג ב-JSON |
|---|
{ "question": string, "dataResultNames": [ string ] } |
| שדות | |
|---|---|
question |
זה שינוי אופציונלי. שאלה לניתוח שתעזור לענות על השאלה המקורית של המשתמש. |
dataResultNames[] |
זה שינוי אופציונלי. השמות של תוצאות נתונים שאוחזרו בעבר לצורך ניתוח. |
AnalysisEvent
אירוע שמציין את התקדמות הניתוח.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "plannerReasoning": string, "coderInstruction": string, "code": string, "executionOutput": string, "executionError": string, "resultVegaChartJson": string, "resultNaturalLanguage": string, "resultCsvData": string, "resultReferenceData": string, "error": string // End of mutually exclusive fields. } |
| שדות | |
|---|---|
| סוג האירוע שהתרחש במהלך הניתוח. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
plannerReasoning |
ההיגיון של מתכנן יצירת הקוד ב-Python. |
coderInstruction |
הוראות שניתנו ליצירת קוד. |
code |
קוד שנוצר. |
executionOutput |
פלט מהרצת הקוד. |
executionError |
שגיאה בהרצת הקוד. |
resultVegaChartJson |
התוצאה כמחרוזת JSON של תרשים Vega. |
resultNaturalLanguage |
התוצאה כמחרוזת בשפה טבעית. |
resultCsvData |
התוצאה כמחרוזת CSV. |
resultReferenceData |
התוצאה כהפניה למקור נתונים. |
error |
הודעת שגיאה כללית. |
| סוף השדות הבלעדיים. | |
ChartMessage
הודעה שמוצגת במהלך יצירת התרשים.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| שדות | |
|---|---|
| האם ההודעה מכילה את השאילתה או את התוצאה של יצירת התרשים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
query |
שאילתה ליצירת תרשים. |
result |
התוצאה של שאילתה ליצירת תרשים. |
| סוף השדות הבלעדיים. | |
ChartQuery
שאילתה ליצירת תרשים.
| ייצוג ב-JSON |
|---|
{ "instructions": string, "dataResultName": string } |
| שדות | |
|---|---|
instructions |
זה שינוי אופציונלי. הוראות בשפה טבעית ליצירת התרשים. |
dataResultName |
זה שינוי אופציונלי. השם של תוצאת נתונים שאוחזרה בעבר ורוצים להשתמש בה בתרשים. |
ChartResult
התוצאה של שאילתה ליצירת תרשים.
| ייצוג ב-JSON |
|---|
{
"vegaConfig": {
object
},
"image": {
object ( |
| שדות | |
|---|---|
vegaConfig |
זה שינוי אופציונלי. הגדרה של תרשים Vega שנוצר. מידע נוסף זמין בכתובת https://vega.github.io/vega/docs/config/ |
image |
זה שינוי אופציונלי. רינדור של התרשים אם הוא נדרש בהקשר. |
Blob
בלוב של נתונים עם סוג MIME.
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "data": string } |
| שדות | |
|---|---|
mimeType |
חובה. סוג ה-MIME התקני של IANA של נתוני ההודעה. |
data |
חובה. הנתונים מיוצגים בבייטים. מחרוזת בקידוד Base64. |
ErrorMessage
הודעת שגיאה מקריאה לכלי. ההודעה הזו מייצגת שגיאה שקרתה בזמן שהסוכן ניסה להשתמש בכלי. חשוב לציין שלא כל השגיאות הן סופיות. במקרים רבים אפשר לתקן את השגיאות, והסוכן יכול להשתמש במידע מהודעת השגיאה כדי לתקן את עצמו ולנסות שוב להשתמש בכלי או לנסות גישה אחרת.
לדוגמה, אם שאילתת נתונים נכשלת, יכול להיות שהסוכן יקבל ErrorMessage, ינתח אותו ואז ייצור שאילתה מתוקנת.
הלקוחות צריכים להיזהר כשמפרשים את ההודעה הזו ככשל מוחלט. יכול להיות שהיא חלק מהתהליך הרגיל והאיטרטיבי של הסוכן להשלמת משימה. הצגת השגיאות האלה ישירות למשתמשי הקצה בלי הקשר (למשל, כ "כשל חמור") עלולה להטעות.
| ייצוג ב-JSON |
|---|
{ "text": string } |
| שדות | |
|---|---|
text |
פלט בלבד. הטקסט של השגיאה. |
ExampleQueries
הודעה שמכילה שאילתות לדוגמה שנוצרו או נגזרו.
| ייצוג ב-JSON |
|---|
{
"exampleQueries": [
{
object ( |
| שדות | |
|---|---|
exampleQueries[] |
זה שינוי אופציונלי. רשימה של שאילתות לדוגמה שנוצרו או נגזרו, עם דוגמאות לשאילתות SQL רלוונטיות והכי רווחיות, ושאילתות בשפה טבעית שמתאימות להן (אופציונלי). האפשרות הזו משמשת כרגע רק למקורות נתונים של BigQuery. |
ציטוט
ציון המקורות של התוכן.
| ייצוג ב-JSON |
|---|
{ "sources": [ { object ( |
| שדות | |
|---|---|
sources[] |
פלט בלבד. רשימה של המקורות שמצוטטים. |
anchors[] |
פלט בלבד. רשימה של עוגני הציטוטים. |
CitationSource
המקור של הציטוט.
| ייצוג ב-JSON |
|---|
{ "id": string, "title": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "uri": string, "exampleQuery": { object ( |
| שדות | |
|---|---|
id |
פלט בלבד. מזהה ייחודי של המקור. המזהה הזה נוצר על ידי השירות והוא ייחודי בהיקף של הודעה אחת מסוג |
title |
פלט בלבד. השם של המקור. |
| המקור של הציטוט, שיכול להיות אחד מהסוגים הנתמכים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
uri |
פלט בלבד. כתובת ה-URI שמשמשת כמקור, כמו כתובת URL של הארקה באינטרנט. |
exampleQuery |
פלט בלבד. השאילתה לדוגמה שמשמשת כמקור. |
glossaryTerm |
פלט בלבד. המונח במילון המונחים שמשמש כמקור. |
| סוף השדות הבלעדיים. | |
CitationAnchor
העוגן של ההפניה למקור.
| ייצוג ב-JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"textMessageAnchor": {
object ( |
| שדות | |
|---|---|
| העוגן של הציטוט, שיכול להיות אחד מהסוגים הנתמכים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
textMessageAnchor |
פלט בלבד. מוגדר רק אם הציטוט הוא של הודעת טקסט. |
| סוף השדות הבלעדיים. | |
TextMessageCitationAnchor
עוגן של ציטוט בתוך הודעת טקסט.
| ייצוג ב-JSON |
|---|
{ "partIndex": integer, "startOffsetBytes": integer, "endOffsetBytes": integer, "sourceIds": [ string ] } |
| שדות | |
|---|---|
partIndex |
פלט בלבד. האינדקס של החלק בשדה TextMessage.parts, כשהספירה מתחילה מ-0. |
startOffsetBytes |
פלט בלבד. ההיסט, שנמדד בבייטים בתקן UTF-8, בתוך מחרוזת החלק שבה מתחיל הציטוט (כולל). דוגמה: בטקסט "Hello, world" שבו המילה "world" מצוטטת, בייטים ההיסט (כולל) של ההתחלה הם 7 ובייטים ההיסט (לא כולל) של הסוף הם 12. |
endOffsetBytes |
פלט בלבד. ההיסט, שנמדד בבייטים בקידוד UTF-8, בתוך מחרוזת החלק שבה מסתיים הציטוט (לא כולל). דוגמה: בטקסט "Hello, world" שבו המילה "world" מצוטטת, בייטים ההיסט (כולל) של ההתחלה הם 7 ובייטים ההיסט (לא כולל) של הסוף הם 12. |
sourceIds[] |
פלט בלבד. המזהים של המקורות שמצוטטים. |