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/us-central1/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)

出力専用。[出力専用] データ エージェントが削除（復元可能）された時刻。

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)

データ分析エージェント。

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)
    }
  ]
}
フィールド
systemInstruction

string

省略可。エージェントのドメインの知識を作成するデータオーナーの基本的なエントリ ポイント。

理由: ビジネス用語（例: YTD 収益は…として計算され、米国の定年は 65 歳です）とシステム指示（例: 海賊のように答えてください）は、モデルがユーザーの質問に関するビジネス コンテキストを理解するために役立ちます。
datasourceReferences

object (DatasourceReferences)

必須。質問に回答するために使用できるデータソース。
options

object (ConversationOptions)

省略可。会話のその他のオプション。
exampleQueries[]

object (ExampleQuery)

省略可。関連性の高い一般的な SQL クエリの例と、対応する自然言語クエリの例（省略可）を示すクエリの例のリスト。現在、BigQuery データソースでのみ使用されます。

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.
}
Fields
共用体フィールド references。使用するデータソース。references は次のいずれかになります。
bq

object (BigQueryTableReferences)

BigQuery テーブルへの参照。
studio

object (StudioDatasourceReferences)

Looker Studio データソースへの参照。
looker

object (LookerExploreReferences)

Looker Explore への参照。

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

省略可。テーブルのコンテンツと目的の説明テキスト。例: 「このデータセットには、当社の e コマース ストアのお客様の注文に関する情報が含まれています。」現在、BigQuery データソースでのみ使用されます。
synonyms[]

string

省略可。テーブルを参照するために使用できる代替名または同義語のリスト。例: ["sales", "orders", "purchases"]。現在、BigQuery データソースでのみ使用されます。
tags[]

string

省略可。分類に使用される、テーブルに関連付けられたタグまたはキーワードのリスト。例: ["transaction", "revenue", "customer_data"]。現在、BigQuery データソースでのみ使用されます。
displayName

string

省略可。テーブルの displayName（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

省略可。フィールドの displayName（次のラベルと同じ
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

省略可。クエリでフィルタがオーバーライドされていない場合に使用される、このフィルタのデフォルト値。例: ["2024-01-01 以降", "123", "-ファッション"]
type

enum (DataFilterType)

省略可。データソースに存在するフィルタのタイプ（ALWAYS_FILTER など）。

DataFilterType

データソースに存在するフィルタのタイプ（ALWAYS_FILTER など）。

列挙型
DATA_FILTER_TYPE_UNSPECIFIED フィルタタイプが指定されていません。
ALWAYS_FILTER ユーザーが構成するフィルタ。Explore へのクエリでは、デフォルトで常にこのフィルタが適用されます。現在は Looker データソースでのみ使用されます。

StudioDatasourceReferences

Looker Studio データソースへの参照を表すメッセージ。

JSON 表現 
{
  "studioReferences": [
    {
      object (StudioDatasourceReference)
    }
  ]
}
Fields
studioReferences[]

object (StudioDatasourceReference)

Studio データソースへの参照。

StudioDatasourceReference

単一の Looker Studio データソースへの参照を表すメッセージ。

JSON 表現 
{
  "datasourceId": string
}
フィールド
datasourceId

string

必須。データソースの ID。

LookerExploreReferences

Looker Explore への参照を表すメッセージ。

JSON 表現 
{
  "exploreReferences": [
    {
      object (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
フィールド
exploreReferences[]

object (LookerExploreReference)

必須。Looker Explore への参照。
credentials

object (Credentials)

省略可。Looker API を呼び出すときに使用する認証情報。

現在、SDK を使用した認証に記載されているように、OAuth トークンと API キーベースの認証情報の両方がサポートされています。

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 構造体で説明されている Looker モデル。LookML モデルの名前。
explore

string

必須。主な LookML 構造体で説明されている Looker Explore。LookML Explore の名前。
schema

object (Schema)

省略可。データソースのスキーマ。
共用体フィールド instance。Looker Explore のインスタンス。instance は次のいずれかになります。
lookerInstanceUri

string

必須。Looker インスタンスのベース URL。
privateLookerInstanceInfo

object (PrivateLookerInstanceInfo)

プライベート Looker インスタンス情報。

PrivateLookerInstanceInfo

Looker インスタンスがプライベート ネットワークの背後にある場合に必要なプライベート Looker インスタンス情報を表すメッセージ。

JSON 表現 
{
  "lookerInstanceId": string,
  "serviceDirectoryName": string
}
Fields
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.
}
Fields
共用体フィールド 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.
}
Fields
共用体フィールド kind。OAuth 認証情報の種類。kind は次のいずれかになります。
secret

object (SecretBased)

Secret ベースの OAuth 認証情報。
token

object (TokenBased)

トークンベースの OAuth 認証情報。

SecretBased

アクセス トークンを含む Secret の名前。Secret ベースの 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

必須。アクセス トークンを含む Secret の名前。

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.
}
Fields
共用体フィールド 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'」

メソッド

create

 指定されたプロジェクトとロケーションに新しい DataAgent を作成します。

delete

 単一の DataAgent を削除します。

get

 単一の DataAgent の詳細を取得します。

getIamPolicy

 DataAgent の IAM ポリシーを取得する

list

 指定されたプロジェクトとロケーションにある DataAgents のリストを取得します。

listAccessible

 指定されたプロジェクトとロケーションで呼び出し元がアクセスできる DataAgent を一覧表示します。

patch

 単一の DataAgent のパラメータを更新します。

setIamPolicy

 DataAgent の IAM ポリシーを設定します。