Message

사용자와 시스템 간의 상호작용에서 발생한 메시지입니다.

JSON 표현 
{
  "timestamp": string,
  "messageId": string,

  // Union field kind can be only one of the following:
  "userMessage": {
    object (UserMessage)
  },
  "systemMessage": {
    object (SystemMessage)
  }
  // End of list of possible types for union field kind.
}
필드
timestamp

string (Timestamp format)

출력 전용입니다. 사용자 메시지의 경우 시스템에서 메시지를 수신한 시간입니다. 시스템 메시지의 경우 시스템에서 메시지를 생성한 시간입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
messageId

string

(선택사항) 지속성을 위해 대화에 있는 메시지의 고유 ID입니다.
통합 필드 kind. 메시지 종류입니다. kind은 다음 중 하나여야 합니다.
userMessage

object (UserMessage)

시스템과 상호작용하는 사용자의 메시지입니다.
systemMessage

object (SystemMessage)

사용자에 대한 시스템의 응답 메시지입니다.

UserMessage

시스템과 상호작용하는 사용자의 메시지입니다.

JSON 표현 
{

  // Union field kind can be only one of the following:
  "text": string
  // End of list of possible types for union field kind.
}
필드
통합 필드 kind. 사용자 메시지의 콘텐츠 종류입니다. kind은 다음 중 하나여야 합니다.
text

string

텍스트에서 blob 대신 이 필드를 사용해야 합니다.

SystemMessage

사용자에 대한 시스템의 응답 메시지입니다. 이 메시지는 시스템과의 멀티턴 대화 기록 컨텍스트로서 사용자의 메시지일 수도 있습니다.

JSON 표현 
{

  // Union field kind can be only one of the following:
  "text": {
    object (TextMessage)
  },
  "schema": {
    object (SchemaMessage)
  },
  "data": {
    object (DataMessage)
  },
  "analysis": {
    object (AnalysisMessage)
  },
  "chart": {
    object (ChartMessage)
  },
  "error": {
    object (ErrorMessage)
  },
  "exampleQueries": {
    object (ExampleQueries)
  }
  // End of list of possible types for union field kind.
  "groupId": integer
}
필드
통합 필드 kind. 시스템 메시지의 콘텐츠 종류입니다. kind은 다음 중 하나여야 합니다.
text

object (TextMessage)

사용자 메시지에 대한 직접적인 자연어 대답입니다.
schema

object (SchemaMessage)

스키마 확인 중에 생성된 메시지입니다.
data

object (DataMessage)

데이터 검색 중에 생성된 메시지입니다.
analysis

object (AnalysisMessage)

분석 중에 생성된 메시지입니다.
chart

object (ChartMessage)

차트 생성 중에 생성된 메시지입니다.
error

object (ErrorMessage)

오류 메시지입니다.
exampleQueries

object (ExampleQueries)

(선택사항) 예시 질문이 포함된 메시지
groupId

integer

이벤트가 속한 그룹을 식별합니다. 유사한 이벤트는 서로 논리적으로 관련되어 있다고 간주되며 UI에 함께 표시되어야 합니다.

TextMessage

여러 부분으로 구성된 문자 메시지입니다.

JSON 표현 
{
  "parts": [
    string
  ],
  "textType": enum (TextType)
}
필드
parts[]

string

선택사항. 메시지의 부분입니다.
textType

enum (TextType)

(선택사항) 문자 메시지 유형입니다.

TextType

문자 메시지 유형입니다.

열거형
TEXT_TYPE_UNSPECIFIED 기본 텍스트 유형입니다.
FINAL_RESPONSE 텍스트는 사용자 질문에 대한 최종 응답입니다.
THOUGHT 텍스트는 사고 도구에서 생성된 사고 계획입니다.

SchemaMessage

스키마 확인 중에 생성된 메시지입니다.

