REST Resource: projects.locations.dataAgents

משאב: DataAgent

הודעה שמתארת אובייקט DataAgent.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "purgeTime": string,

  // Union field type can be only one of the following:
  "dataAnalyticsAgent": {
    object (DataAnalyticsAgent)
  }
  // End of list of possible types for union field type.
  "kmsKey": string
}
שדות
name

string

זה שינוי אופציונלי. מזהה. שם המשאב הייחודי של DataAgent. פורמט: projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} הוא מזהה המשאב, צריך להיות באורך של 63 תווים לכל היותר ולהתאים לפורמט שמתואר בכתובת https://google.aip.dev/122#resource-id-segments

דוגמה: projects/1234567890/locations/global/dataAgents/my-agent

מומלץ לדלג על הגדרת השדה הזה במהלך יצירת הסוכן, כי הוא יוסק באופן אוטומטי ויוחלף בערך {parent}/dataAgents/{dataAgentId}.
displayName

string

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

  • השם צריך לכלול בין 1 ל-256 תווים.
description

string

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

  • האורך צריך להיות בין 1 ל-1,024 תווים.
labels

map (key: string, value: string)

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

אובייקט שמכיל רשימה של "key": value זוגות. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

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".
updateTime

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".
deleteTime

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".
purgeTime

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט 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".
שדה איחוד type. סוג הסוכן. יכול להיות אחד מהערכים הבאים: * סוכן ניתוח נתונים. * סוכן הנדסת נתונים type יכול להיות רק אחד מהבאים:
dataAnalyticsAgent

object (DataAnalyticsAgent)

סוכן ניתוח נתונים.
kmsKey

string

