- ייצוג ב-JSON
- UserMessage
- SystemMessage
- TextMessage
- SchemaMessage
- SchemaQuery
- SchemaResult
- Datasource
- DataMessage
- DataQuery
- DataResult
- LookerQuery
- מסנן
- BigQueryJob
- AnalysisMessage
- AnalysisQuery
- AnalysisEvent
- ChartMessage
- ChartQuery
- ChartResult
- Blob
- ErrorMessage
הודעה כתוצאה מאינטראקציה בין המשתמש למערכת.
ייצוג ב-JSON |
---|
{ "timestamp": string, "messageId": string, // Union field |
שדות | |
---|---|
timestamp |
פלט בלבד. בהודעות של משתמשים, זהו המועד שבו המערכת קיבלה את ההודעה. בהודעות מהמערכת, זהו המועד שבו המערכת יצרה את ההודעה. הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: |
messageId |
אופציונלי. המזהה הייחודי של ההודעה בשיחה לצורך שמירה. |
שדה האיחוד kind . סוג ההודעה. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
userMessage |
הודעה מהמשתמש שמקיים אינטראקציה עם המערכת. |
systemMessage |
הודעה מהמערכת בתגובה למשתמש. |
UserMessage
הודעה מהמשתמש שמקיים אינטראקציה עם המערכת.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד kind . סוג התוכן בהודעה של המשתמש. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
text |
צריך להשתמש בשדה הזה במקום ב-blob. |
SystemMessage
הודעה מהמערכת בתגובה למשתמש. ההודעה הזו יכולה להיות גם הודעה מהמשתמש כרקע היסטורי לשיחות עם המערכת שמתנהלות בכמה סבבים.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד kind . סוג התוכן בהודעת המערכת. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
text |
תגובה ישירה בשפה טבעית להודעת המשתמש. |
schema |
הודעה שנוצרת במהלך פתרון הסכימה. |
data |
הודעה שנוצרת במהלך אחזור הנתונים. |
analysis |
הודעה שנוצרה במהלך הניתוח. |
chart |
הודעה שנוצרת במהלך יצירת התרשים. |
error |
הודעת שגיאה. |
TextMessage
הודעת טקסט שמחולקת לכמה חלקים.
ייצוג ב-JSON |
---|
{ "parts": [ string ] } |
שדות | |
---|---|
parts[] |
פלט בלבד. החלקים של ההודעה. |
SchemaMessage
הודעה שנוצרת במהלך פתרון הסכימה.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד kind . האם ההודעה הזו מכילה את השאילתה או את התוצאה של פתרון הסכימה. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
query |
שאילתה לפתרון סכימה. |
result |
התוצאה של שאילתה לפתרון סכימה. |
SchemaQuery
שאילתת פתרון של הסכימה הרלוונטית לשאלה שהוצגה.
ייצוג ב-JSON |
---|
{ "question": string } |
שדות | |
---|---|
question |
פלט בלבד. השאלה ששולחים למערכת לצורך פתרון הסכימה. |
SchemaResult
התוצאה של פתרון הסכימה.
ייצוג ב-JSON |
---|
{
"datasources": [
{
object ( |
שדות | |
---|---|
datasources[] |
פלט בלבד. מקורות הנתונים ששימשו לפתרון שאילתה של הסכימה. |
מקור נתונים
מקור נתונים שאפשר להשתמש בו כדי לענות על שאלות.
ייצוג ב-JSON |
---|
{ "schema": { object ( |
שדות | |
---|---|
schema |
פלט בלבד. הסכימה של מקור הנתונים. |
שדה האיחוד reference . ההפניה למקור הנתונים. הערך של reference יכול להיות רק אחת מהאפשרויות הבאות: |
|
bigqueryTableReference |
הפניה לטבלה ב-BigQuery. |
studioDatasourceId |
הפניה למקור נתונים ב-Looker Studio. |
lookerExploreReference |
הפניה לאפשרות נוספת ב-Looker. |
DataMessage
הודעה שנוצרת במהלך אחזור הנתונים.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד kind . האם ההודעה הזו מכילה את השאילתה, את התוצאה או את שאילתת ה-SQL שנוצרה לאחזור הנתונים. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
query |
שאילתה לאחזור נתונים. |
generatedSql |
שאילתת SQL שנוצרה על ידי המערכת כדי לאחזר נתונים. |
result |
הנתונים שאוחזרו. |
generatedLookerQuery |
שאילתה של Looker שנוצרה על ידי המערכת כדי לאחזר נתונים. |
bigQueryJob |
משימה ב-BigQuery שהמערכת מבצעת כדי לאחזר נתונים. |
DataQuery
שאילתה לאחזור נתונים.
ייצוג ב-JSON |
---|
{
"name": string,
"question": string,
"datasources": [
{
object ( |
שדות | |
---|---|
name |
פלט בלבד. שם של שאילתות באותיות רישיות קטנות, שמשקף את הכוונה שלהן. הוא משמש למתן שם לתוצאת הנתונים התואמת, כדי שניתן יהיה להפנות אליה בשלבים הבאים. דוגמה: 'total_sales_by_product' דוגמה: 'sales_for_product_12345' |
question |
פלט בלבד. השאלה שעליה רוצים לענות. |
datasources[] |
פלט בלבד. מקורות הנתונים שזמינים כדי לענות על השאלה. |
DataResult
הנתונים שאוחזרו.
ייצוג ב-JSON |
---|
{
"name": string,
"schema": {
object ( |
שדות | |
---|---|
name |
פלט בלבד. שם בתווית נחש לתוצאת הנתונים שמשקף את התוכן שלה. השם משמש להעברת התוצאה באמצעות הפניה, ומשמש כאות למשמעות שלה. דוגמה: 'total_sales_by_product' דוגמה: 'sales_for_product_12345' |
schema |
פלט בלבד. הסכימה של הנתונים. |
data[] |
פלט בלבד. תוכן הנתונים. כל שורה היא מבנה (struct) שתואמת לסכימה. ערכים פשוטים מיוצגים כמחרוזות, ומבנים בתצוגת עץ מיוצגים כרשימות או כ-structs. |
LookerQuery
שאילתת אחזור נתונים מ-Looker Explore. ראו הרצת שאילתה בתוך שורה.
ייצוג ב-JSON |
---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
שדות | |
---|---|
model |
חובה. מודל LookML ששימש ליצירת השאילתה. |
explore |
חובה. ניתוח LookML ששימש ליצירת השאילתה. |
fields[] |
זה שינוי אופציונלי. השדות שאתם רוצים לאחזר מהניתוח. |
filters[] |
זה שינוי אופציונלי. המסננים שיחולו על הניתוח. |
sorts[] |
זה שינוי אופציונלי. הסדרות שיחולו על הניתוח. |
limit |
זה שינוי אופציונלי. הגבלה בשאילתה. |
מסנן
מסנן שאילתות ב-Looker.
ייצוג ב-JSON |
---|
{ "field": string, "value": string } |
שדות | |
---|---|
field |
חובה. השדה שבו יתבצע הסינון. |
value |
חובה. השדה f של הערך שרוצים לסנן לפיו. |
BigQueryJob
משימה ב-BigQuery שהמערכת מבצעת.
ייצוג ב-JSON |
---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
שדות | |
---|---|
projectId |
חובה. הפרויקט שאליו משויכת המשימה. |
jobId |
חובה. המזהה של המשימה. |
location |
זה שינוי אופציונלי. המיקום של המשימה. |
destinationTable |
פלט בלבד. הפניה לטבלת היעד של תוצאות השאילתה של המשימה. מידע נוסף זמין במאמר JobConfigurationQuery. |
schema |
פלט בלבד. הסכימה של תוצאות השאילתה של המשימה. ראו JobStatistics2. |
AnalysisMessage
הודעה שנוצרה במהלך הניתוח.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד kind . אם ההודעה הזו מכילה את השאילתה או אחד מהאירועים מהניתוח. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
query |
שאילתת ניתוח. |
progressEvent |
אירוע שמציין את התקדמות הניתוח. |
AnalysisQuery
שאילתה לביצוע ניתוח.
ייצוג ב-JSON |
---|
{ "question": string, "dataResultNames": [ string ] } |
שדות | |
---|---|
question |
פלט בלבד. שאלה לניתוח שתעזור לענות על השאלה המקורית של המשתמש. |
dataResultNames[] |
פלט בלבד. השמות של תוצאות הנתונים שאוחזרו בעבר לצורך ניתוח. |
AnalysisEvent
אירוע שמציין את ההתקדמות של ניתוח.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד kind . סוג האירוע שהתרחש במהלך הניתוח. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
plannerReasoning |
ההיגיון של מתכנן ה-codegen של Python. |
coderInstruction |
הוראות שהונפקו ליצירת קוד. |
code |
הקוד שנוצר. |
executionOutput |
הפלט של הרצת הקוד. |
executionError |
שגיאה בהפעלת הקוד. |
resultVegaChartJson |
התוצאה כמחרוזת JSON של תרשים Vega. |
resultNaturalLanguage |
התוצאה כמחרוזת NL. |
resultCsvData |
התוצאה כמחרוזת CSV. |
resultReferenceData |
תוצאה כהפניה למקור נתונים. |
error |
הודעת שגיאה כללית. |
ChartMessage
הודעה שנוצרה במהלך יצירת התרשים.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד kind . האם ההודעה הזו מכילה את השאילתה או את התוצאה של יצירת התרשים. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות: |
|
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
blob של נתונים עם סוג MIME.
ייצוג ב-JSON |
---|
{ "mimeType": string, "data": string } |
שדות | |
---|---|
mimeType |
חובה. סוג ה-MIME הסטנדרטי של IANA של נתוני ההודעה. |
data |
חובה. הנתונים מיוצגים כבייט. מחרוזת בקידוד Base64. |
ErrorMessage
הודעת שגיאה.
ייצוג ב-JSON |
---|
{ "text": string } |
שדות | |
---|---|
text |
פלט בלבד. הטקסט של השגיאה. |