JSON 표현 
{

  // Union field kind can be only one of the following:
  "query": {
    object (SchemaQuery)
  },
  "result": {
    object (SchemaResult)
  }
  // End of list of possible types for union field kind.
}
필드
통합 필드 kind. 이 메시지에 쿼리 또는 스키마 확인 결과가 포함되어 있는지 여부입니다. kind은 다음 중 하나여야 합니다.
query

object (SchemaQuery)

스키마 확인 쿼리입니다.
result

object (SchemaResult)

스키마 확인 쿼리 결과입니다.

SchemaQuery

제기된 질문과 관련된 스키마를 확인하는 쿼리입니다.

JSON 표현 
{
  "question": string
}
필드
question

string

선택사항. 스키마 확인을 위해 시스템에 전송할 질문입니다.

SchemaResult

스키마 확인 결과입니다.

JSON 표현 
{
  "datasources": [
    {
      object (Datasource)
    }
  ]
}
필드
datasources[]

object (Datasource)

선택사항. 스키마 쿼리를 확인하는 데 사용된 데이터 소스입니다.

데이터 소스

질문에 답변하는 데 사용할 수 있는 데이터 소스입니다.

JSON 표현 
{
  "schema": {
    object (Schema)
  },

  // Union field reference can be only one of the following:
  "bigqueryTableReference": {
    object (BigQueryTableReference)
  },
  "studioDatasourceId": string,
  "lookerExploreReference": {
    object (LookerExploreReference)
  }
  // End of list of possible types for union field reference.
}
필드
schema

object (Schema)

선택사항. 데이터 소스의 스키마입니다.
통합 필드 reference. 데이터 소스에 대한 참조입니다. reference은 다음 중 하나여야 합니다.
bigqueryTableReference

object (BigQueryTableReference)

BigQuery 테이블에 대한 참조입니다.
studioDatasourceId

string

Looker Studio 데이터 소스에 대한 참조입니다.
lookerExploreReference

object (LookerExploreReference)

Looker Explore에 대한 참조입니다.

DataMessage

데이터 검색 중에 생성된 메시지입니다.

JSON 표현 
{

  // Union field kind can be only one of the following:
  "query": {
    object (DataQuery)
  },
  "generatedSql": string,
  "result": {
    object (DataResult)
  },
  "generatedLookerQuery": {
    object (LookerQuery)
  },
  "bigQueryJob": {
    object (BigQueryJob)
  }
  // End of list of possible types for union field kind.
}
필드
통합 필드 kind. 이 메시지에 데이터 검색에 사용할 수 있는 쿼리, 결과 또는 생성된 SQL이 포함되어 있는지 여부입니다. kind은 다음 중 하나여야 합니다.
query

object (DataQuery)

데이터 검색 쿼리입니다.
generatedSql

string

데이터를 검색하기 위해 시스템에서 생성한 SQL입니다.
result

object (DataResult)

검색된 데이터입니다.
generatedLookerQuery
(deprecated)

object (LookerQuery)

데이터를 검색하기 위해 시스템에서 생성한 Looker 쿼리입니다. 지원 중단됨: 생성된 Looker 쿼리가 이제 DataQuery.looker에 있습니다.
bigQueryJob

object (BigQueryJob)

데이터를 검색하기 위해 시스템에서 실행한 BigQuery 작업입니다.

DataQuery

데이터를 검색하기 위한 쿼리입니다.

JSON 표현 
{
  "question": string,
  "name": string,
  "datasources": [
    {
      object (Datasource)
    }
  ],

  // Union field query_type can be only one of the following:
  "looker": {
    object (LookerQuery)
  }
  // End of list of possible types for union field query_type.
}
필드
question

string

선택사항. 답변할 자연어 질문입니다.
name

string

선택사항. 인텐트를 반영하는 쿼리의 스네이크 표기법 이름입니다. 이후 단계에서 참조할 수 있도록 해당 데이터 결과를 명명하는 데 사용됩니다.

  • 예: 'total_sales_by_product'
  • 예: 'sales_for_product_12345'
datasources[]

object (Datasource)

