Method: projects.locations.chat

Message オブジェクトのストリームを生成して、データに関する質問に回答します。

HTTP リクエスト

POST https://geminidataanalytics.googleapis.com/v1beta/{parent=projects/*/locations/*}:chat

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。チャット リクエストの親の値。パターン: projects/{project}/locations/{location}

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "project": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "credentials": {
    object (Credentials)
  },
  "thinkingMode": enum (ThinkingMode),
  "model": enum (Model),

  // Union field context_provider can be only one of the following:
  "inlineContext": {
    object (Context)
  },
  "conversationReference": {
    object (ConversationReference)
  },
  "dataAgentContext": {
    object (DataAgentContext)
  },
  "clientManagedResourceContext": {
    object (ClientManagedResourceContext)
  }
  // End of list of possible types for union field context_provider.

  // Union field datasource_settings can be only one of the following:
  "lookerSettings": {
    object (LookerSettings)
  }
  // End of list of possible types for union field datasource_settings.
}
フィールド
project
(deprecated)

string

省略可。非推奨: 代わりに、parent フィールドを使用してください。割り当てと課金に使用する Google Cloud プロジェクト。
messages[]

object (Message)

必須。現在の会話の内容。
credentials

object (Credentials)

省略可。コンテキストで指定されたデータソースを呼び出すときに使用する認証情報。

このフィールドを使用して、さまざまなデータソースの認証情報を提供できます。たとえば、Looker に接続する場合、現在、SDK を使用した認証に記載されているように、OAuth トークンと API キーベースの認証情報の両方がサポートされています。
thinkingMode

enum (ThinkingMode)

省略可。エージェント ループに使用する思考モード。指定しない場合は、デフォルトで THINKING_MODE_UNSPECIFIED になります。
model

enum (Model)

省略可。リクエストの処理時にエージェント ループに使用するモデル。この設定は、context.options.model が設定されていない場合にのみ有効です。
共用体フィールド context_provider。チャット リクエストのコンテキスト プロバイダ。inline_context（リクエストでインラインで提供されるコンテキスト）、data_agent（データ エージェント リソースへの参照）、conversation_reference（conversation_id と agent_id を使用して永続化された会話とコンテキストへの参照）のいずれかになります。context_provider は次のいずれかになります。
inlineContext

object (Context)

省略可。チャット リクエストのインライン コンテキスト。すべてのコンテキストをインラインで渡すことで、ステートレス（会話の永続性の管理やエージェントがない）でチャットするために使用します。
conversationReference

object (ConversationReference)

省略可。永続化された会話とエージェント コンテキストへの参照。これは、管理された会話の永続性を使用してエージェントとチャットするために使用します。
dataAgentContext

object (DataAgentContext)

省略可。チャット リクエストのコンテキスト。これを使用して、会話の永続性を管理せずに、ステートレスでエージェントとチャットします。
clientManagedResourceContext

object (ClientManagedResourceContext)

省略可。クライアント管理リソースを含むコンテキスト。一部のクライアントは、会話やエージェントなどの GDA マネージド リソースを使用せず、独自の会話やエージェントのリソースを作成して管理する場合があります。
共用体フィールド datasource_settings。ターゲット データソースに固有のリクエスト動作をカスタマイズする省略可能な設定。datasource_settings は次のいずれかになります。
lookerSettings

object (LookerSettings)

省略可。Looker 固有の設定。

レスポンスの本文

成功した場合、レスポンスの本文には Message インスタンスのストリームが含まれます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

ConversationReference

永続化された会話とエージェント コンテキストへの参照。

JSON 表現 
{
  "conversation": string,
  "dataAgentContext": {
    object (DataAgentContext)
  }
}
フィールド
conversation

string

必須。会話リソースの名前。形式: projects/{project}/locations/{location}/conversations/{conversationId}
dataAgentContext

object (DataAgentContext)

必須。データ エージェントを使用したチャット リクエストのコンテキスト。

DataAgentContext

データ エージェントを使用したチャット リクエストのコンテキスト。

JSON 表現 
{
  "dataAgent": string,
  "credentials": {
    object (Credentials)
  },
  "contextVersion": enum (ContextVersion)
}
フィールド
dataAgent

string

必須。データ エージェント リソースの名前。
credentials
(deprecated)

object (Credentials)

省略可。非推奨: ChatRequest で認証情報を使用してください。Looker データソースを呼び出すときに使用する認証情報

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

enum (ContextVersion)

省略可。DCS で使用されるコンテキストのバージョン（STAGING、PUBLISHED など）

ContextVersion

DCS でサポートされているコンテキスト バージョンの一覧。コンテキストには 2 つのバージョンがあります。これは、データ エージェントのバージョン管理を維持するためです。

列挙型
CONTEXT_VERSION_UNSPECIFIED 指定されていないか、認識されていません。
STAGING このバージョンを使用すると、DCS はデータ エージェントに最新のステージング コンテキストを使用します。
PUBLISHED このバージョンを使用すると、DCS はデータ エージェントに公開された最新のコンテキストを使用します。

ClientManagedResourceContext

クライアント管理リソースを含むコンテキスト。一部のクライアントは、会話やエージェントなどの GDA マネージド リソースを使用せず、独自の会話やエージェントのリソースを作成して管理する場合があります。

JSON 表現 
{
  "inlineContext": {
    object (Context)
  },
  "conversationId": string,
  "agentId": string
}
フィールド
inlineContext

object (Context)

必須。チャット リクエストのコンテキスト。すべてのコンテキストをインラインで渡すことで、GDA API の管理対象の会話とエージェントの永続性なしでチャットするために使用します。
conversationId

string

省略可。クライアント管理の会話 ID。
agentId

string

省略可。クライアント管理のエージェント ID。

LookerSettings

Looker 固有のカスタム設定を保持するメッセージ。

JSON 表現 
{
  "enableDevMode": boolean
}
フィールド
enableDevMode

boolean

省略可。Looker の開発モードで動作するかどうか。true の場合、API セッションは「dev」ワークスペースに切り替えられ、ユーザーの開発ブランチで LookML の変更を操作できます。false または未設定の場合、セッションはデフォルトの状態（本番環境モード）のままになります。https://cloud.google.com/looker/docs/dev-mode-prod-mode をご覧ください。

ThinkingMode

エージェントの思考モード。

列挙型
THINKING_MODE_UNSPECIFIED 思考モードが指定されていません。BigQuery ユーザーはデフォルトで FAST モードになりますが、エージェントはデフォルトで THINKING モードを使用します。
FAST 高速モード。迅速に回答します。
THINKING 思考モード。複雑な問題を解決します。

モデル

BigQuery ユーザーのエージェントのモデル選択。

列挙型
MODEL_UNSPECIFIED モデルが指定されていません。プレビュー モデルまたはプレビュー以外のモデルを使用できます。
LATEST_GA_MODEL 最新のプレビュー以外のモデルを使用します。これにより、特定のリクエスト レベルの設定が制約される可能性があります。