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

선택사항. 식별자. 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~1,024자(영문 기준) 사이여야 합니다.
labels

map (key: string, value: string)

선택사항. 사용자가 관련 에이전트를 필터링하는 데 도움이 되는 라벨입니다. 예를 들어 'sales', 'business', 'etl' 등이 있습니다. 라벨은 필터링에만 사용되며 정책에는 사용되지 않습니다. 라벨 사용에 대한 자세한 내용은 라벨 문서를 참고하세요.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
createTime

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"입니다.
updateTime

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"입니다.
deleteTime

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"입니다.
purgeTime

string (Timestamp format)

출력 전용입니다. 이 데이터 에이전트가 만료된 것으로 간주되는 시간의 타임스탬프(UTC)입니다. 이 필드는 입력으로 전송된 항목에 관계없이 출력으로 항상 제공됩니다.

생성된 출력은 항상 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"입니다.
통합 필드 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.
}
필드
통합 필드 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

선택사항입니다. 표의 콘텐츠와 목적에 대한 텍스트 설명입니다. 예: '전자상거래 스토어의 고객 주문에 관한 정보가 포함되어 있습니다.' 현재 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)
    }
  ]
}
필드
studioReferences[]

object (StudioDatasourceReference)

스튜디오 데이터 소스에 대한 참조입니다.

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
}
필드
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.
}
필드
통합 필드 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.
}
필드
통합 필드 kind. OAuth 사용자 인증 정보의 종류입니다. kind은 다음 중 하나여야 합니다.
secret

object (SecretBased)

보안 비밀 기반 OAuth 사용자 인증 정보입니다.
token

object (TokenBased)

토큰 기반 OAuth 사용자 인증 정보입니다.

SecretBased

액세스 토큰이 포함된 보안 비밀의 이름입니다. 보안 비밀 기반 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

필수 항목. 액세스 토큰이 포함된 보안 비밀의 이름입니다.

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.
}
필드
통합 필드 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

 특정 프로젝트 및 위치에서 호출자가 액세스할 수 있는 DataAgents를 나열합니다.

patch

 단일 DataAgent 파라미터를 업데이트합니다.

setIamPolicy

 DataAgent의 IAM 정책을 설정합니다.