- משאב: DataAgent
- DataAnalyticsAgent
- הקשר
- DatasourceReferences
- BigQueryTableReferences
- SearchScope
- BigQueryDatasetReference
- BigQueryTableReference
- סכימה
- שדה
- DataFilter
- DataFilterType
- BigQueryPropertyGraphReference
- StudioDatasourceReferences
- StudioDatasourceReference
- LookerExploreReferences
- LookerExploreReference
- PrivateLookerInstanceInfo
- פרטי כניסה
- OAuthCredentials
- SecretBased
- TokenBased
- AlloyDbReference
- AlloyDbDatabaseReference
- DatabaseTableReference
- AgentContextReference
- SpannerReference
- SpannerDatabaseReference
- מנוע
- CloudSqlReference
- CloudSqlDatabaseReference
- מנוע
- ConversationOptions
- ChartOptions
- ImageOptions
- NoImage
- SvgOptions
- AnalysisOptions
- Python
- DatasourceOptions
- מודל
- ExampleQuery
- QueryParameter
- LookerGoldenQuery
- LookerQuery
- מסנן
- GlossaryTerm
- SchemaRelationship
- SchemaPaths
- מקור
- UserFunctions
- BigQueryRoutine
- BigQueryRoutineReference
- Methods
משאב: DataAgent
הודעה שמתארת אובייקט DataAgent.
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "description": string, "labels": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "purgeTime": string, // Union field |
| שדות | |
|---|---|
name |
זה שינוי אופציונלי. מזהה. שם המשאב הייחודי של DataAgent. פורמט: דוגמה: מומלץ לדלג על הגדרת השדה הזה במהלך יצירת הסוכן, כי הוא יוסק באופן אוטומטי ויוחלף ב-{parent}/dataAgents/{dataAgentId}. |
displayName |
זה שינוי אופציונלי. שם תצוגה ידידותי למשתמש.
|
description |
זה שינוי אופציונלי. תיאור הסוכן.
|
labels |
זה שינוי אופציונלי. תוויות שעוזרות למשתמשים לסנן סוכנים קשורים. לדוגמה, "sales", "business", "etl" וכו'. הערה: תוויות משמשות רק לסינון ולא למדיניות. למידע נוסף על השימוש בתוויות, אפשר לעיין במסמכי התיעוד של התוויות. אובייקט שמכיל רשימה של צמדי |
createTime |
פלט בלבד. השעה שבה נוצר הסוכן לאינטראקציה עם נתונים. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
updateTime |
פלט בלבד. המועד שבו הסוכן לאינטראקציה עם נתונים עודכן לאחרונה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
deleteTime |
פלט בלבד. [פלט בלבד] הזמן שבו הסוכן לאינטראקציה עם נתונים נמחק עם יכולת שחזור. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
purgeTime |
פלט בלבד. חותמת הזמן בשעון UTC שמציינת את הזמן שבו הסוכן לאינטראקציה עם נתונים נחשב כלא בתוקף. השדה הזה תמיד מופיע בפלט, לא משנה מה נשלח בקלט. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
שדה של איחוד type. סוג הנציג. יכול להיות אחת מהאפשרויות הבאות: * סוכן ניתוח נתונים. * סוכן הנדסת נתונים type יכול להיות רק אחד מהבאים: |
|
dataAnalyticsAgent |
סוכן לניתוח נתונים. |
kmsKey |
זה שינוי אופציונלי. מפתח הצפנה בניהול הלקוח (CMEK) שמשמש להצפנת המשאבים של DataAgent. מפתחות Cloud KMS CryptoKeys חייבים להיות באותו מיקום כמו DataAgent. הפורמט הצפוי הוא |
DataAnalyticsAgent
הודעה שמתארת אובייקט DataAnalyticsAgent.
| ייצוג ב-JSON |
|---|
{ "stagingContext": { object ( |
| שדות | |
|---|---|
stagingContext |
זה שינוי אופציונלי. ההקשר של הסביבה לניהול גרסאות ביניים של הסוכן. ההקשר הזה משמש לבדיקה ולאימות של שינויים לפני הפרסום. |
publishedContext |
זה שינוי אופציונלי. ההקשר שפורסם לסוכן. ההקשר הזה משמש את Chat API בסביבת הייצור. |
lastPublishedContext |
פלט בלבד. ההקשר האחרון שפורסם לסוכן. זהו שדה פלט בלבד שהמערכת מאכלסת כשההקשר שפורסם מתעדכן. הוא משמש לשחזור הנציג למצב קודם. |
הקשר
אוסף של הקשרים שאפשר להחיל על השיחה הזו
| ייצוג ב-JSON |
|---|
{ "systemInstruction": string, "datasourceReferences": { object ( |
| שדות | |
|---|---|
systemInstruction |
זה שינוי אופציונלי. נקודת הכניסה הבסיסית לבעלי נתונים שיוצרים ידע בתחום מסוים בשביל Agent. למה: ז'רגון עסקי (למשל, ההכנסה מתחילת השנה מחושבת כ…, גיל הפרישה בארה"ב הוא 65 וכו') והוראות מערכת (למשל, לענות כמו פיראט) יכולים לעזור למודל להבין את ההקשר העסקי של שאלת המשתמש. |
datasourceReferences |
חובה. מקורות נתונים שזמינים למענה על השאלה. |
options |
זה שינוי אופציונלי. אפשרויות נוספות לשיחה. |
exampleQueries[] |
זה שינוי אופציונלי. רשימה של שאילתות לדוגמה, שכוללת דוגמאות לשאילתות SQL רלוונטיות והכי רווחיות, ולפעמים גם את השאילתות המקבילות בשפה טבעית. כרגע משמש רק למקורות נתונים של BigQuery ולמקורות נתונים של מסדי נתונים (alloydb, cloudsql, spanner). |
lookerGoldenQueries[] |
זה שינוי אופציונלי. רשימה של שאילתות לדוגמה, שמספקת דוגמאות לשאילתות רלוונטיות והכי רווחיות ב-Looker ולשאילתות המקבילות שלהן בשפה טבעית, אם יש כאלה. נתמך רק במקורות נתונים של Looker. |
glossaryTerms[] |
זה שינוי אופציונלי. הגדרות של מונחים (כרגע, רק כאלה שנוצרו על ידי משתמשים) לא נתמכות במקורות נתונים של מסדי נתונים (alloydb, cloudsql, spanner). |
schemaRelationships[] |
זה שינוי אופציונלי. קשרים בין סכימות של טבלאות, כולל עמודות שמפנות ועמודות שמפנים אליהן. |
userFunctions |
זה שינוי אופציונלי. אוסף של פונקציות משתמש שייכללו בהקשר. |
DatasourceReferences
אוסף של הפניות למקורות נתונים.
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד references. מקורות הנתונים שבהם רוצים להשתמש. הערך references יכול להיות רק אחד מהבאים: |
|
bq |
הפניות לטבלאות ב-BigQuery. |
studio |
הפניות למקורות נתונים של Looker Studio. |
looker |
הפניות ל-Looker Explores. |
alloydb |
הפניה למסד נתונים של AlloyDB. הפעולה הזו נתמכת רק בשיטה |
spannerReference |
הפניה למסד נתונים של Spanner. הפעולה הזו נתמכת רק בשיטה |
cloudSqlReference |
הפניה למסד נתונים של CloudSql. הפעולה הזו נתמכת רק בשיטה |
BigQueryTableReferences
הודעה שמייצגת הפניות לטבלאות ב-BigQuery ולתרשימי מאפיינים. צריך למלא לפחות אחד מהשדות הבאים: tableReferences, propertyGraphReferences או searchScope.
| ייצוג ב-JSON |
|---|
{ "tableReferences": [ { object ( |
| שדות | |
|---|---|
tableReferences[] |
זה שינוי אופציונלי. הפניות לטבלאות ב-BigQuery. |
propertyGraphReferences[] |
זה שינוי אופציונלי. הפניות לתרשימים ב-BigQuery. הערה: "תרשים נכסים" הוא השם הקודם של BigQuery Graph. שמות השדות וההודעות שומרים על המונח המקורי לצורך תאימות לדורות קודמים. שניהם מתייחסים לאותו משאב. |
searchScope |
זה שינוי אופציונלי. חיפוש במשאבי BigQuery כדי למצוא את הטבלאות הכי רלוונטיות לשאילתה. אם המדיניות מוגדרת, צריך לאכלס לפחות אחד מהשדות הערה: |
SearchScope
הודעה שמייצגת מסננים שאפשר להחיל על חיפוש בטבלאות ב-BigQuery.
צריך לאכלס לפחות אחד מהשדות includeProjectIds או includeDatasetReferences במזהים שאינם ריקים. הטבלאות שתואמות לאחד מהשדות נכללות, כך ששני השדות מאוחדים (OR) ולא מצטלבים.
הערה: SearchScope נתמך רק בשיחות עצמאיות (ChatRequest.inline_context או ClientManagedResourceContext.inline_context) ולא נתמך ב-DataAgent.
| ייצוג ב-JSON |
|---|
{
"includeProjectIds": [
string
],
"includeDatasetReferences": [
{
object ( |
| שדות | |
|---|---|
includeProjectIds[] |
זה שינוי אופציונלי. מזהי הפרויקטים ב-BigQuery שבהם רוצים לחפש. |
includeDatasetReferences[] |
זה שינוי אופציונלי. ההפניות למערך הנתונים ב-BigQuery שבהן רוצים לחפש. |
BigQueryDatasetReference
הודעה שמייצגת הפניה למערך נתונים יחיד ב-BigQuery.
| ייצוג ב-JSON |
|---|
{ "projectId": string, "datasetId": string } |
| שדות | |
|---|---|
projectId |
חובה. מזהה הפרויקט שאליו שייכת קבוצת הנתונים. |
datasetId |
חובה. מזהה קבוצת הנתונים. |
BigQueryTableReference
הודעה שמייצגת הפניה לטבלה אחת ב-BigQuery.
| ייצוג ב-JSON |
|---|
{
"projectId": string,
"datasetId": string,
"tableId": string,
"schema": {
object ( |
| שדות | |
|---|---|
projectId |
חובה. הפרויקט שהטבלה שייכת אליו. |
datasetId |
חובה. מערך הנתונים שהטבלה שייכת אליו. |
tableId |
חובה. מזהה הטבלה. |
schema |
זה שינוי אופציונלי. הסכימה של מקור הנתונים. |
סכימה
הסכימה של מופע של Datasource או QueryResult.
| ייצוג ב-JSON |
|---|
{ "fields": [ { object ( |
| שדות | |
|---|---|
fields[] |
זה שינוי אופציונלי. השדות בסכימה. |
description |
זה שינוי אופציונלי. תיאור טקסטואלי של התוכן והמטרה של הטבלה. לדוגמה: "מכיל מידע על הזמנות של לקוחות בחנות המסחר האלקטרוני שלנו". כרגע משמש רק למקורות נתונים של BigQuery. |
synonyms[] |
זה שינוי אופציונלי. רשימה של שמות חלופיים או מילים נרדפות שאפשר להשתמש בהם כדי להתייחס לטבלה. לדוגמה: ["sales", "orders", "purchases"]. כרגע משמש רק למקורות נתונים של BigQuery. |
tags[] |
זה שינוי אופציונלי. רשימה של תגים או מילות מפתח שמשויכים לטבלה, שמשמשים לסיווג. לדוגמה: ["transaction", "revenue", "customer_data"]. כרגע משמש רק למקורות נתונים של BigQuery. |
displayName |
זה שינוי אופציונלי. השם המוצג של הטבלה (זהה לתווית ב-cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), לא נדרש, כרגע רק ל-Looker יש את השדה הזה. |
filters[] |
זה שינוי אופציונלי. המסננים של הנתונים הבסיסיים של מקור הנתונים. כרגע משמש רק למקורות נתונים של Looker. |
שדה
שדה בסכימה.
| ייצוג ב-JSON |
|---|
{
"name": string,
"type": string,
"description": string,
"mode": string,
"synonyms": [
string
],
"tags": [
string
],
"displayName": string,
"subfields": [
{
object ( |
| שדות | |
|---|---|
name |
זה שינוי אופציונלי. שם השדה. |
type |
זה שינוי אופציונלי. סוג השדה. |
description |
זה שינוי אופציונלי. תיאור קצר של השדה. |
mode |
זה שינוי אופציונלי. מצב השדה (למשל, NULLABLE, REPEATED). |
synonyms[] |
זה שינוי אופציונלי. רשימה של שמות חלופיים או מילים נרדפות שאפשר להשתמש בהם כדי להתייחס לשדה הזה. לדוגמה: ["id", "customerid", "cust_id"]. כרגע משמש רק למקורות נתונים של BigQuery. |
tags[] |
זה שינוי אופציונלי. רשימה של תגים או מילות מפתח שמשויכים לשדה, שמשמשים לסיווג. לדוגמה: ["identifier", "customer", "pii"]. כרגע משמש רק למקורות נתונים של BigQuery. |
displayName |
זה שינוי אופציונלי. השם המוצג של השדה (זהה לתווית ב- |
subfields[] |
זה שינוי אופציונלי. מאפיין רקורסיבי למבני סכימה בתוך סכימה. |
category |
זה שינוי אופציונלי. קטגוריית השדה, לא חובה, כרגע שימושית רק ל-Looker. |
valueFormat |
זה שינוי אופציונלי. Looker בלבד. פורמט הערך של השדה. מקור: https://cloud.google.com/looker/docs/reference/param-field-value-format |
DataFilter
מסנן על הנתונים הבסיסיים של מקור נתונים. מסמכי תיעוד של תחביר הסינון: https://cloud.google.com/looker/docs/filter-expressions
| ייצוג ב-JSON |
|---|
{
"field": string,
"value": string,
"type": enum ( |
| שדות | |
|---|---|
field |
זה שינוי אופציונלי. השדה שלפיו רוצים לסנן. לדוגמה: ["event_date", "customer_id", "product_category"] |
value |
זה שינוי אופציונלי. ערך ברירת המחדל שמשמש למסנן הזה אם המסנן לא מקבל ערך אחר בשאילתה. לדוגמה: ["after 2024-01-01", "123", "-fashion"] |
type |
זה שינוי אופציונלי. סוג המסנן שקיים במקור נתונים, כמו ALWAYS_FILTER. |
DataFilterType
סוג המסנן שקיים במקור נתונים, כמו ALWAYS_FILTER.
| טיפוסים בני מנייה (enum) | |
|---|---|
DATA_FILTER_TYPE_UNSPECIFIED |
סוג המסנן לא צוין. |
ALWAYS_FILTER |
מסנן שהמשתמש מגדיר, וכל השאילתות ב-Explore תמיד יחילו את המסנן הזה כברירת מחדל. כרגע משמש רק למקורות נתונים של Looker. |
BigQueryPropertyGraphReference
הודעה שמייצגת הפניה לתרשים מאפיינים יחיד ב-BigQuery.
| ייצוג ב-JSON |
|---|
{ "projectId": string, "datasetId": string, "propertyGraphId": string } |
| שדות | |
|---|---|
projectId |
חובה. הפרויקט שתרשים המאפיינים שייך אליו. |
datasetId |
חובה. מערך הנתונים שאליו שייך תרשים המאפיינים. |
propertyGraphId |
חובה. מזהה התרשים של הנכס. |
StudioDatasourceReferences
הודעה שמייצגת הפניות למקורות נתונים ב-Looker Studio.
| ייצוג ב-JSON |
|---|
{
"studioReferences": [
{
object ( |
| שדות | |
|---|---|
studioReferences[] |
זה שינוי אופציונלי. הפניות למקורות הנתונים של Studio. |
StudioDatasourceReference
הודעה שמייצגת הפניה למקור נתונים יחיד ב-Looker Studio.
| ייצוג ב-JSON |
|---|
{ "datasourceId": string } |
| שדות | |
|---|---|
datasourceId |
חובה. המזהה של מקור הנתונים. |
LookerExploreReferences
הודעה שמייצגת הפניות לחקירות ב-Looker.
| ייצוג ב-JSON |
|---|
{ "exploreReferences": [ { object ( |
| שדות | |
|---|---|
exploreReferences[] |
חובה. הפניות לניתוחי נתונים ב-Looker. |
credentials |
זה שינוי אופציונלי. הוצא משימוש: צריך להשתמש בפרטי הכניסה ב-ChatRequest. פרטי הכניסה שבהם צריך להשתמש כששולחים קריאה ל-Looker API. נכון לעכשיו, יש תמיכה גם באסימון OAuth וגם בפרטי כניסה שמבוססים על מפתח API, כמו שמתואר במאמר אימות באמצעות SDK. |
LookerExploreReference
הודעה שמייצגת הפניה לניתוח נתונים אחד ב-Looker.
| ייצוג ב-JSON |
|---|
{ "lookmlModel": string, "explore": string, "schema": { object ( |
| שדות | |
|---|---|
lookmlModel |
חובה. מודל Looker, כפי שמתואר בקטע מבנים עיקריים של LookML. השם של מודל LookML. |
explore |
חובה. Looker Explore, כפי שמתואר במאמר מבנים עיקריים של LookML. השם של ה-Explore ב-LookML. |
schema |
זה שינוי אופציונלי. הסכימה של מקור הנתונים. |
שדה של איחוד instance. המכונה של ה-Explore ב-Looker. הערך instance יכול להיות רק אחד מהבאים: |
|
lookerInstanceUri |
חובה. כתובת ה-URL הבסיסית של המכונה ב-Looker. |
privateLookerInstanceInfo |
פרטי המכונה הפרטית ב-Looker. |
PrivateLookerInstanceInfo
הודעה שמייצגת את פרטי המכונה הפרטית של Looker, שנדרשים אם המכונה של Looker נמצאת מאחורי רשת פרטית.
| ייצוג ב-JSON |
|---|
{ "lookerInstanceId": string, "serviceDirectoryName": string } |
| שדות | |
|---|---|
lookerInstanceId |
מזהה המכונה ב-Looker. |
serviceDirectoryName |
השם של ספריית השירות של המכונה ב-Looker. |
פרטי כניסה
מייצג צורות שונות של מפרט פרטי כניסה.
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד kind. סוג פרטי הכניסה. הערך kind יכול להיות רק אחד מהבאים: |
|
oauth |
פרטי כניסה של OAuth. |
OAuthCredentials
מייצג פרטי כניסה של OAuth.
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד kind. סוג פרטי הכניסה של OAuth. הערך kind יכול להיות רק אחד מהבאים: |
|
secret |
פרטי כניסה של OAuth שמבוססים על סוד. |
token |
פרטי כניסה של OAuth שמבוססים על טוקן. |
SecretBased
שם הסוד שמכיל את טוקן הגישה. מייצג פרטי כניסה של OAuth שמבוססים על סוד.
| ייצוג ב-JSON |
|---|
{ "clientId": string, "clientSecret": string } |
| שדות | |
|---|---|
clientId |
חובה. מזהה לקוח ב-OAuth. |
clientSecret |
חובה. סוד לקוח OAuth. |
TokenBased
מידע נוסף על טוקני גישה של Looker זמין כאן: https://developers.looker.com/api/advanced-usage/looker-api-oauth
| ייצוג ב-JSON |
|---|
{ "accessToken": string } |
| שדות | |
|---|---|
accessToken |
חובה. שם הסוד שמכיל את טוקן הגישה. |
AlloyDbReference
הודעה שמייצגת הפניה למסד נתונים של AlloyDB ולהקשר של הסוכן. הפעולה הזו נתמכת רק בשיטה QueryData.
| ייצוג ב-JSON |
|---|
{ "databaseReference": { object ( |
| שדות | |
|---|---|
databaseReference |
חובה. פרוטוקול יחיד שתומך בציון מסד הנתונים והטבלאות שצריך לכלול. |
agentContextReference |
זה שינוי אופציונלי. פרמטרים לאחזור נתונים מההקשר של הסוכן. |
AlloyDbDatabaseReference
הודעה שמייצגת הפניה למסד נתונים יחיד ב-AlloyDB.
| ייצוג ב-JSON |
|---|
{
"projectId": string,
"region": string,
"clusterId": string,
"instanceId": string,
"databaseId": string,
"tableIds": [
string
],
"databaseTableReferences": [
{
object ( |
| שדות | |
|---|---|
projectId |
חובה. הפרויקט שהמכונה שייכת אליו. |
region |
חובה. האזור של המכונה. |
clusterId |
חובה. מזהה האשכול. |
instanceId |
חובה. מזהה המכונה. |
databaseId |
חובה. מזהה מסד הנתונים. |
tableIds[] |
זה שינוי אופציונלי. מזהי הטבלאות. אם לא מוגדר, מציין את כל הטבלאות. |
databaseTableReferences[] |
זה שינוי אופציונלי. הפניות לטבלאות במסד הנתונים. כל הפניה מציינת טבלה, ויכולה לכלול את הסכימה של הטבלה כדי לספק הקשר לשאילתה. |
DatabaseTableReference
הודעה שמייצגת טבלה, כולל הסכימה שלה.
| ייצוג ב-JSON |
|---|
{
"tableId": string,
"schema": {
object ( |
| שדות | |
|---|---|
tableId |
חובה. שם הטבלה כפי שהוגדר במסד הנתונים. הערה: הכללים המדויקים למתן שמות לטבלאות, כולל תווים חוקיים, מגבלות אורך ותלות באותיות רישיות, נקבעים לפי מערכת מסד הנתונים הספציפית. דרישות: - התאמה מדויקת: השם שצוין חייב להיות זהה לשם ששמור במסד הנתונים. - תלוי אותיות רישיות: צריך לפעול לפי הכללים של מערכת מסד הנתונים הספציפית לגבי תלות באותיות רישיות, ולפי האופן שבו הטבלה נוצרה. לדוגמה, "Orders" ו-"orders" יכולים להיות שמות של טבלאות שונות. - תווים מיוחדים או מילות מפתח: אם שם הטבלה כולל רווחים, תווים מיוחדים או מילת מפתח שמורה של מסד נתונים, צריך לציין את השם המילולי כפי שהוא מאוחסן. אל תוסיפו תווים ספציפיים למסד נתונים שמשמשים לציטוט מזהים (למשל, ", `, []). דוגמאות: - שם פשוט: "orders", "UserActivity" - תלוי אותיות רישיות: "MyTable" - שם עם רווחים: "Order Details" - שם עם תווים מיוחדים אחרים: "user/data", "order-items" - שם שהוא מילת מפתח: "Group", "Order" הרשאות: פרטי הכניסה של מבצע הקריאה החוזרת חייבים לכלול את ההרשאות הנדרשות למסד הנתונים כדי לגשת לסכימה ולנתונים של הטבלה. |
schema |
זה שינוי אופציונלי. הסכימה של הטבלה. |
AgentContextReference
הודעה שמייצגת הפניה להקשר של הסוכן.
| ייצוג ב-JSON |
|---|
{ "contextSetId": string } |
| שדות | |
|---|---|
contextSetId |
חובה. מזהה קבוצת ההקשרים שרוצים לאחזר. |
SpannerReference
הודעה שמייצגת הפניה למסד נתונים של Spanner ולהקשר של הנציג. הפעולה הזו נתמכת רק בשיטה QueryData.
| ייצוג ב-JSON |
|---|
{ "databaseReference": { object ( |
| שדות | |
|---|---|
databaseReference |
חובה. פרוטוקול יחיד שתומך בציון מסד הנתונים והטבלאות שצריך לכלול. |
agentContextReference |
זה שינוי אופציונלי. פרמטרים לאחזור נתונים מההקשר של הסוכן. |
SpannerDatabaseReference
הודעה שמייצגת הפניה למסד נתונים יחיד ב-Spanner.
| ייצוג ב-JSON |
|---|
{ "engine": enum ( |
| שדות | |
|---|---|
engine |
חובה. המנוע של מכונת Spanner. |
projectId |
חובה. הפרויקט שהמכונה שייכת אליו. |
instanceId |
חובה. מזהה המכונה. |
databaseId |
חובה. מזהה מסד הנתונים. |
tableIds[] |
זה שינוי אופציונלי. מזהי הטבלאות. אם לא מוגדר, מציין את כל הטבלאות. |
databaseTableReferences[] |
זה שינוי אופציונלי. הפניות לטבלאות במסד הנתונים. כל הפניה מציינת טבלה, ויכולה לכלול את הסכימה של הטבלה כדי לספק הקשר לשאילתה. |
priority |
זה שינוי אופציונלי. עדיפות לשאילתות ל-Spanner. צריך להיות ערך שנתמך על ידי Cloud Spanner, למשל: נמוכה, בינונית, גבוהה. המערכת תתעלם מערכים לא נתמכים. הרשימה המלאה מופיעה בכתובת https://docs.cloud.google.com/spanner/docs/reference/rest/v1/RequestOptions#Priority. |
requestTag |
תג שיצורף לכל השאילתות ל-Spanner. מאפשר לזהות ולעקוב אחרי שאילתות שנשלחות ל-Spanner על ידי שירות GDA. |
מנוע
המנוע של מסד הנתונים.
| טיפוסים בני מנייה (enum) | |
|---|---|
ENGINE_UNSPECIFIED |
לא צוין מנוע. |
GOOGLE_SQL |
Google SQL |
POSTGRESQL |
PostgreSQL |
CloudSqlReference
הודעה שמייצגת הפניה למסד נתונים של CloudSQL ולהקשר של הסוכן. הפעולה הזו נתמכת רק בשיטה QueryData.
| ייצוג ב-JSON |
|---|
{ "databaseReference": { object ( |
| שדות | |
|---|---|
databaseReference |
חובה. פרוטוקול יחיד שתומך בציון מסד הנתונים והטבלאות שצריך לכלול. |
agentContextReference |
זה שינוי אופציונלי. פרמטרים לאחזור נתונים מההקשר של הסוכן. |
CloudSqlDatabaseReference
הודעה שמייצגת הפניה למסד נתונים יחיד ב-CloudSQL.
| ייצוג ב-JSON |
|---|
{ "engine": enum ( |
| שדות | |
|---|---|
engine |
חובה. המנוע של המכונה של Cloud SQL. |
projectId |
חובה. הפרויקט שהמכונה שייכת אליו. |
region |
חובה. האזור של המכונה. |
instanceId |
חובה. מזהה המכונה. |
databaseId |
חובה. מזהה מסד הנתונים. |
tableIds[] |
זה שינוי אופציונלי. מזהי הטבלאות. אם לא מוגדר, מציין את כל הטבלאות. |
databaseTableReferences[] |
זה שינוי אופציונלי. הפניות לטבלאות במסד הנתונים. כל הפניה מציינת טבלה, ויכולה לכלול את הסכימה של הטבלה כדי לספק הקשר לשאילתה. |
מנוע
המנוע של מסד הנתונים.
| טיפוסים בני מנייה (enum) | |
|---|---|
ENGINE_UNSPECIFIED |
לא צוין מנוע. |
POSTGRESQL |
PostgreSQL |
MYSQL |
MySQL |
ConversationOptions
אפשרויות לשיחה.
| ייצוג ב-JSON |
|---|
{ "chart": { object ( |
| שדות | |
|---|---|
chart |
זה שינוי אופציונלי. אפשרויות ליצירת תרשים. |
analysis |
זה שינוי אופציונלי. אפשרויות לניתוח. |
datasource |
זה שינוי אופציונלי. אפשרויות למקורות נתונים. |
model |
זה שינוי אופציונלי. המודל שבו צריך להשתמש בשביל לולאת הסוכן. |
ChartOptions
אפשרויות ליצירת תרשים.
| ייצוג ב-JSON |
|---|
{
"image": {
object ( |
| שדות | |
|---|---|
image |
זה שינוי אופציונלי. אם מציינים פורמט, הנציג יעבד את התרשימים שנוצרו בפורמט שצוין. ברירת המחדל היא ללא תמונה. |
ImageOptions
אפשרויות לעיבוד תמונות של תרשימים שנוצרו.
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד kind. סוג התמונה שרוצים ליצור. הערך kind יכול להיות רק אחד מהבאים: |
|
noImage |
אין תמונה. |
svg |
פורמט SVG. |
NoImage
בסוג הזה אין שדות.
אין תמונה.
SvgOptions
בסוג הזה אין שדות.
אפשרויות SVG.
AnalysisOptions
אפשרויות לניתוח.
| ייצוג ב-JSON |
|---|
{
"python": {
object ( |
| שדות | |
|---|---|
python |
זה שינוי אופציונלי. אפשרויות לניתוח Python. |
Python
אפשרויות לניתוח Python.
| ייצוג ב-JSON |
|---|
{ "enabled": boolean } |
| שדות | |
|---|---|
enabled |
זה שינוי אופציונלי. האם להפעיל ניתוח ב-Python. ברירת המחדל היא False. |
DatasourceOptions
אפשרויות להגדרות של מקורות נתונים.
| ייצוג ב-JSON |
|---|
{ "bigQueryMaxBilledBytes": string } |
| שדות | |
|---|---|
bigQueryMaxBilledBytes |
זה שינוי אופציונלי. האפשרות הזו רלוונטית רק למקורות נתונים שדורשים שאילתות BigQuery. מגבילה את מספר הבייטים שמחויבים בכל משימת שאילתה ב-BigQuery. אם השאילתה תחרוג ממגבלת הבייטים לחיוב, הרצת השאילתה תיכשל (החשבון לא יחויב). אם לא מציינים ערך, לא תהיה מגבלה. |
דגם
המודלים המותרים לסוכן או לשיחה.
| טיפוסים בני מנייה (enum) | |
|---|---|
MODEL_UNSPECIFIED |
לא צוין מודל. המודל יכול להיות מוגדר בבקשת הצ'אט, או שייעשה שימוש במודל ברירת המחדל. |
LATEST_GA_MODEL |
להשתמש במודל הכי עדכני שהוא לא בגרסת טרום-השקה (Preview). יכול להיות שהפעולה הזו תגביל הגדרות מסוימות ברמת הבקשה. |
ExampleQuery
דוגמה לשאילתת SQL רלוונטית והכי רווחית, ולשאילתות המקבילות שלה בשפה טבעית, אם יש כאלה. כרגע משמש רק למקורות נתונים של BigQuery.
| ייצוג ב-JSON |
|---|
{ "naturalLanguageQuestion": string, "parameters": [ { object ( |
| שדות | |
|---|---|
naturalLanguageQuestion |
זה שינוי אופציונלי. שאלה בשפה טבעית שמשתמש עשוי לשאול. לדוגמה: "כמה הזמנות בוצעו בחודש שעבר?" |
parameters[] |
זה שינוי אופציונלי. רשימת הפרמטרים של השאילתה. דוגמה: שאילתת ה-SQL עם הפרמטרים "SELECT * FROM my_table WHERE id = @id" יכולה להתאים לכל ערך של id. |
שדה של איחוד query. שאילתת SQL או Looker שצריך ליצור כדי לענות על השאילתה בשפה טבעית. הערך query יכול להיות רק אחד מהבאים: |
|
sqlQuery |
זה שינוי אופציונלי. שאילתת ה-SQL שצריך ליצור כדי לענות על השאלה בשפה טבעית. לדוגמה: "SELECT COUNT(*) FROM orders WHERE order_date BETWEEN '2024-01-01' AND '2024-01-31'" |
QueryParameter
הודעה של פרמטר שאילתה מייצגת פרמטר שאפשר להשתמש בו כדי להגדיר פרמטרים של שאילתת SQL.
| ייצוג ב-JSON |
|---|
{ "name": string, "description": string, "dataType": string } |
| שדות | |
|---|---|
name |
חובה. השם של ההפניה לפרמטר בשאילתת ה-SQL. |
description |
זה שינוי אופציונלי. תיאור הפרמטר שבו ה-LLM יכול להשתמש כדי לחלץ את ערך הפרמטר מהשאלה של המשתמש. |
dataType |
חובה. סוג הנתונים של הפרמטר, למשל "STRING", "INT64", "DATE" וכו'. ערכים חוקיים מפורטים במסמכי התיעוד של BigQuery. הערך הזה ישמש לאכלוס של google.cloud.bigquery.v2.QueryParameterType.type. |
LookerGoldenQuery
שאילתה לדוגמה ל-Looker, כולל שאלות בשפה טבעית ושאילתת Looker תואמת. בדומה ל-ExampleQuery.
| ייצוג ב-JSON |
|---|
{
"naturalLanguageQuestions": [
string
],
"lookerQuery": {
object ( |
| שדות | |
|---|---|
naturalLanguageQuestions[] |
זה שינוי אופציונלי. שאלות בשפה טבעית שמשתמשים עשויים לשאול. לדוגמה: "כמה הזמנות בוצעו בחודש שעבר?" |
lookerQuery |
זה שינוי אופציונלי. השאילתה ב-Looker שתואמת לשאלות בשפה טבעית. |
LookerQuery
מאמרי העזרה של Looker API בנושא Looker Query Object.
| ייצוג ב-JSON |
|---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
| שדות | |
|---|---|
model |
חובה. מודל LookML ששימש ליצירת השאילתה. |
explore |
חובה. ה-Explore ב-LookML ששימש ליצירת השאילתה. |
fields[] |
זה שינוי אופציונלי. השדות שצריך לאחזר מהניתוח. |
filters[] |
זה שינוי אופציונלי. המסננים שרוצים להחיל על הניתוח. |
sorts[] |
זה שינוי אופציונלי. המיון שיוחל על הניתוח. |
limit |
זה שינוי אופציונלי. מגבלה בשאילתה. |
queryId |
זה שינוי אופציונלי. המזהה הראשי של משאב השאילתה ב-Looker, שמשמש לפעולות API. ממופה ל- |
clientId |
זה שינוי אופציונלי. המזהה האלפאנומרי הקצר של השאילתה, שמשמש לקישורי שיתוף ולכתובות URL של "ניתוח נתונים" (למשל, בפרמטר |
מסנן
מסנן שאילתות ב-Looker.
| ייצוג ב-JSON |
|---|
{ "field": string, "value": string } |
| שדות | |
|---|---|
field |
חובה. השדה שלפיו רוצים לסנן. |
value |
זה שינוי אופציונלי. הערך של השדה שלפיו רוצים לסנן. אופציונלי, כדי שנוכל לשמור את ערך ברירת המחדל כמחרוזת ריקה. חשוב לקבל כתובת URL תקינה ופעילה של Looker Explore. |
GlossaryTerm
הגדרה של מונח בדומיין ספציפי.
| ייצוג ב-JSON |
|---|
{ "displayName": string, "description": string, "labels": [ string ] } |
| שדות | |
|---|---|
displayName |
חובה. שם התצוגה הידידותי למשתמש של המונח במילון המונחים שמוגדר. לדוגמה: "שיעור קליקים", "שיעור המרה", "בהמתנה" |
description |
חובה. התיאור או המשמעות של המונח. לדוגמה: "שיעור קליקים", "אחוז המשתמשים שמשלימים פעולה רצויה", "הזמנה שממתינה לעיבוד". |
labels[] |
זה שינוי אופציונלי. רשימה של תוויות למטרות כלליות שמשויכות למונח הזה. לדוגמה: ["שיעור קליקים", "קליקים", "waiting"] |
SchemaRelationship
הקשר בין שתי טבלאות, כולל עמודות מפנות ועמודות מופנות. זהו הקשר נגזר שאוחזר מ-Dataplex Dataset Insights.
| ייצוג ב-JSON |
|---|
{ "leftSchemaPaths": { object ( |
| שדות | |
|---|---|
leftSchemaPaths |
רשימה מסודרת של שדות לצירוף מהטבלה הראשונה. גודל הרשימה הזו חייב להיות זהה ל- |
rightSchemaPaths |
רשימה מסודרת של שדות לצירוף מהטבלה השנייה. גודל הרשימה הזו חייב להיות זהה ל- |
sources[] |
זה שינוי אופציונלי. המקורות שיצרו את קצה הקשר של הסכימה. |
confidenceScore |
זה שינוי אופציונלי. ציון מהימנות של הקשר המוצע. לקצוות שנוספו באופן ידני יש את ציון הסמך הגבוה ביותר. |
SchemaPaths
מייצג קבוצה מסודרת של נתיבים בסכימת הטבלה.
| ייצוג ב-JSON |
|---|
{ "tableFqn": string, "paths": [ string ] } |
| שדות | |
|---|---|
tableFqn |
שם המשאב המלא של הטבלה, כולל השירות. לדוגמה: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID |
paths[] |
רשימה מסודרת של נתיבים בסכימת הטבלה. |
מקור
המקור שיצר את קצה הקשר של הסכימה.
| טיפוסים בני מנייה (enum) | |
|---|---|
SOURCE_UNSPECIFIED |
המקור של קשר הסכימה לא צוין. |
BIGQUERY_JOB_HISTORY |
המקור של קשרי הגומלין בסכימה הוא היסטוריית המשימות ב-BigQuery. |
LLM_SUGGESTED |
מקור הקשר של הסכימה הוא הצעה של LLM. |
BIGQUERY_TABLE_CONSTRAINTS |
המקור של קשרי הגומלין בסכימה הוא אילוצי הטבלה ב-BigQuery. |
UserFunctions
אוסף של פונקציות משתמש שייכללו בהקשר.
| ייצוג ב-JSON |
|---|
{
"bqRoutines": [
{
object ( |
| שדות | |
|---|---|
bqRoutines[] |
רשימה של שגרות BigQuery שצריך לכלול בהקשר. |
BigQueryRoutine
הפניה לשגרה ב-BigQuery.
| ייצוג ב-JSON |
|---|
{
"routineReference": {
object ( |
| שדות | |
|---|---|
routineReference |
ההפניה לשגרה של BigQuery. |
description |
המשתמש יכול לשנות את התיאור או להוסיף לו, כדי להנחות את הנציג מתי להשתמש בפונקציה המוגדרת על ידי המשתמש. |
BigQueryRoutineReference
הפניה לשגרה ב-BigQuery.
| ייצוג ב-JSON |
|---|
{ "projectId": string, "datasetId": string, "routineId": string } |
| שדות | |
|---|---|
projectId |
מזהה הפרויקט של השגרה. |
datasetId |
מזהה מערך הנתונים של השגרה. |
routineId |
המזהה של התרחיש. |
Methods |
|
|---|---|
|
יצירת DataAgent חדש בפרויקט ובמיקום נתונים. |
|
יצירת DataAgent חדש בפרויקט ובמיקום נתונים באופן סינכרוני. |
|
מחיקה של DataAgent יחיד. |
|
מחיקה של DataAgent אחד באופן סינכרוני. |
|
אחזור פרטים של DataAgent יחיד. |
|
אחזור מדיניות ה-IAM של DataAgent |
|
הצגת רשימה של סוכני נתונים בפרויקט ובמיקום נתונים. |
|
הצגת רשימה של סוכני נתונים שנגישים למבצע הקריאה בפרויקט ובמיקום נתונים. |
|
עדכון הפרמטרים של DataAgent יחיד. |
|
הגדרת מדיניות IAM ל-DataAgent. |
|
עדכון הפרמטרים של DataAgent יחיד באופן סינכרוני. |