- 資源: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
- 方法
資源:DataAgent
說明 DataAgent 物件的訊息。
| JSON 表示法 |
|---|
{ "name": string, "displayName": string, "description": string, "labels": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "purgeTime": string, // Union field |
| 欄位 | |
|---|---|
name |
選用。ID。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 |
僅供輸出。[Output only] 虛刪除資料代理的時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
purgeTime |
僅供輸出。資料代理到期時間的時間戳記 (世界標準時間)。不論輸入什麼內容,這項資訊「一律」會顯示在輸出內容中。 使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例: |
聯集欄位 type。代理類型。可以是下列任一值:* 資料分析代理。* 資料工程代理 type 只能是下列其中一個設定: |
|
dataAnalyticsAgent |
資料分析代理。 |
kmsKey |
選用。用於加密 DataAgent 資源的客戶自行管理加密金鑰 (CMEK)。Cloud KMS CryptoKey 必須與 DataAgent 位於相同位置。必須採用下列格式: |
DataAnalyticsAgent
說明 DataAnalyticsAgent 物件的訊息。
| JSON 表示法 |
|---|
{ "stagingContext": { object ( |
| 欄位 | |
|---|---|
stagingContext |
選用。代理的測試環境。這個情境用於在發布前測試及驗證變更。 |
publishedContext |
選用。代理的已發布脈絡資料。Chat API 會在正式環境中使用這項結構定義。 |
lastPublishedContext |
僅供輸出。代理上次發布的內容。這個欄位僅供輸出,系統會在更新已發布的內容時填入資料。用於將代理還原至先前的狀態。 |
背景資訊
要套用至這段對話的背景資訊集合
| JSON 表示法 |
|---|
{ "systemInstruction": string, "datasourceReferences": { object ( |
| 欄位 | |
|---|---|
systemInstruction |
選用。資料擁有者為代理建立領域知識的基本進入點。 原因:業務術語 (例如「本年迄今收益的計算方式為…」、「美國的退休年齡為 65 歲」等) 和系統指令 (例如「以海盜的口吻回答」) 可協助模型瞭解使用者問題的業務背景資訊。 |
datasourceReferences |
這是必要旗標,可用來回答問題的資料來源。 |
options |
選用。對話的其他選項。 |
exampleQueries[] |
選用。查詢範例清單,提供相關且常用的 SQL 查詢範例,以及對應的自然語言查詢 (如有)。目前僅用於 BigQuery 資料來源和資料庫 (AlloyDB、Cloud SQL、Spanner) 資料來源。 |
lookerGoldenQueries[] |
選用。精確查詢清單,提供相關且常用的 Looker 查詢範例,以及對應的自然語言查詢 (如有)。僅支援 Looker 資料來源。 |
glossaryTerms[] |
選用。字詞定義 (目前僅限使用者編寫) 不支援資料庫 (AlloyDB、Cloud SQL、Spanner) 資料來源。 |
schemaRelationships[] |
選用。資料表結構定義之間的關係,包括參照和參照的資料欄。 |
userFunctions |
選用。要納入情境的使用者函式集合。 |
DatasourceReferences
資料來源參照的集合。
| JSON 表示法 |
|---|
{ // Union field |
| 欄位 | |
|---|---|
聯集欄位 references。要使用的資料來源。references 只能是下列其中一個設定: |
|
bq |
BigQuery 資料表的參照。 |
studio |
Looker Studio 資料來源的參照。 |
looker |
Looker 探索的參照。 |
alloydb |
AlloyDB 資料庫的參照。僅支援 |
spannerReference |
Spanner 資料庫的參照。僅支援 |
cloudSqlReference |
Cloud SQL 資料庫的參照。僅支援 |
BigQueryTableReferences
代表 BigQuery 資料表和屬性圖參照的訊息。必須填寫 tableReferences、propertyGraphReferences 或 searchScope 至少其中一項。
| JSON 表示法 |
|---|
{ "tableReferences": [ { object ( |
| 欄位 | |
|---|---|
tableReferences[] |
選用。BigQuery 資料表的參照。 |
propertyGraphReferences[] |
選用。BigQuery 圖表參考資料。 注意:「屬性圖」是 BigQuery Graph 的舊稱。欄位和訊息名稱會保留原始字詞,以確保回溯相容性;兩者皆參照相同資源。 |
searchScope |
選用。搜尋 BigQuery 資源,找出與查詢最相關的資料表。 設定後, 注意: |
SearchScope
訊息,代表要套用至 BigQuery 資料表搜尋作業的篩選器。
includeProjectIds 或 includeDatasetReferences 至少有一項必須填入非空白 ID。系統會納入符合任一欄位的資料表,因此這兩個欄位會聯集 (OR),而非交集。
注意:SearchScope 僅支援獨立對話 (ChatRequest.inline_context 或 ClientManagedResourceContext.inline_context),不支援 DataAgent。
| JSON 表示法 |
|---|
{
"includeProjectIds": [
string
],
"includeDatasetReferences": [
{
object ( |
| 欄位 | |
|---|---|
includeProjectIds[] |
選用。要搜尋的 BigQuery 專案 ID。 |
includeDatasetReferences[] |
選用。要搜尋的 BigQuery 資料集參照。 |
BigQueryDatasetReference
代表單一 BigQuery 資料集參照的訊息。
| JSON 表示法 |
|---|
{ "projectId": string, "datasetId": string } |
| 欄位 | |
|---|---|
projectId |
這是必要旗標,資料集所屬的專案 ID。 |
datasetId |
這是必要旗標,資料集 ID。 |
BigQueryTableReference
代表單一 BigQuery 資料表參照的訊息。
| JSON 表示法 |
|---|
{
"projectId": string,
"datasetId": string,
"tableId": string,
"schema": {
object ( |
| 欄位 | |
|---|---|
projectId |
這是必要旗標,資料表所屬的專案。 |
datasetId |
這是必要旗標,資料表所屬的資料集。 |
tableId |
這是必要旗標,資料表 ID。 |
schema |
選用。資料來源的結構定義。 |
結構定義
Datasource 或 QueryResult 執行個體的結構定義。
| JSON 表示法 |
|---|
{ "fields": [ { object ( |
| 欄位 | |
|---|---|
fields[] |
選用。結構定義中的欄位。 |
description |
選用。資料表內容和用途的文字說明。例如:「包含電子商務商店的顧客訂單資訊。」目前僅用於 BigQuery 資料來源。 |
synonyms[] |
選用。可用來參照資料表的替代名稱或同義詞清單。例如:["sales", "orders", "purchases"]。目前僅用於 BigQuery 資料來源。 |
tags[] |
選用。與資料表相關聯的標記或關鍵字清單,用於分類。例如:["transaction", "revenue", "customer_data"]。目前僅用於 BigQuery 資料來源。 |
displayName |
選用。資料表 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 |
選用。欄位 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。
| 列舉 | |
|---|---|
DATA_FILTER_TYPE_UNSPECIFIED |
未指定篩選器類型。 |
ALWAYS_FILTER |
使用者設定的篩選器,根據預設,對探索的任何查詢一律會套用這項篩選器。目前僅適用於 Looker 資料來源。 |
BigQueryPropertyGraphReference
代表單一 BigQuery 屬性圖譜參照的訊息。
| JSON 表示法 |
|---|
{ "projectId": string, "datasetId": string, "propertyGraphId": string } |
| 欄位 | |
|---|---|
projectId |
這是必要旗標,屬性圖所屬的專案。 |
datasetId |
這是必要旗標,屬性圖所屬的資料集。 |
propertyGraphId |
這是必要旗標,屬性圖 ID。 |
StudioDatasourceReferences
代表 Looker Studio 資料來源參照的訊息。
| JSON 表示法 |
|---|
{
"studioReferences": [
{
object ( |
| 欄位 | |
|---|---|
studioReferences[] |
選用。Studio 資料來源的參照。 |
StudioDatasourceReference
代表單一 Looker Studio 資料來源參照的訊息。
| JSON 表示法 |
|---|
{ "datasourceId": string } |
| 欄位 | |
|---|---|
datasourceId |
這是必要旗標,資料來源的 ID。 |
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 探索,如「主要 LookML 結構」一節所述。LookML 探索的名稱。 |
schema |
選用。資料來源的結構定義。 |
聯集欄位 instance。Looker 探索的執行個體。instance 只能是下列其中一個設定: |
|
lookerInstanceUri |
這是必要旗標,Looker 執行個體的基準網址。 |
privateLookerInstanceInfo |
私人 Looker 執行個體資訊。 |
PrivateLookerInstanceInfo
如果 Looker 執行個體位於私人網路,則必須提供代表私人 Looker 執行個體資訊的訊息。
| JSON 表示法 |
|---|
{ "lookerInstanceId": string, "serviceDirectoryName": string } |
| 欄位 | |
|---|---|
lookerInstanceId |
Looker 執行個體 ID。 |
serviceDirectoryName |
Looker 執行個體的 Service Directory 名稱。 |
憑證
代表不同形式的憑證規格。
| 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 用戶端 ID。 |
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 |
這是必要旗標,單一 Proto,支援指定要納入的資料庫和資料表。 |
agentContextReference |
選用。從代理內容擷取資料的參數。 |
AlloyDbDatabaseReference
代表單一 AlloyDB 資料庫參照的訊息。
| JSON 表示法 |
|---|
{
"projectId": string,
"region": string,
"clusterId": string,
"instanceId": string,
"databaseId": string,
"tableIds": [
string
],
"databaseTableReferences": [
{
object ( |
| 欄位 | |
|---|---|
projectId |
這是必要旗標,執行個體所屬的專案。 |
region |
這是必要旗標,執行個體所在的區域。 |
clusterId |
這是必要旗標,叢集 ID。 |
instanceId |
這是必要旗標,執行個體 ID。 |
databaseId |
這是必要旗標,資料庫 ID。 |
tableIds[] |
選用。資料表 ID。如未設定,則代表所有資料表。 |
databaseTableReferences[] |
選用。資料庫中資料表的參照。每個參照都會指定資料表,並可選擇加入資料表的結構定義,為查詢提供背景資訊。 |
DatabaseTableReference
代表資料表 (包括其結構定義) 的訊息。
| JSON 表示法 |
|---|
{
"tableId": string,
"schema": {
object ( |
| 欄位 | |
|---|---|
tableId |
這是必要旗標,資料庫中定義的資料表名稱。 注意:資料表命名的精確規則 (包括有效字元、長度限制和大小寫區分) 由特定資料庫系統決定。 規定:- 完全比對:提供的姓名必須與資料庫中儲存的姓名完全一致。- 區分大小寫:請遵守特定資料庫系統的大小寫規則,以及資料表的建立方式。舉例來說,「Orders」和「orders」可能是不同的資料表名稱。- 特殊字元/關鍵字:如果資料表名稱包含空格、特殊字元,或是資料庫保留關鍵字,請提供儲存時的字面名稱。請勿新增任何資料庫專屬的 ID 引用字元 (例如 "、`、[])。 範例:- 簡單名稱:「orders」、「UserActivity」- 區分大小寫:「MyTable」- 包含空格的名稱:「Order Details」- 包含其他特殊字元的名稱:「user/data」、「order-items」- 關鍵字名稱:「Group」、「Order」 權限:呼叫端憑證必須具備必要的資料庫權限,才能存取資料表的結構定義和資料。 |
schema |
選用。資料表的結構定義。 |
AgentContextReference
代表代理結構定義參照的訊息。
| JSON 表示法 |
|---|
{ "contextSetId": string } |
| 欄位 | |
|---|---|
contextSetId |
這是必要旗標,要擷取的脈絡資料集 ID。 |
SpannerReference
代表 Spanner 資料庫和代理內容參照的訊息。僅支援 QueryData 方法。
| JSON 表示法 |
|---|
{ "databaseReference": { object ( |
| 欄位 | |
|---|---|
databaseReference |
這是必要旗標,單一 Proto,支援指定要納入的資料庫和資料表。 |
agentContextReference |
選用。從代理內容擷取資料的參數。 |
SpannerDatabaseReference
代表單一 Spanner 資料庫參照的訊息。
| JSON 表示法 |
|---|
{ "engine": enum ( |
| 欄位 | |
|---|---|
engine |
這是必要旗標,Spanner 執行個體的引擎。 |
projectId |
這是必要旗標,執行個體所屬的專案。 |
instanceId |
這是必要旗標,執行個體 ID。 |
databaseId |
這是必要旗標,資料庫 ID。 |
tableIds[] |
選用。資料表 ID。如未設定,則代表所有資料表。 |
databaseTableReferences[] |
選用。資料庫中資料表的參照。每個參照都會指定資料表,並可選擇加入資料表的結構定義,為查詢提供背景資訊。 |
priority |
選用。Spanner 查詢的優先順序。必須是 Cloud Spanner 支援的值,例如:低、中、高。系統會忽略不支援的值。如需完整清單,請參閱 https://docs.cloud.google.com/spanner/docs/reference/rest/v1/RequestOptions#Priority。 |
requestTag |
要附加至所有 Spanner 查詢的標記。可識別及監控 GDA 服務傳送至 Spanner 的查詢。 |
引擎
資料庫引擎。
| 列舉 | |
|---|---|
ENGINE_UNSPECIFIED |
未指定引擎。 |
GOOGLE_SQL |
Google SQL |
POSTGRESQL |
PostgreSQL |
CloudSqlReference
代表 Cloud SQL 資料庫和代理內容參照的訊息。僅支援 QueryData 方法。
| JSON 表示法 |
|---|
{ "databaseReference": { object ( |
| 欄位 | |
|---|---|
databaseReference |
這是必要旗標,單一 Proto,支援指定要納入的資料庫和資料表。 |
agentContextReference |
選用。從代理內容擷取資料的參數。 |
CloudSqlDatabaseReference
代表單一 CloudSQL 資料庫參照的訊息。
| JSON 表示法 |
|---|
{ "engine": enum ( |
| 欄位 | |
|---|---|
engine |
這是必要旗標,Cloud SQL 執行個體的引擎。 |
projectId |
這是必要旗標,執行個體所屬的專案。 |
region |
這是必要旗標,執行個體所在的區域。 |
instanceId |
這是必要旗標,執行個體 ID。 |
databaseId |
這是必要旗標,資料庫 ID。 |
tableIds[] |
選用。資料表 ID。如未設定,則代表所有資料表。 |
databaseTableReferences[] |
選用。資料庫中資料表的參照。每個參照都會指定資料表,並可選擇加入資料表的結構定義,為查詢提供背景資訊。 |
引擎
資料庫引擎。
| 列舉 | |
|---|---|
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 查詢工作的計費位元組數上限。如果會產生費用的位元組數超過這個上限,查詢就會失敗 (不會產生費用)。如未指定,就不會套用限制。 |
模型
代理/對話允許使用的模型。
| 列舉 | |
|---|---|
MODEL_UNSPECIFIED |
未指定模型。模型可能是在對話要求中設定,或使用預設模型。 |
LATEST_GA_MODEL |
使用最新的非預先發布版模型。這可能會限制某些請求層級設定。 |
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 查詢物件 Looker API 說明文件。
| JSON 表示法 |
|---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
| 欄位 | |
|---|---|
model |
這是必要旗標,用於生成查詢的 LookML 模型。 |
explore |
這是必要旗標,用於產生查詢的 LookML 探索。 |
fields[] |
選用。要從探索中擷取的欄位。 |
filters[] |
選用。要套用至探索的篩選器。 |
sorts[] |
選用。要套用至探索的排序。 |
limit |
選用。查詢中的限制。 |
queryId |
選用。Looker 查詢資源的主要 ID,用於 API 作業。對應至 Looker API |
clientId |
選用。查詢的簡短英數字元 ID,用於分享連結和探索網址 (例如 |
篩選器
Looker 查詢篩選器。
| JSON 表示法 |
|---|
{ "field": string, "value": string } |
| 欄位 | |
|---|---|
field |
這是必要旗標,要篩選的欄位。 |
value |
選用。篩選依據欄位的值。選用,因此我們可以將預設值保留為空字串,這對於取得有效且可運作的 Looker Explore 網址很重要。 |
GlossaryTerm
特定領域中某個字詞的定義。
| JSON 表示法 |
|---|
{ "displayName": string, "description": string, "labels": [ string ] } |
| 欄位 | |
|---|---|
displayName |
這是必要旗標,定義中詞彙表字詞的易懂顯示名稱。例如:「點閱率」、「轉換率」、「待處理」 |
description |
這是必要旗標,詞彙的說明或意義。例如:「點閱率」、「完成指定動作的使用者百分比」、「待處理的訂單」。 |
labels[] |
選用。與這個字詞相關聯的一般用途標籤清單。例如:["點擊率", "點閱次數", "waiting"] |
SchemaRelationship
兩個資料表之間的關係,包括參照和參照的資料欄。這是從 Dataplex 資料集洞察擷取的衍生背景資訊。
| JSON 表示法 |
|---|
{ "leftSchemaPaths": { object ( |
| 欄位 | |
|---|---|
leftSchemaPaths |
第一個資料表中要 join 的欄位已排序的清單。這份清單的大小必須與 |
rightSchemaPaths |
第二個資料表中用於彙整的已排序欄位清單。這份清單的大小必須與 |
sources[] |
選用。產生結構定義關係邊緣的來源。 |
confidenceScore |
選用。建議關係的可信度分數。手動新增的邊緣可信度分數最高。 |
SchemaPaths
代表資料表結構定義中一組已排序的路徑。
| JSON 表示法 |
|---|
{ "tableFqn": string, "paths": [ string ] } |
| 欄位 | |
|---|---|
tableFqn |
資料表的服務限定完整資源名稱,例如:bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID |
paths[] |
資料表結構定義中已排序的清單路徑。 |
來源
產生結構定義關係邊緣的來源。
| 列舉 | |
|---|---|
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 |
使用者覆寫或新增的說明,用於告知代理何時使用 UDF。 |
BigQueryRoutineReference
BigQuery 處理常式的參照。
| JSON 表示法 |
|---|
{ "projectId": string, "datasetId": string, "routineId": string } |
| 欄位 | |
|---|---|
projectId |
常式的專案 ID。 |
datasetId |
常式的資料集 ID。 |
routineId |
日常安排的 ID。 |
方法 |
|
|---|---|
|
在指定專案和位置建立新的 DataAgent。 |
|
在指定專案和位置同步建立新的 DataAgent。 |
|
刪除單一 DataAgent。 |
|
同步刪除單一 DataAgent。 |
|
取得單一 DataAgent 的詳細資料。 |
|
取得 DataAgent 的 IAM 政策 |
|
列出指定專案和位置中的 DataAgent。 |
|
列出呼叫者在指定專案和位置中可存取的 DataAgent。 |
|
更新單一 DataAgent 的參數。 |
|
設定 DataAgent 的 IAM 政策。 |
|
同步更新單一 DataAgent 的參數。 |