Method: projects.locations.retrieveBigQueryTableContext

제공된 테이블 참조의 BigQuery 테이블 컨텍스트 데이터를 가져옵니다. 컨텍스트 데이터에는 테이블 스키마 정보와 샘플 값이 포함됩니다.

HTTP 요청

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

URL은 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

문자열 형식의 콘텐츠입니다.