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.
}
欄位
name

string

(選用步驟) ID。DataAgent 的專屬資源名稱。格式：projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} 是資源 ID，長度不得超過 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 至 1024 個字元之間。
labels

map (key: string, value: string)

(選用步驟) 標籤可協助使用者篩選相關聯的代理程式。例如「sales」、「business」、「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)

僅供輸出。[Output only] 虛刪除資料代理程式的時間。

使用 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)

僅供輸出。資料代理程式到期時間的時間戳記 (世界標準時間)。不論輸入什麼內容，這項資訊「一律」會顯示在輸出內容中。

使用 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)

資料分析師。

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)
    }
  ],
  "glossaryTerms": [
    {
      object (GlossaryTerm)
    }
  ],
  "schemaRelationships": [
    {
      object (SchemaRelationship)
    }
  ]
}
欄位
systemInstruction

string

(選用步驟) 資料擁有者為 Agent 建立網域知識的基本進入點。

原因：商業術語 (例如年至今收益的計算方式為…、美國的退休年齡為 65 歲等)，以及系統指令 (例如：以海盜的口吻回答)，有助於模型瞭解使用者問題的業務背景。
datasourceReferences

object (DatasourceReferences)

這是必要旗標，可用於回答問題的資料來源。
options

object (ConversationOptions)

(選用步驟) 對話的其他選項。
exampleQueries[]

object (ExampleQuery)

(選用步驟) 範例查詢清單，提供相關且常用的 SQL 查詢範例，以及對應的自然語言查詢 (選用)。目前僅適用於 BigQuery 資料來源。
glossaryTerms[]

object (GlossaryTerm)

(選用步驟) 字詞定義 (目前僅限使用者撰寫)
schemaRelationships[]

object (SchemaRelationship)

(選用步驟) 資料表結構定義之間的關係，包括參照和被參照的資料欄。

DatasourceReferences

資料來源的參照集合。

