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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה האיחוד kind. סוג התוכן בהודעת המערכת. הערך של kind יכול להיות רק אחת מהאפשרויות הבאות:
text

object (TextMessage)

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

schema

object (SchemaMessage)

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

data

object (DataMessage)

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

analysis

object (AnalysisMessage)

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

chart

object (ChartMessage)

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

error

object (ErrorMessage)

הודעת שגיאה.

TextMessage

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

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

string

פלט בלבד. החלקים של ההודעה.

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)
  },

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

object (Schema)

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

שדה האיחוד reference. ההפניה למקור הנתונים. הערך של reference יכול להיות רק אחת מהאפשרויות הבאות:
bigqueryTableReference

object (BigQueryTableReference)

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

studioDatasourceId

string

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

lookerExploreReference

object (LookerExploreReference)

הפניה לאפשרות נוספת ב-Looker.

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

object (LookerQuery)

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

bigQueryJob

object (BigQueryJob)

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

DataQuery

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

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

string

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

דוגמה: 'total_sales_by_product' דוגמה: 'sales_for_product_12345'

question

string

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

datasources[]

object (Datasource)

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

DataResult

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

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

string

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

דוגמה: 'total_sales_by_product' דוגמה: 'sales_for_product_12345'

schema

object (Schema)

פלט בלבד. הסכימה של הנתונים.

data[]

object (Struct format)

פלט בלבד. תוכן הנתונים. כל שורה היא מבנה (struct) שתואמת לסכימה. ערכים פשוטים מיוצגים כמחרוזות, ומבנים בתצוגת עץ מיוצגים כרשימות או כ-structs.

LookerQuery

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

ייצוג ב-JSON
{
  "model": string,
  "explore": string,
  "fields": [
    string
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "sorts": [
    string
  ],
  "limit": string
}
שדות
model

string

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

explore

string

חובה. ניתוח LookML ששימש ליצירת השאילתה.

fields[]

string

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

filters[]

object (Filter)

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

sorts[]

string

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

limit

string

זה שינוי אופציונלי. הגבלה בשאילתה.

מסנן

מסנן שאילתות ב-Looker.

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

string

חובה. השדה שבו יתבצע הסינון.

value

string

חובה. השדה f של הערך שרוצים לסנן לפיו.

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

ההיגיון של מתכנן ה-codegen של Python.

coderInstruction

string

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

code

string

הקוד שנוצר.

executionOutput

string

הפלט של הרצת הקוד.

executionError

string

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

resultVegaChartJson

string

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

resultNaturalLanguage

string

התוצאה כמחרוזת NL.

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

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

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

string

חובה. סוג ה-MIME הסטנדרטי של IANA של נתוני ההודעה.

data

string (bytes format)

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

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

ErrorMessage

הודעת שגיאה.

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

string

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