선택사항. 질문에 답변하는 데 사용할 수 있는 데이터 소스입니다.
통합 필드 query_type. 실행할 쿼리 유형입니다. query_type은 다음 중 하나여야 합니다.
looker

object (LookerQuery)

(선택사항) Looker Explore에서 데이터를 검색하는 쿼리입니다.

LookerQuery

Looker Explore에서 데이터를 검색하는 쿼리입니다. 인라인 쿼리 실행을 참조하세요.

JSON 표현 
{
  "model": string,
  "explore": string,
  "fields": [
    string
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "sorts": [
    string
  ],
  "limit": string
}
필드
model

string

필수 항목. 쿼리를 생성하는 데 사용된 LookML 모델입니다.
explore

string

필수 항목. 쿼리를 생성하는 데 사용된 LookML Explore입니다.
fields[]

string

선택사항. Explore에서 검색할 필드입니다.
filters[]

object (Filter)

선택사항. Explore에 적용할 필터입니다.
sorts[]

string

선택사항. Explore에 적용할 정렬입니다.
limit

string

선택사항. 쿼리의 한도입니다.

필터

Looker 쿼리 필터입니다.

JSON 표현 
{
  "field": string,
  "value": string
}
필드
field

string

필수 항목. 필터링할 필드입니다.
value

string

필수 항목. 필터링할 값 f 필드입니다.

DataResult

검색된 데이터입니다.

JSON 표현 
{
  "name": string,
  "schema": {
    object (Schema)
  },
  "data": [
    {
      object
    }
  ]
}
필드
name

string

선택사항. 콘텐츠를 반영하는 데이터 결과의 스네이크 표기법 이름입니다. 이름은 참조로 결과를 전달하는 데 사용되며 의미에 대한 신호 역할을 합니다.

  • 예: 'total_sales_by_product'
  • 예: 'sales_for_product_12345'
schema

object (Schema)

선택사항. 데이터 스키마입니다.
data[]

object (Struct format)

선택사항. 데이터 콘텐츠입니다. 각 행은 스키마와 일치하는 구조체입니다. 단순 값은 문자열로 표시되고 중첩된 구조는 목록이나 구조체로 표시됩니다.

BigQueryJob

시스템에서 실행한 BigQuery 작업입니다.

JSON 표현 
{
  "projectId": string,
  "jobId": string,
  "location": string,
  "destinationTable": {
    object (BigQueryTableReference)
  },
  "schema": {
    object (Schema)
  }
}
필드
projectId

string

필수 항목. 작업이 포함된 프로젝트입니다.

JobReference를 참조하세요.
jobId

string

필수 항목. 작업의 ID입니다.

JobReference를 참조하세요.
location

string

선택사항. 작업의 위치입니다.

JobReference를 참조하세요.
destinationTable

object (BigQueryTableReference)

선택사항. 작업 쿼리 결과 대상 테이블에 대한 참조입니다.

JobConfigurationQuery를 참조하세요.
schema

object (Schema)

선택사항. 작업 쿼리 결과 스키마입니다.

JobStatistics2를 참조하세요.

AnalysisMessage

분석 중에 생성된 메시지입니다.

JSON 표현 
{

  // Union field kind can be only one of the following:
  "query": {
    object (AnalysisQuery)
  },
  "progressEvent": {
    object (AnalysisEvent)
  }
  // End of list of possible types for union field kind.
}
필드
통합 필드 kind. 이 메시지에 분석의 쿼리 또는 이벤트 중 하나가 포함되어 있는지 여부입니다. kind은 다음 중 하나여야 합니다.
query

object (AnalysisQuery)

분석 쿼리입니다.
progressEvent

object (AnalysisEvent)

분석 진행 상황을 나타내는 이벤트입니다.

AnalysisQuery

분석을 실행하기 위한 쿼리입니다.

JSON 표현 
{
  "question": string,
  "dataResultNames": [
    string
  ]
}
필드
question

string

선택사항. 사용자의 원래 질문에 답변하는 데 도움이 되는 분석 질문입니다.
dataResultNames[]

string

선택사항. 분석하기 위해 이전에 검색한 데이터 결과의 이름입니다.

AnalysisEvent

분석 진행 상황을 나타내는 이벤트입니다.

JSON 표현 
{

  // Union field kind can be only one of the following:
  "plannerReasoning": string,
  "coderInstruction": string,
  "code": string,
  "executionOutput": string,
  "executionError": string,
  "resultVegaChartJson": string,
  "resultNaturalLanguage": string,
  "resultCsvData": string,
  "resultReferenceData": string,
  "error": string
  // End of list of possible types for union field kind.
}
필드
통합 필드 kind. 분석 중에 발생한 이벤트의 종류입니다. kind은 다음 중 하나여야 합니다.
plannerReasoning

string

Python codegen planner 추론입니다.
coderInstruction

string

코드 생성을 위해 발급된 요청 사항입니다.
code

string

생성된 코드
executionOutput

string

코드 실행의 출력입니다.
executionError

string

코드 실행에서 발생한 오류입니다.
resultVegaChartJson

string

결과를 Vega 차트 JSON 문자열로 반환합니다.
resultNaturalLanguage

string

결과를 NL 문자열로 반환합니다.
resultCsvData

string

결과를 CSV 문자열로 반환합니다.
resultReferenceData

string

결과를 데이터 소스에 대한 참조로 반환합니다.
error

string

일반적인 오류 메시지입니다.

ChartMessage

차트 생성 중에 생성된 메시지입니다.

JSON 표현 
{

  // Union field kind can be only one of the following:
  "query": {
    object (ChartQuery)
  },
  "result": {
    object (ChartResult)
  }
  // End of list of possible types for union field kind.
}
필드
통합 필드 kind. 이 메시지에 쿼리 또는 차트 생성 결과가 포함되어 있는지 여부입니다. kind은 다음 중 하나여야 합니다.
query

object (ChartQuery)

차트를 생성하기 위한 쿼리입니다.
result

object (ChartResult)

차트 생성 쿼리 결과입니다.

ChartQuery

차트를 생성하기 위한 쿼리입니다.

JSON 표현 
{
  "instructions": string,
  "dataResultName": string
}
필드
instructions

string

선택사항. 차트 생성을 위한 자연어 안내입니다.
dataResultName

string

선택사항. 차트에서 사용하기 위해 이전에 검색한 데이터 결과의 이름입니다.

ChartResult

차트 생성 쿼리 결과입니다.

JSON 표현 
{
  "vegaConfig": {
    object
  },
  "image": {
    object (Blob)
  }
}
필드
vegaConfig

object (Struct format)

선택사항. 생성된 Vega 차트 구성입니다. https://vega.github.io/vega/docs/config/를 참조하세요.
image

object (Blob)

선택사항. 컨텍스트에서 요청된 경우 차트의 렌더링입니다.

blob

MIME 유형이 있는 데이터 blob입니다.

JSON 표현 
{
  "mimeType": string,
  "data": string
}
필드
mimeType

string

필수 항목. 메시지 데이터의 IANA 표준 MIME 유형입니다.
data

string (bytes format)

필수 항목. 바이트로 표현된 데이터입니다.

base64 인코딩 문자열입니다.

ErrorMessage

오류 메시지입니다.

JSON 표현 
{
  "text": string
}
필드
text

string

출력 전용입니다. 오류 텍스트입니다.

ExampleQueries

파생된 예시 쿼리와 작성된 예시 쿼리가 포함된 메시지입니다.

JSON 표현 
{
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
필드
exampleQueries[]

object (ExampleQuery)

(선택사항) 관련되고 일반적으로 사용되는 SQL 쿼리와 선택적으로 표시되는 해당 자연어 쿼리의 예를 제공하는 파생 및 작성된 예시 쿼리 목록입니다. 현재 BigQuery 데이터 소스에만 사용됩니다.