JSON 表示法 
{

  // Union field references can be only one of the following:
  "bq": {
    object (BigQueryTableReferences)
  },
  "studio": {
    object (StudioDatasourceReferences)
  },
  "looker": {
    object (LookerExploreReferences)
  }
  // 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 探索的參照。

BigQueryTableReferences

代表 BigQuery 資料表參照的訊息。

JSON 表示法 
{
  "tableReferences": [
    {
      object (BigQueryTableReference)
    }
  ]
}
欄位
tableReferences[]

object (BigQueryTableReference)

這是必要旗標，BigQuery 資料表的參照。

BigQueryTableReference

代表單一 BigQuery 資料表參照的訊息。

JSON 表示法 
{
  "projectId": string,
  "datasetId": string,
  "tableId": string,
  "schema": {
    object (Schema)
  }
}
欄位
projectId

string

這是必要旗標，資料表所屬的專案。
datasetId

string

這是必要旗標，資料表所屬的資料集。
tableId

string

這是必要旗標，資料表 ID。
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。

列舉
DATA_FILTER_TYPE_UNSPECIFIED 未指定篩選類型。
ALWAYS_FILTER 使用者設定的篩選條件，以及對「探索」提出的任何查詢，預設都會套用這項篩選條件。目前僅適用於 Looker 資料來源。

StudioDatasourceReferences

訊息，代表對 Looker Studio 資料來源的參照。

JSON 表示法 
{
  "studioReferences": [
    {
      object (StudioDatasourceReference)
    }
  ]
}
欄位
studioReferences[]

object (StudioDatasourceReference)

工作室資料來源的參照。

StudioDatasourceReference

訊息，代表對單一 Looker Studio 資料來源的參照。

JSON 表示法 
{
  "datasourceId": string
}
欄位
datasourceId

string

這是必要旗標，資料來源的 ID。

LookerExploreReferences

代表 Looker 探索參照的訊息。

JSON 表示法 
{
  "exploreReferences": [
    {
      object (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
欄位
exploreReferences[]

object (LookerExploreReference)

這是必要旗標，Looker 探索的參照。
credentials

object (Credentials)

(選用步驟) 呼叫 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

這是必要旗標，如「主要 LookML 結構」一文所述的 Looker 模型。LookML 模型的名稱。
explore

string

這是必要旗標，如「主要的 LookML 結構」一文所述，Looker Explore LookML 探索的名稱。
schema

object (Schema)

(選用步驟) 資料來源的結構定義。
聯集欄位 instance。Looker 探索的執行個體。instance 只能是下列其中一項：
lookerInstanceUri

string

這是必要旗標，Looker 執行個體的基準網址。
privateLookerInstanceInfo

object (PrivateLookerInstanceInfo)

私人 Looker 執行個體資訊。

PrivateLookerInstanceInfo

如果 Looker 執行個體位於私人網路後方，則必須提供代表私人 Looker 執行個體資訊的訊息。

JSON 表示法 
{
  "lookerInstanceId": string,
  "serviceDirectoryName": string
}
欄位
lookerInstanceId

string

Looker 執行個體 ID。
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 用戶端 ID。
clientSecret

string

這是必要旗標，OAuth 用戶端密鑰。

TokenBased

如要進一步瞭解 Looker 存取權杖，請參閱：https://developers.looker.com/api/advanced-usage/looker-api-oauth

JSON 表示法 
{
  "accessToken": string
}
欄位
accessToken

string

這是必要旗標，包含存取權杖的密鑰名稱。

ConversationOptions

對話選項。

JSON 表示法 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  }
}
欄位
chart

object (ChartOptions)

(選用步驟) 圖表產生選項。
analysis

object (AnalysisOptions)

(選用步驟) 分析選項。

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。

ExampleQuery

相關且常用的 SQL 查詢範例，以及對應的自然語言查詢 (選用)。目前僅適用於 BigQuery 資料來源。

JSON 表示法 
{
  "naturalLanguageQuestion": string,

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

string

(選用步驟) 使用者可能會提出的自然語言問題。例如：「上個月的訂單數是多少？」
聯集欄位 query。系統應生成 SQL 或 Looker 查詢，以回答自然語言查詢。query 只能是下列其中一項：
sqlQuery

string

(選用步驟) 系統應生成哪些 SQL 查詢，才能回答自然語言問題。例如：「SELECT COUNT(*) FROM orders WHERE order_date BETWEEN '2024-01-01' AND '2024-01-31'」

GlossaryTerm

特定領域的術語定義。

JSON 表示法 
{
  "displayName": string,
  "description": string,
  "labels": [
    string
  ]
}
欄位
displayName

string

這是必要旗標，定義的詞彙術語好記顯示名稱。例如：「CTR」、「轉換率」、「待處理」
description

string

這是必要旗標，該詞彙的說明或意義。例如：「點擊率」、「完成理想動作的使用者百分比」、「等待處理的訂單」。
labels[]

string

(選用步驟) 與這個字詞相關聯的一般用途標籤清單。例如：["click rate", "clickthrough", "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

資料表結構定義中的路徑排序清單。

來源

產生結構定義關係邊緣的來源。

列舉
SOURCE_UNSPECIFIED 未指定結構定義關係的來源。
BIGQUERY_JOB_HISTORY 結構定義關係的來源是 BigQuery 工作記錄。
LLM_SUGGESTED 結構定義關係的來源是 LLM 建議。
BIGQUERY_TABLE_CONSTRAINTS 結構定義關係的來源是 BigQuery 資料表限制。

方法

create

 在指定專案和位置建立新的 DataAgent。

delete

 刪除單一 DataAgent。

get

 取得單一 DataAgent 的詳細資料。

getIamPolicy

 取得 DataAgent 的 IAM 政策

list

 列出指定專案和位置中的 DataAgent。

listAccessible

 列出指定專案和位置中，呼叫者可存取的 DataAgent。

patch

 更新單一 DataAgent 的參數。

setIamPolicy

 為 DataAgent 設定 IAM 政策。