REST Resource: projects.locations.dataAgents

資源：DataAgent

說明 DataAgent 物件的訊息。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": 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。代理程式的專屬資源名稱。格式：「projects/{project}/locations/{location}/dataAgents/{dataAgentId}」{dataAgent} 是資源 ID，長度應為 63 個字元以下，且必須符合 https://google.aip.dev/122#resource-id-segments 所述的格式

例如：「projects/1234567890/locations/us-central1/dataAgents/my-agent」
displayName

string

(選用步驟) 使用者容易閱讀的顯示名稱。

  • 長度必須介於 1 至 256 個半形字元之間。
description

string

(選用步驟) 代理程式的說明。

  • 長度必須介於 1 至 1024 個字元之間。
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"。
dataAnalyticsAgent

object (DataAnalyticsAgent)

資料分析代理程式。

DataAnalyticsAgent

說明 DataAnalyticsAgent 物件的訊息。

JSON 表示法 
{
  "stagingContext": {
    object (Context)
  },
  "publishedContext": {
    object (Context)
  }
}
欄位
stagingContext

object (Context)

(選用步驟) 代理程式的前置作業情境。這個上下文會在發布前測試及驗證變更。
publishedContext

object (Context)

(選用步驟) 代理程式的已發布情境。Chat API 會在實際執行環境中使用這個內容。

背景資訊

要套用至此對話的一系列情境

JSON 表示法 
{
  "systemInstruction": string,
  "datasourceReferences": {
    object (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  }
}
欄位
systemInstruction

string

(選用步驟) 資料擁有者為 Agent 建立領域知識時的基本入口。
datasourceReferences

object (DatasourceReferences)

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

object (ConversationOptions)

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

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
}
欄位
projectId

string

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

string

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

string

這是必要旗標，資料表 ID。

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 Explore 參照的訊息。

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 模型的名稱，請參閱「主要的 LookML 結構」一節。
explore

string

這是必要旗標，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 執行個體的服務目錄名稱。

結構定義

Datasource 或 QueryResult 例項的結構定義。

JSON 表示法 
{
  "fields": [
    {
      object (Field)
    }
  ]
}
欄位
fields[]

object (Field)

僅供輸出。結構定義中的欄位。

欄位

結構定義中的欄位。

JSON 表示法 
{
  "name": string,
  "type": string,
  "description": string,
  "mode": string,
  "displayName": string,
  "subfields": [
    {
      object (Field)
    }
  ]
}
欄位
name

string

僅供輸出。欄位的名稱。
type

string

僅供輸出。欄位的類型。
description

string

僅供輸出。欄位的簡短說明。
mode

string

僅供輸出。欄位模式 (例如NULLABLE、REPEATED)。
displayName

string

(選用步驟) 欄位顯示名稱 (與
subfields[]

object (Field)

(選用步驟) 巢狀結構定義的遞迴屬性。

憑證

代表不同形式的憑證規格。

JSON 表示法 
{

  // Union field kind can be only one of the following:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of list of possible types for union field 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 存取權杖，請參閱「Looker API 驗證」。

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。

方法

create

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

delete

 刪除單一 DataAgent。

get

 取得單一 DataAgent 的詳細資料。

list

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

patch

 更新單一 DataAgent 的參數。