- 資源:DataAgent
- DataAnalyticsAgent
- 背景資訊
- DatasourceReferences
- BigQueryTableReferences
- BigQueryTableReference
- 結構定義
- Field
- DataFilter
- DataFilterType
- StudioDatasourceReferences
- StudioDatasourceReference
- LookerExploreReferences
- LookerExploreReference
- PrivateLookerInstanceInfo
- 憑證
- OAuthCredentials
- SecretBased
- TokenBased
- AlloyDbReference
- AlloyDbDatabaseReference
- AgentContextReference
- SpannerReference
- SpannerDatabaseReference
- 引擎
- CloudSqlReference
- CloudSqlDatabaseReference
- 引擎
- ConversationOptions
- ChartOptions
- ImageOptions
- NoImage
- SvgOptions
- AnalysisOptions
- Python
- DatasourceOptions
- ExampleQuery
- LookerQuery
- 篩選器
- GlossaryTerm
- SchemaRelationship
- SchemaPaths
- 來源
- 方法
資源: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 |
資料分析師。 |
DataAnalyticsAgent
說明 DataAnalyticsAgent 物件的訊息。
| JSON 表示法 |
|---|
{ "stagingContext": { object ( |
| 欄位 | |
|---|---|
stagingContext |
選用。代理程式的暫存環境。這個環境可用於測試及驗證變更,然後再發布。 |
publishedContext |
選用。代理程式的已發布環境。Chat API 會在正式版中使用這個環境。 |
lastPublishedContext |
僅供輸出。代理程式上次發布的背景資訊。這是輸出專用欄位,系統會在發布的環境更新時填入這個欄位。用於將代理程式還原至先前的狀態。 |
背景資訊
要套用至這場對話的內容集合
| JSON 表示法 |
|---|
{ "systemInstruction": string, "datasourceReferences": { object ( |
| 欄位 | |
|---|---|
systemInstruction |
選用。資料擁有者為 Agent 建立網域知識的基本進入點。 原因:商業術語 (例如「藍海策略」)例如,提供計算年初至今收益的公式、美國的退休年齡為 65 歲等資訊,以及系統指令 (例如:以海盜的口吻回覆),有助於模型瞭解使用者問題的業務背景。 |
datasourceReferences |
這是必要旗標,可用於回答問題的資料來源。 |
options |
選用。對話的其他選項。 |
exampleQueries[] |
選用。範例查詢清單,提供相關且常用的 SQL 查詢範例,以及對應的自然語言查詢 (選用)。目前僅適用於 BigQuery 資料來源。 |
glossaryTerms[] |
選用。字詞定義 (目前僅限使用者撰寫) |
schemaRelationships[] |
選用。資料表結構定義之間的關係,包括參照和參照的資料欄。 |
DatasourceReferences
資料來源的參照集合。
| JSON 表示法 |
|---|
{ // Union field |
| 欄位 | |
|---|---|
聯集欄位 references。要使用的資料來源。references 只能是下列其中一個設定: |
|
bq |
BigQuery 資料表的參照。 |
studio |
參照 Looker Studio 資料來源。 |
looker |
Looker 探索的參照。 |
alloydb |
參照 AlloyDB 資料庫。僅支援 |
spannerReference |
參照 Spanner 資料庫。僅支援 |
cloudSqlReference |
CloudSql 資料庫的參照。僅支援 |
BigQueryTableReferences
代表 BigQuery 資料表和資源圖表參照的訊息。至少須填寫 tableReferences 或 propertyGraphReferences 任一項。
| JSON 表示法 |
|---|
{
"tableReferences": [
{
object ( |
| 欄位 | |
|---|---|
tableReferences[] |
選用。BigQuery 資料表的參照。 |
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 |
選用。欄位顯示名稱 (與 |
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 資料來源。 |
StudioDatasourceReferences
Message representing references to Looker Studio datasources.
| JSON 表示法 |
|---|
{
"studioReferences": [
{
object ( |
| 欄位 | |
|---|---|
studioReferences[] |
工作室資料來源的參照。 |
StudioDatasourceReference
訊息,代表對單一 Looker Studio 資料來源的參照。
| JSON 表示法 |
|---|
{ "datasourceId": string } |
| 欄位 | |
|---|---|
datasourceId |
這是必要旗標,資料來源的 ID。 |
LookerExploreReferences
代表 Looker 探索參照的訊息。
| JSON 表示法 |
|---|
{ "exploreReferences": [ { object ( |
| 欄位 | |
|---|---|
exploreReferences[] |
這是必要旗標,Looker 探索的參照。 |
credentials |
選用。呼叫 Looker API 時使用的憑證。 目前支援 OAuth 權杖和 API 金鑰型憑證,詳情請參閱「使用 SDK 進行驗證」。 |
LookerExploreReference
代表單一 Looker 探索參照的訊息。
| JSON 表示法 |
|---|
{ "lookmlModel": string, "explore": string, "schema": { object ( |
| 欄位 | |
|---|---|
lookmlModel |
這是必要旗標,如「主要 LookML 結構」一文所述,LookML 模型的名稱。 |
explore |
這是必要旗標,如「主要 LookML 結構」一文所述,Looker 探索是 LookML 專案的基礎。LookML 探索的名稱。 |
schema |
選用。資料來源的結構定義。 |
聯集欄位 instance。Looker 探索的執行個體。instance 只能是下列其中一個設定: |
|
lookerInstanceUri |
這是必要旗標,Looker 執行個體的基準網址。 |
privateLookerInstanceInfo |
私人 Looker 執行個體資訊。 |
PrivateLookerInstanceInfo
如果 Looker 執行個體位於私人網路後方,則必須提供代表私人 Looker 執行個體資訊的訊息。
| JSON 表示法 |
|---|
{ "lookerInstanceId": string, "serviceDirectoryName": string } |
| 欄位 | |
|---|---|
lookerInstanceId |
Looker 執行個體 ID。 |
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 用戶端 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 |
這是必要旗標,單一原型,支援指定要納入的資料庫和資料表。 |
agentContextReference |
選用。從代理程式內容擷取資料的參數。 |
AlloyDbDatabaseReference
代表單一 AlloyDB 資料庫參照的訊息。
| JSON 表示法 |
|---|
{ "projectId": string, "region": string, "clusterId": string, "instanceId": string, "databaseId": string, "tableIds": [ string ] } |
| 欄位 | |
|---|---|
projectId |
這是必要旗標,執行個體所屬的專案。 |
region |
這是必要旗標,執行個體的所在區域。 |
clusterId |
這是必要旗標,叢集 ID。 |
instanceId |
這是必要旗標,執行個體 ID。 |
databaseId |
這是必要旗標,資料庫 ID。 |
tableIds[] |
選用。資料表 ID。如果未設定,則表示所有資料表。 |
AgentContextReference
代表代理程式結構定義參照的訊息。
| JSON 表示法 |
|---|
{ "contextSetId": string } |
| 欄位 | |
|---|---|
contextSetId |
這是必要旗標,要擷取的內容集 ID。 |
SpannerReference
訊息,代表對 Spanner 資料庫和代理程式環境的參照。僅支援 QueryData 方法。
| JSON 表示法 |
|---|
{ "databaseReference": { object ( |
| 欄位 | |
|---|---|
databaseReference |
這是必要旗標,單一原型,支援指定要納入的資料庫和資料表。 |
agentContextReference |
選用。從代理程式內容擷取資料的參數。 |
SpannerDatabaseReference
代表單一 Spanner 資料庫參照的訊息。
| JSON 表示法 |
|---|
{
"engine": enum ( |
| 欄位 | |
|---|---|
engine |
這是必要旗標,Spanner 執行個體的引擎。 |
projectId |
這是必要旗標,執行個體所屬的專案。 |
region |
這是必要旗標,執行個體的所在區域。 |
instanceId |
這是必要旗標,執行個體 ID。 |
databaseId |
這是必要旗標,資料庫 ID。 |
tableIds[] |
選用。資料表 ID。如果未設定,則表示所有資料表。 |
引擎
資料庫引擎。
| 列舉 | |
|---|---|
ENGINE_UNSPECIFIED |
未指定引擎。 |
GOOGLE_SQL |
Google SQL |
POSTGRESQL |
PostgreSQL |
CloudSqlReference
訊息:代表 Cloud SQL 資料庫和代理程式環境的參照。僅支援 QueryData 方法。
| JSON 表示法 |
|---|
{ "databaseReference": { object ( |
| 欄位 | |
|---|---|
databaseReference |
這是必要旗標,單一原型,支援指定要納入的資料庫和資料表。 |
agentContextReference |
選用。從代理程式內容擷取資料的參數。 |
CloudSqlDatabaseReference
代表單一 CloudSQL 資料庫參照的訊息。
| JSON 表示法 |
|---|
{
"engine": enum ( |
| 欄位 | |
|---|---|
engine |
這是必要旗標,Cloud SQL 執行個體的引擎。 |
projectId |
這是必要旗標,執行個體所屬的專案。 |
region |
這是必要旗標,執行個體的所在區域。 |
instanceId |
這是必要旗標,執行個體 ID。 |
databaseId |
這是必要旗標,資料庫 ID。 |
tableIds[] |
選用。資料表 ID。如果未設定,則表示所有資料表。 |
引擎
資料庫引擎。
| 列舉 | |
|---|---|
ENGINE_UNSPECIFIED |
未指定引擎。 |
POSTGRESQL |
PostgreSQL |
MYSQL |
MySQL |
ConversationOptions
對話選項。
| JSON 表示法 |
|---|
{ "chart": { object ( |
| 欄位 | |
|---|---|
chart |
選用。圖表產生選項。 |
analysis |
選用。分析選項。 |
datasource |
選用。資料來源的選項。 |
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 查詢的資料來源。針對每項 BQ 查詢工作指定會產生費用的位元組上限。如果查詢的計費位元組超出這個上限,查詢就會失敗 (不會產生費用)。如未指定,系統就不會套用限制。 |
ExampleQuery
相關且常用的 SQL 查詢範例,以及對應的自然語言查詢 (選用)。目前僅適用於 BigQuery 資料來源。
| JSON 表示法 |
|---|
{ "naturalLanguageQuestion": string, // Union field |
| 欄位 | |
|---|---|
naturalLanguageQuestion |
選用。使用者可能會提出的自然語言問題。例如:「上個月的訂單數是多少?」 |
聯集欄位 query。應生成 SQL 或 Looker 查詢,以回答自然語言查詢。query 只能是下列其中一個設定: |
|
sqlQuery |
選用。系統應生成哪些 SQL 查詢來回答自然語言問題。例如:「SELECT COUNT(*) FROM orders WHERE order_date BETWEEN '2024-01-01' AND '2024-01-31'」 |
LookerQuery
Looker 查詢物件 Looker API 說明文件。
| 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 |
這是必要旗標,要做為篩選依據的欄位值。 |
GlossaryTerm
特定領域的術語定義。
| JSON 表示法 |
|---|
{ "displayName": string, "description": string, "labels": [ string ] } |
| 欄位 | |
|---|---|
displayName |
這是必要旗標,定義的詞彙術語好記顯示名稱。例如:「CTR」、「轉換率」、「待處理」 |
description |
這是必要旗標,該詞彙的說明或意義。例如:「點擊率」、「完成理想動作的使用者百分比」、「等待處理的訂單」。 |
labels[] |
選用。與這個字詞相關聯的一般用途標籤清單。例如:["click rate", "clickthrough", "waiting"] |
SchemaRelationship
兩個資料表之間的關係,包括參照和參照的資料欄。這是從 Dataplex 資料集洞察擷取的衍生情境。
| 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[] |
資料表結構定義中的路徑排序清單。 |
來源
產生結構定義關係邊緣的來源。
| 列舉 | |
|---|---|
SOURCE_UNSPECIFIED |
未指定結構定義關係的來源。 |
BIGQUERY_JOB_HISTORY |
結構定義關係的來源是 BigQuery 工作記錄。 |
LLM_SUGGESTED |
結構定義關係的來源是 LLM 建議。 |
BIGQUERY_TABLE_CONSTRAINTS |
結構定義關係的來源是 BigQuery 資料表限制。 |
方法 |
|
|---|---|
|
在指定專案和位置建立新的 DataAgent。 |
|
刪除單一 DataAgent。 |
|
取得單一 DataAgent 的詳細資料。 |
|
取得 DataAgent 的 IAM 政策 |
|
列出指定專案和位置中的 DataAgent。 |
|
列出指定專案和位置中,呼叫者可存取的 DataAgent。 |
|
更新單一 DataAgent 的參數。 |
|
為 DataAgent 設定 IAM 政策。 |