זה שינוי אופציונלי. מפתח הצפנה בניהול הלקוח (CMEK) שבו יש להשתמש להצפנת המשאבים של DataAgent. מפתחות קריפטוגרפיים של Cloud KMS צריכים להיות באותו מיקום כמו DataAgent. הפורמט הנדרש הוא projects/*/locations/*/keyRings/*/cryptoKeys/*.

DataAnalyticsAgent

הודעה שמתארת אובייקט DataAnalyticsAgent.

ייצוג ב-JSON 
{
  "stagingContext": {
    object (Context)
  },
  "publishedContext": {
    object (Context)
  },
  "lastPublishedContext": {
    object (Context)
  }
}
שדות
stagingContext

object (Context)

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

object (Context)

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

object (Context)

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

הקשר

אוסף של הקשרים להחלתם על השיחה הזו

ייצוג ב-JSON 
{
  "systemInstruction": string,
  "datasourceReferences": {
    object (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  },
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ],
  "lookerGoldenQueries": [
    {
      object (LookerGoldenQuery)
    }
  ],
  "glossaryTerms": [
    {
      object (GlossaryTerm)
    }
  ],
  "schemaRelationships": [
    {
      object (SchemaRelationship)
    }
  ],
  "userFunctions": {
    object (UserFunctions)
  }
}
שדות
systemInstruction

string

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

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

object (DatasourceReferences)

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

object (ConversationOptions)

זה שינוי אופציונלי. אפשרויות נוספות לשיחה.
exampleQueries[]

object (ExampleQuery)

זה שינוי אופציונלי. רשימה של שאילתות לדוגמה, עם דוגמאות לשאילתות SQL רלוונטיות והכי רווחיות, ואפשרות להציג גם את השאילתות המקבילות בשפה טבעית. האפשרות הזו משמשת כרגע רק למקורות נתונים ולמסדי נתונים של BigQuery (alloydb, cloudsql, spanner).
lookerGoldenQueries[]

object (LookerGoldenQuery)

זה שינוי אופציונלי. רשימה של שאילתות לדוגמה, עם דוגמאות לשאילתות רלוונטיות והכי רווחיות ב-Looker, ואפשרות להציג את השאילתות המקבילות בשפה טבעית. האפשרות הזו נתמכת רק במקורות נתונים של Looker.
glossaryTerms[]

object (GlossaryTerm)

זה שינוי אופציונלי. הגדרות של מונחים (בשלב הזה, רק כאלה שהמשתמשים יצרו) לא נתמכות במקורות נתונים של מסדי נתונים (alloydb, cloudsql, spanner).
schemaRelationships[]

object (SchemaRelationship)

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

object (UserFunctions)

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

DatasourceReferences

אוסף של הפניות למקורות נתונים.

ייצוג ב-JSON 
{

  // Union field references can be only one of the following:
  "bq": {
    object (BigQueryTableReferences)
  },
  "studio": {
    object (StudioDatasourceReferences)
  },
  "looker": {
    object (LookerExploreReferences)
  },
  "alloydb": {
    object (AlloyDbReference)
  },
  "spannerReference": {
    object (SpannerReference)
  },
  "cloudSqlReference": {
    object (CloudSqlReference)
  }
  // End of list of possible types for union field references.
}
שדות
שדה איחוד references. מקורות הנתונים שבהם רוצים להשתמש. הערך references יכול להיות רק אחד מהבאים:
bq

object (BigQueryTableReferences)

הפניות לטבלאות BigQuery.
studio

object (StudioDatasourceReferences)

הפניות למקורות נתונים של Looker Studio.
looker

object (LookerExploreReferences)

הפניות ל-Looker Explores.
alloydb

object (AlloyDbReference)

התייחסות למסד נתונים של AlloyDB. האפשרות הזו נתמכת רק בשיטה QueryData.
spannerReference

object (SpannerReference)

הפניה למסד נתונים של Spanner. האפשרות הזו נתמכת רק בשיטה QueryData.
cloudSqlReference

object (CloudSqlReference)

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

BigQueryTableReferences

הודעה שמייצגת הפניות לטבלאות BigQuery ולגרפים של נכסים. צריך למלא לפחות אחד מהמאפיינים tableReferences, propertyGraphReferences או searchScope.

ייצוג ב-JSON 
{
  "tableReferences": [
    {
      object (BigQueryTableReference)
    }
  ],
  "propertyGraphReferences": [
    {
      object (BigQueryPropertyGraphReference)
    }
  ]
}
שדות
tableReferences[]

object (BigQueryTableReference)

זה שינוי אופציונלי. הפניות לטבלאות BigQuery.
propertyGraphReferences[]

object (BigQueryPropertyGraphReference)

זה שינוי אופציונלי. תכונה בגרסת טרום-השקה (Preview). הפניות לגרפים של נכסי BigQuery. הערה: מקורות נתונים צריכים להשתמש רק בטבלאות או רק בתרשימי מאפיינים, ולא בשניהם. כשמשתמשים בתרשימי מאפיינים, אפשר להשתמש בהפניה אחת לתרשים לכל היותר.

BigQueryTableReference

הודעה שמייצגת הפניה לטבלה ב-BigQuery יחידה.

ייצוג ב-JSON 
{
  "projectId": string,
  "datasetId": string,
  "tableId": string,
  "schema": {
    object (Schema)
  }
}
שדות
projectId

string

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

string

חובה. מערך הנתונים שהטבלה שייכת אליו.
tableId

string

חובה. מזהה הטבלה.
schema

object (Schema)

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

סכימה

הסכימה של מופע של Datasource או QueryResult.

ייצוג ב-JSON 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "description": string,
  "synonyms": [
    string
  ],
  "tags": [
    string
  ],
  "displayName": string,
  "filters": [
    {
      object (DataFilter)
    }
  ]
}
שדות
fields[]

object (Field)

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

string

זה שינוי אופציונלי. תיאור טקסטואלי של תוכן הטבלה והמטרה שלה. לדוגמה: "ההודעה מכילה מידע על הזמנות של לקוחות בחנות המסחר האלקטרוני שלנו". בשלב הזה, נעשה שימוש בפרמטר הזה רק במקורות נתונים של BigQuery.
synonyms[]

string

זה שינוי אופציונלי. רשימה של שמות חלופיים או מילים נרדפות שאפשר להשתמש בהם כדי להתייחס לטבלה. לדוגמה: ['sales',‏ 'orders',‏ 'purchases']. בשלב הזה, נעשה שימוש בפרמטר הזה רק במקורות נתונים של BigQuery.
tags[]

string

זה שינוי אופציונלי. רשימה של תגיות או מילות מפתח שמשויכות לטבלה, ומשמשות לסיווג. לדוגמה: ‎["transaction", "revenue", "customer_data"]‎. בשלב הזה, נעשה שימוש בפרמטר הזה רק במקורות נתונים של BigQuery.
displayName

string

זה שינוי אופציונלי. השם המוצג של הטבלה (זהה לתווית ב-cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), לא חובה, כרגע רק ל-Looker יש את השדה הזה.
filters[]

object (DataFilter)

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

שדה

שדה בסכימה.

ייצוג ב-JSON 
{
  "name": string,
  "type": string,
  "description": string,
  "mode": string,
  "synonyms": [
    string
  ],
  "tags": [
    string
  ],
  "displayName": string,
  "subfields": [
    {
      object (Field)
    }
  ],
  "category": string,
  "valueFormat": string
}
שדות
name

string

זה שינוי אופציונלי. שם השדה.
type

string

זה שינוי אופציונלי. סוג השדה.
description

string

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

string

זה שינוי אופציונלי. המצב של השדה (למשל: NULLABLE,‏ REPEATED).
synonyms[]

string

זה שינוי אופציונלי. רשימה של שמות חלופיים או מילים נרדפות שאפשר להשתמש בהם כדי להתייחס לשדה הזה. לדוגמה: [‎"id", "customerid", "cust_id"‎]. בשלב הזה, נעשה שימוש בפרמטר הזה רק במקורות נתונים של BigQuery.
tags[]

string

זה שינוי אופציונלי. רשימה של תגיות או מילות מפתח שמשויכות לשדה, ומשמשות לסיווג. לדוגמה: ['identifier',‏ 'customer',‏ 'pii']. בשלב הזה, נעשה שימוש בפרמטר הזה רק במקורות נתונים של BigQuery.
displayName

string

זה שינוי אופציונלי. השם המוצג של השדה (זהה לתווית ב-
subfields[]

object (Field)

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

string

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

string

זה שינוי אופציונלי. ‫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 (DataFilterType)
}
שדות
field

string

זה שינוי אופציונלי. השדה שלפיו יתבצע הסינון. לדוגמה: ‎["event_date", "customer_id", "product_category"]‎
value

string

זה שינוי אופציונלי. ערך ברירת המחדל שמשמש לסינון הזה אם לא מבטלים את הסינון בשאילתה. לדוגמה: ‎["after 2024-01-01", "123", "-fashion"]‎
type

enum (DataFilterType)

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

DataFilterType

סוג המסנן שקיים במקור נתונים, כמו ALWAYS_FILTER.

טיפוסים בני מנייה (enum)
DATA_FILTER_TYPE_UNSPECIFIED לא צוין סוג המסנן.
ALWAYS_FILTER מסנן שהמשתמש מגדיר, וכל שאילתות החיפוש ב-Explore יחילו את המסנן הזה תמיד כברירת מחדל. בשלב הזה, המאפיין הזה משמש רק למקורות נתונים של Looker.

BigQueryPropertyGraphReference

הודעה שמייצגת הפניה לגרף נכסים יחיד ב-BigQuery.

ייצוג ב-JSON 
{
  "projectId": string,
  "datasetId": string,
  "propertyGraphId": string
}
שדות
projectId

string

חובה. הפרויקט שאליו שייך גרף הנכסים.
datasetId

string

חובה. מערך הנתונים שאליו שייך גרף הנכסים.
propertyGraphId

string

חובה. המזהה של גרף הנכסים.

StudioDatasourceReferences

הודעה שמייצגת הפניות למקורות נתונים של Looker Studio.

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

object (StudioDatasourceReference)

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

StudioDatasourceReference

הודעה שמייצגת הפניה למקור נתונים יחיד ב-Looker Studio.

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

string

חובה. המזהה של מקור הנתונים.

LookerExploreReferences

הודעה שמייצגת הפניות לניתוחים ב-Looker.

ייצוג ב-JSON 
{
  "exploreReferences": [
    {
      object (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
שדות
exploreReferences[]

object (LookerExploreReference)

חובה. הפניות ל-Looker Explore.
credentials
(deprecated)

object (Credentials)

זה שינוי אופציונלי. הוצא משימוש: צריך להשתמש בפרטי כניסה ב-ChatRequest. פרטי הכניסה שבהם יש להשתמש כשקוראים ל-Looker API.

בשלב הזה יש תמיכה בפרטי כניסה שמבוססים על אסימון OAuth ועל מפתח API, כמו שמתואר במאמר אימות באמצעות SDK.

LookerExploreReference

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

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

  // Union field instance can be only one of the following:
  "lookerInstanceUri": string,
  "privateLookerInstanceInfo": {
    object (PrivateLookerInstanceInfo)
  }
  // End of list of possible types for union field instance.
}
שדות
lookmlModel

string

חובה. מודל Looker, כפי שמתואר במאמר מבנים עיקריים של LookML. השם של מודל LookML.
explore

string

חובה. ‫Looker Explore, כפי שמתואר במאמר Major LookML structures. השם של הניתוח ב-LookML.
schema

object (Schema)

זה שינוי אופציונלי. הסכימה של מקור הנתונים.
שדה איחוד instance. המופע של הניתוח ב-Looker. הערך instance יכול להיות רק אחד מהבאים:
lookerInstanceUri

string

חובה. כתובת ה-URL הבסיסית של המופע ב-Looker.
privateLookerInstanceInfo

object (PrivateLookerInstanceInfo)

פרטים על מופע פרטי של Looker.

PrivateLookerInstanceInfo

הודעה שמייצגת מידע על מופע פרטי של Looker, שנדרשת אם מופע Looker נמצא מאחורי רשת פרטית.

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

string

מזהה המופע ב-Looker.
serviceDirectoryName

string

השם של מופע Looker בספריית השירותים.

פרטי כניסה

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

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג פרטי הכניסה. הערך kind יכול להיות רק אחד מהבאים:
oauth

object (OAuthCredentials)

פרטי כניסה של OAuth.

OAuthCredentials

ייצוג של פרטי כניסה של OAuth.

ייצוג ב-JSON 
{

  // Union field kind can be only one of the following:
  "secret": {
    object (SecretBased)
  },
  "token": {
    object (TokenBased)
  }
  // End of list of possible types for union field kind.
}
שדות
שדה איחוד kind. סוג פרטי הכניסה של OAuth. הערך kind יכול להיות רק אחד מהבאים:
secret

object (SecretBased)

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

object (TokenBased)

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

SecretBased

השם של הסוד שמכיל את אסימון הגישה. מייצג פרטי כניסה של OAuth שמבוססים על סוד.

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

string

חובה. מזהה לקוח ב-OAuth.
clientSecret

string

חובה. סוד של לקוח OAuth.

TokenBased

מידע נוסף על טוקנים לגישה ל-Looker זמין כאן: https://developers.looker.com/api/advanced-usage/looker-api-oauth

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

string

חובה. השם של הסוד שמכיל את אסימון הגישה.

AlloyDbReference

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

ייצוג ב-JSON 
{
  "databaseReference": {
    object (AlloyDbDatabaseReference)
  },
  "agentContextReference": {
    object (AgentContextReference)
  }
}
שדות
databaseReference

object (AlloyDbDatabaseReference)

חובה. פרוטו יחיד שתומך בציון מסד הנתונים והטבלאות שייכללו.
agentContextReference

object (AgentContextReference)

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

AlloyDbDatabaseReference

הודעה שמייצגת הפניה למסד נתונים יחיד של AlloyDB.

ייצוג ב-JSON 
{
  "projectId": string,
  "region": string,
  "clusterId": string,
  "instanceId": string,
  "databaseId": string,
  "tableIds": [
    string
  ],
  "databaseTableReferences": [
    {
      object (DatabaseTableReference)
    }
  ]
}
שדות
projectId

string

חובה. הפרויקט שהמופע שייך אליו.
region

string

חובה. האזור של המכונה.
clusterId

string

חובה. מזהה האשכול.
instanceId

string

חובה. מזהה המופע.
databaseId

string

חובה. מזהה מסד הנתונים.
tableIds[]

string

זה שינוי אופציונלי. מזהי הטבלה. אם לא מוגדר, מציין את כל הטבלאות.
databaseTableReferences[]

object (DatabaseTableReference)

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

DatabaseTableReference

הודעה שמייצגת טבלה, כולל הסכימה שלה.

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

string

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

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

דרישות: – התאמה מדויקת: השם שסיפקתם חייב להיות זהה לשם שמאוחסן במסד הנתונים. – הבחנה בין אותיות גדולות לקטנות: צריך לפעול בהתאם לכללים של מערכת מסד הנתונים הספציפית בנוגע להבחנה בין אותיות גדולות לקטנות, ולפי האופן שבו הטבלה נוצרה. לדוגמה, יכול להיות ששמות הטבלאות 'Orders' ו-'orders' יהיו שונים. – תווים מיוחדים/מילות מפתח: אם שם הטבלה כולל רווחים, תווים מיוחדים או מילת מפתח שמורה במסד הנתונים, צריך לספק את השם המילולי כפי שהוא מאוחסן. אל תוסיפו תווים של ציטוט מזהים שספציפיים למסד נתונים (לדוגמה, ", `, []).

דוגמאות: – שם פשוט: orders,‏ UserActivity – שם שרגיש לאותיות רישיות: MyTable – שם עם רווחים: Order Details – שם עם תווים מיוחדים אחרים: user/data,‏ order-items – שם שהוא מילת מפתח: Group,‏ Order

הרשאות: לפרטי הכניסה של המתקשר צריכות להיות הרשאות מסד הנתונים הנדרשות כדי לגשת לסכימה ולנתונים של הטבלה.
schema

object (Schema)

זה שינוי אופציונלי. הסכימה של הטבלה.

AgentContextReference

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

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

string

חובה. מזהה של קבוצת הקשר שרוצים לאחזר.

SpannerReference

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

ייצוג ב-JSON 
{
  "databaseReference": {
    object (SpannerDatabaseReference)
  },
  "agentContextReference": {
    object (AgentContextReference)
  }
}
שדות
databaseReference

object (SpannerDatabaseReference)

חובה. פרוטו יחיד שתומך בציון מסד הנתונים והטבלאות שייכללו.
agentContextReference

object (AgentContextReference)

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

SpannerDatabaseReference

הודעה שמייצגת הפניה למסד נתונים יחיד ב-Spanner.

ייצוג ב-JSON 
{
  "engine": enum (Engine),
  "projectId": string,
  "instanceId": string,
  "databaseId": string,
  "tableIds": [
    string
  ],
  "databaseTableReferences": [
    {
      object (DatabaseTableReference)
    }
  ],
  "priority": string,
  "requestTag": string
}
שדות
engine

enum (Engine)

חובה. המנוע של מכונת Spanner.
projectId

string

חובה. הפרויקט שהמופע שייך אליו.
instanceId

string

חובה. מזהה המופע.
databaseId

string

חובה. מזהה מסד הנתונים.
tableIds[]

string

זה שינוי אופציונלי. מזהי הטבלה. אם לא מוגדר, מציין את כל הטבלאות.
databaseTableReferences[]

object (DatabaseTableReference)

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

string

זה שינוי אופציונלי. העדיפות של השאילתות ל-Spanner. צריך להזין ערך שנתמך על ידי Cloud Spanner, למשל: נמוכה, בינונית, גבוהה. המערכת תתעלם מערכים לא נתמכים. הרשימה המלאה מופיעה בכתובת https://docs.cloud.google.com/spanner/docs/reference/rest/v1/RequestOptions#Priority.
requestTag

string

תג שיצורף לכל השאילתות ל-Spanner. ההרשאה מאפשרת לזהות ולעקוב אחרי שאילתות שנשלחות ל-Spanner על ידי שירות GDA.

מנוע

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

טיפוסים בני מנייה (enum)
ENGINE_UNSPECIFIED לא צוין מנוע.
GOOGLE_SQL Google SQL
POSTGRESQL PostgreSQL

CloudSqlReference

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

ייצוג ב-JSON 
{
  "databaseReference": {
    object (CloudSqlDatabaseReference)
  },
  "agentContextReference": {
    object (AgentContextReference)
  }
}
שדות
databaseReference

object (CloudSqlDatabaseReference)

חובה. פרוטו יחיד שתומך בציון מסד הנתונים והטבלאות שייכללו.
agentContextReference

object (AgentContextReference)

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

CloudSqlDatabaseReference

הודעה שמייצגת הפניה למסד נתונים יחיד של CloudSQL.

ייצוג ב-JSON 
{
  "engine": enum (Engine),
  "projectId": string,
  "region": string,
  "instanceId": string,
  "databaseId": string,
  "tableIds": [
    string
  ],
  "databaseTableReferences": [
    {
      object (DatabaseTableReference)
    }
  ]
}
שדות
engine

enum (Engine)

חובה. המנוע של מכונת Cloud SQL.
projectId

string

חובה. הפרויקט שהמופע שייך אליו.
region

string

חובה. האזור של המכונה.
instanceId

string

חובה. מזהה המופע.
databaseId

string

חובה. מזהה מסד הנתונים.
tableIds[]

string

זה שינוי אופציונלי. מזהי הטבלה. אם לא מוגדר, מציין את כל הטבלאות.
databaseTableReferences[]

object (DatabaseTableReference)

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

מנוע

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

טיפוסים בני מנייה (enum)
ENGINE_UNSPECIFIED לא צוין מנוע.
POSTGRESQL PostgreSQL
MYSQL MySQL

ConversationOptions

אפשרויות לשיחה.

ייצוג ב-JSON 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  },
  "datasource": {
    object (DatasourceOptions)
  },
  "model": enum (Model)
}
שדות
chart

object (ChartOptions)

זה שינוי אופציונלי. אפשרויות ליצירת תרשים.
analysis

object (AnalysisOptions)

זה שינוי אופציונלי. אפשרויות לניתוח.
datasource

object (DatasourceOptions)

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

enum (Model)

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

ChartOptions

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

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

object (ImageOptions)

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

ImageOptions

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

ייצוג ב-JSON 
{

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

object (NoImage)

אין תמונה.
svg

object (SvgOptions)

פורמט SVG.

NoImage

בסוג הזה אין שדות.

אין תמונה.

SvgOptions

בסוג הזה אין שדות.

אפשרויות SVG.

AnalysisOptions

אפשרויות לניתוח.

ייצוג ב-JSON 
{
  "python": {
    object (Python)
  }
}
שדות
python

object (Python)

זה שינוי אופציונלי. אפשרויות לניתוח Python.

Python

אפשרויות לניתוח Python.

ייצוג ב-JSON 
{
  "enabled": boolean
}
שדות
enabled

boolean

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

DatasourceOptions

אפשרויות להגדרות של מקורות נתונים.

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

string (Int64Value format)

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

דגם

המודלים שמותרים לסוכן או לשיחה.

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

ExampleQuery

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

ייצוג ב-JSON 
{
  "naturalLanguageQuestion": string,
  "parameters": [
    {
      object (QueryParameter)
    }
  ],

  // Union field query can be only one of the following:
  "sqlQuery": string
  // End of list of possible types for union field query.
}
שדות
naturalLanguageQuestion

string

זה שינוי אופציונלי. שאלה בשפה טבעית שמשתמש עשוי לשאול. לדוגמה: "כמה הזמנות בוצעו בחודש שעבר?"
parameters[]

object (QueryParameter)

זה שינוי אופציונלי. רשימת הפרמטרים של השאילתה. דוגמה: אפשר להתאים את שאילתת ה-SQL עם הפרמטרים "SELECT * FROM my_table WHERE id = @id" לכל ערך של id.
שדה איחוד query. שאילתת ה-SQL או Looker שצריך ליצור כדי לענות על השאילתה בשפה טבעית. הערך query יכול להיות רק אחד מהבאים:
sqlQuery

string

זה שינוי אופציונלי. שאילתת ה-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

string

חובה. השם של הפניה לפרמטר בשאילתת ה-SQL.
description

string

זה שינוי אופציונלי. תיאור הפרמטר שאפשר להשתמש בו כדי לחלץ את ערך הפרמטר משאלת המשתמש באמצעות LLM.
dataType

string

חובה. סוג הנתונים של הפרמטר, למשל STRING,‏ INT64,‏ DATE וכו'. ערכים תקינים מפורטים במאמרי העזרה של BigQuery. הערך הזה ישמש לאכלוס של google.cloud.bigquery.v2.QueryParameterType.type.

LookerGoldenQuery

שאילתה לדוגמה ל-Looker, כולל שאלות בשפה טבעית ושאילתת Looker תואמת. מקביל ל-ExampleQuery.

ייצוג ב-JSON 
{
  "naturalLanguageQuestions": [
    string
  ],
  "lookerQuery": {
    object (LookerQuery)
  }
}
שדות
naturalLanguageQuestions[]

string

זה שינוי אופציונלי. שאלות בשפה טבעית שמשתמש עשוי לשאול. לדוגמה: "כמה הזמנות בוצעו בחודש שעבר?"
lookerQuery

object (LookerQuery)

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

LookerQuery

‫Looker Query Object Looker API documentation.

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

string

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

string

חובה. השאילתה שנוצרה באמצעות כלי הניתוח LookML.
fields[]

string

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

object (Filter)

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

string

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

string

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

string

זה שינוי אופציונלי. המזהה הראשי של משאב השאילתה ב-Looker, שמשמש לפעולות API. תואם ל-id (או ל-slug) במקור המידע Query של Looker API.
clientId

string

זה שינוי אופציונלי. המזהה הקצר האלפאנומרי של השאילתה, שמשמש לקישורי שיתוף ולכתובות URL של התכונה 'גילוי תובנות' (למשל, בפרמטר qid). ממופה אל clientId במקור המידע של Looker API Query.

מסנן

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

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

string

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

string

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

GlossaryTerm

הגדרה של מונח בדומיין ספציפי.

ייצוג ב-JSON 
{
  "displayName": string,
  "description": string,
  "labels": [
    string
  ]
}
שדות
displayName

string

חובה. שם המונח במילון המונחים שמוגדר, שקל להבין. לדוגמה: 'CTR',‏ 'שיעור המרה',‏ 'בהמתנה'
description

string

חובה. התיאור או המשמעות של המונח. לדוגמה: "שיעור הקליקים", "אחוז המשתמשים שמשלימים פעולה רצויה", "הזמנה שממתינה לעיבוד".
labels[]

string

זה שינוי אופציונלי. רשימה של תוויות לשימוש כללי שמשויכות למונח הזה. לדוגמה: ‎["שיעור קליקים", "קליקים", "waiting"]‎

SchemaRelationship

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

ייצוג ב-JSON 
{
  "leftSchemaPaths": {
    object (SchemaPaths)
  },
  "rightSchemaPaths": {
    object (SchemaPaths)
  },
  "sources": [
    enum (Source)
  ],
  "confidenceScore": number
}
שדות
leftSchemaPaths

object (SchemaPaths)

רשימה ממוינת של שדות לצירוף מהטבלה הראשונה. הגודל של הרשימה הזו צריך להיות זהה לערך rightSchemaPaths. כל שדה באינדקס i ברשימה הזו צריך להתאים לשדה באותו אינדקס ברשימה rightSchemaPaths.
rightSchemaPaths

object (SchemaPaths)

רשימה מסודרת של שדות לצירוף מהטבלה השנייה. הגודל של הרשימה הזו צריך להיות זהה לערך leftSchemaPaths. כל שדה באינדקס i ברשימה הזו צריך להתאים לשדה באותו אינדקס ברשימה leftSchemaPaths.
sources[]

enum (Source)

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

number

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

SchemaPaths

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

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

string

שם המשאב המלא של הטבלה שמוגדר במלואו על ידי השירות. דוגמה: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
paths[]

string

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

מקור

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

טיפוסים בני מנייה (enum)
SOURCE_UNSPECIFIED לא צוין המקור של קשר הסכימה.
BIGQUERY_JOB_HISTORY המקור של קשר הסכימה הוא היסטוריית העבודות ב-BigQuery.
LLM_SUGGESTED המקור של קשר הסכימה הוא הצעה של LLM.
BIGQUERY_TABLE_CONSTRAINTS המקור של קשר הסכימה הוא אילוצים של טבלאות BigQuery.

UserFunctions

אוסף של פונקציות משתמש שייכללו בהקשר.

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

object (BigQueryRoutine)

רשימה של שגרות ב-BigQuery שרוצים לכלול בהקשר.

BigQueryRoutine

הפניה לשגרה של BigQuery.

ייצוג ב-JSON 
{
  "routineReference": {
    object (BigQueryRoutineReference)
  },
  "description": string
}
שדות
routineReference

object (BigQueryRoutineReference)

ההפניה לשגרה של BigQuery.
description

string

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

BigQueryRoutineReference

הפניה לשגרה של BigQuery.

ייצוג ב-JSON 
{
  "projectId": string,
  "datasetId": string,
  "routineId": string
}
שדות
projectId

string

מזהה הפרויקט של השגרה.
datasetId

string

המזהה של קבוצת הנתונים של השגרה.
routineId

string

המזהה של השגרה.

Methods

create

 יוצרת DataAgent חדש בפרויקט ובמיקום נתונים נתונים.

createSync

 יוצרת DataAgent חדש בפרויקט ובמיקום נתונים נתונים באופן סינכרוני.

delete

 מחיקת סוכן נתונים יחיד.

deleteSync

 מחיקה של DataAgent יחיד באופן סינכרוני.

get

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

getIamPolicy

 קבלת מדיניות IAM עבור DataAgent

list

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

listAccessible

 השיטה מחזירה רשימה של סוכני נתונים שהמתקשר יכול לגשת אליהם בפרויקט ובמיקום נתונים מסוימים.

patch

 עדכון הפרמטרים של DataAgent יחיד.

setIamPolicy

 הגדרת מדיניות IAM עבור DataAgent.

updateSync

 מעדכן את הפרמטרים של DataAgent יחיד באופן סינכרוני.