Method: projects.locations.retrieveBigQueryTableContext

擷取所提供資料表參照的 BigQuery 資料表內容資料。情境資料包括表格結構定義資訊和範例值。

HTTP 要求

POST https://geminidataanalytics.googleapis.com/v1alpha/{parent=projects/*/locations/*}:retrieveBigQueryTableContext

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

這是必要旗標,RetrieveBigQueryTableContextRequest 的父項值。模式:projects/{project}/locations/{location}目前請使用「global」做為位置。日後將支援區域位置值。

要求主體

要求主體包含下列結構的資料:

JSON 表示法
{
  "project": string,
  "query": string,
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
欄位
project
(deprecated)

string

必填。

query

string

(選用步驟) 以自然語言提出的使用者查詢。

directLookup[]

object (DirectLookup)

(選用步驟) 直接查詢參數清單。

回應主體

透過直接查詢擷取 BigQuery 資料表內容資料的回應。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "tableCandidates": [
    {
      object (TableCandidate)
    }
  ]
}
欄位
candidates[]
(deprecated)

object (Candidate)

擷取的候選項目清單,以及其隨附的中繼資料。

tableCandidates[]

object (TableCandidate)

擷取的候選項目清單,以及其隨附的中繼資料。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱Authentication Overview

候選

擷取的候選人。

JSON 表示法
{
  "linkedResource": string,
  "content": string
}
欄位
linkedResource

string

候選人在來源系統中的完整資源名稱 (如適用)。舉例來說,如果是 BigQuery 資料表,格式為:bigquery.googleapis.com/projects/{projectId}/datasets/{datasetId}/tables/{tableId}

content

string

字串格式的內容。