- Recurso: DataAgent
- DataAnalyticsAgent
- Context
- DatasourceReferences
- BigQueryTableReferences
- BigQueryTableReference
- Schema
- Field
- DataFilter
- DataFilterType
- StudioDatasourceReferences
- StudioDatasourceReference
- LookerExploreReferences
- LookerExploreReference
- PrivateLookerInstanceInfo
- ConversationOptions
- AnalysisOptions
- Python
- DatasourceOptions
- Modelo
- ExampleQuery
- QueryParameter
- LookerGoldenQuery
- LookerQuery
- Filter
- GlossaryTerm
- SchemaRelationship
- SchemaPaths
- Origem
- UserFunctions
- BigQueryRoutine
- BigQueryRoutineReference
- Métodos
Recurso: DataAgent
Mensagem descrevendo um objeto DataAgent.
| Representação JSON |
|---|
{ "name": string, "displayName": string, "description": string, "labels": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "purgeTime": string, // Union field |
| Campos | |
|---|---|
name |
Opcional. Identificador. O nome de recurso único de um DataAgent. Formato: Exemplo: Recomendamos pular a definição desse campo durante a criação do agente, porque ele será inferido automaticamente e substituído por {parent}/dataAgents/{dataAgentId}. |
displayName |
Opcional. É um nome de exibição fácil de usar.
|
description |
Opcional. É a descrição do agente.
|
labels |
Opcional. São rótulos para ajudar os usuários a filtrar agentes relacionados. Por exemplo, "vendas", "negócios", "ETL" e assim por diante. Os rótulos de observações são usados apenas para filtragem, não para políticas. Consulte a documentação sobre rótulos para mais detalhes sobre o uso deles. Um objeto com uma lista de pares de |
createTime |
Apenas de saída. O horário em que o agente de dados foi criado. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: |
updateTime |
Apenas de saída. O horário em que o agente de dados foi atualizado pela última vez. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: |
deleteTime |
Apenas de saída. O horário em que foi feita a exclusão reversível do agente de dados. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: |
purgeTime |
Apenas de saída. Carimbo de data/hora (em UTC) de quando o agente de dados será considerado expirado. Isso é sempre fornecido na saída, independente do que foi enviado na entrada. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: |
Campo de união type. É o tipo do agente. Pode ser uma destas opções: * Agente de análise de dados. * Agente de engenheiro de dados. type só pode ser: |
|
dataAnalyticsAgent |
É o agente de análise de dados. |
kmsKey |
Opcional. Chave de criptografia gerenciada pelo cliente (CMEK) a ser usada para criptografar os recursos do DataAgent. As CryptoKeys do Cloud KMS precisam estar no mesmo local que o DataAgent. O formato esperado é |
DataAnalyticsAgent
Mensagem que descreve um objeto DataAnalyticsAgent.
| Representação JSON |
|---|
{ "stagingContext": { object ( |
| Campos | |
|---|---|
stagingContext |
Opcional. É o contexto da fase de testes do agente, usado para verificar e validar as mudanças antes da publicação. |
publishedContext |
Opcional. É o contexto publicado do agente, usado pela API Chat em produção. |
lastPublishedContext |
Apenas de saída. É o último contexto publicado do agente. Trata-se de um campo apenas de saída preenchido pelo sistema quando o contexto publicado é atualizado. Ele é usado para restaurar o agente a um estado anterior. |
Context
É uma coleção de contexto para aplicar à conversa atual.
| Representação JSON |
|---|
{ "systemInstruction": string, "datasourceReferences": { object ( |
| Campos | |
|---|---|
systemInstruction |
Opcional. O ponto básico de entrada para proprietários de dados que criam conhecimento de domínio para o agente. Motivo: jargão de negócios (por exemplo, "A receita YTD é calculada como…", "A idade de aposentadoria é de 65 anos nos EUA" etc.) e instruções do sistema (por exemplo, "Responda como um pirata") ajudam o modelo a entender o contexto comercial de uma pergunta do usuário. |
datasourceReferences |
Obrigatório. Fontes de dados disponíveis para responder à pergunta. |
options |
Opcional. Outras opções para a conversa. |
exampleQueries[] |
Opcional. Uma lista de exemplos de consultas, com exemplos de consultas SQL relevantes e usadas com frequência e as consultas correspondentes em linguagem natural, se disponíveis. No momento, usado apenas para fontes de dados e bancos de dados do BigQuery (alloydb, cloudsql, spanner). |
lookerGoldenQueries[] |
Opcional. Uma lista de consultas de ouro, com exemplos de consultas do Looker relevantes e usadas com frequência e as consultas correspondentes em linguagem natural, se disponíveis. Disponível apenas para fontes de dados do Looker. |
glossaryTerms[] |
Opcional. Definições de termos (no momento, apenas criadas pelo usuário). Indisponível para fontes de dados de bancos de dados (alloydb, cloudsql, spanner). |
schemaRelationships[] |
Opcional. Relações entre o esquema da tabela, incluindo colunas de referência e referenciadas. |
userFunctions |
Opcional. Uma coleção de funções do usuário a serem incluídas no contexto. |
DatasourceReferences
Uma coleção de referências a fontes de dados.
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união references. As fontes de dados que serão usadas. references só pode ser uma destas opções: |
|
bq |
São referências a tabelas do BigQuery. |
studio |
São referências a fontes de dados do Looker Studio. |
looker |
São referências às Análises do Looker. |
BigQueryTableReferences
Mensagem que representa referências a tabelas do BigQuery e gráficos de propriedades. Pelo menos um entre tableReferences, propertyGraphReferences ou searchScope precisa ser preenchido.
| Representação JSON |
|---|
{
"tableReferences": [
{
object ( |
| Campos | |
|---|---|
tableReferences[] |
Opcional. São referências a tabelas do BigQuery. |
BigQueryTableReference
Mensagem que representa uma referência a uma única tabela do BigQuery.
| Representação JSON |
|---|
{
"projectId": string,
"datasetId": string,
"tableId": string,
"schema": {
object ( |
| Campos | |
|---|---|
projectId |
Obrigatório. É o projeto ao qual a tabela pertence. |
datasetId |
Obrigatório. É o conjunto de dados ao qual a tabela pertence. |
tableId |
Obrigatório. É o ID da tabela. |
schema |
Opcional. É o esquema da fonte de dados. |
Esquema
É o esquema de uma instância de Datasource ou QueryResult.
| Representação JSON |
|---|
{ "fields": [ { object ( |
| Campos | |
|---|---|
fields[] |
Opcional. São os campos no esquema. |
description |
Opcional. Uma descrição textual do conteúdo e da finalidade da tabela. Por exemplo: "Contém informações sobre pedidos de clientes na nossa loja de e-commerce". No momento, usado apenas para fontes de dados do BigQuery. |
synonyms[] |
Opcional. Uma lista de nomes alternativos ou sinônimos que podem ser usados para se referir à tabela. Por exemplo: ["sales", "orders", "purchases"]. No momento, usado apenas para fontes de dados do BigQuery. |
tags[] |
Opcional. Uma lista de tags ou palavras-chave associadas à tabela, usada para categorização. Por exemplo: ["transaction", "revenue", "customer_data"]. No momento, usado apenas para fontes de dados do BigQuery. |
displayName |
Opcional. É o displayName da tabela (cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), e somente o Looker tem esse campo. |
filters[] |
Opcional. Os filtros nos dados subjacentes da fonte de dados. No momento, usado apenas para fontes de dados do Looker. |
Campo
É um campo em um esquema.
| Representação JSON |
|---|
{
"name": string,
"type": string,
"description": string,
"mode": string,
"synonyms": [
string
],
"tags": [
string
],
"displayName": string,
"subfields": [
{
object ( |
| Campos | |
|---|---|
name |
Opcional. É o nome do campo. |
type |
Opcional. É o tipo do campo. |
description |
Opcional. É uma breve descrição do campo. |
mode |
Opcional. O modo do campo (por exemplo, NULLABLE, REPEATED). |
synonyms[] |
Opcional. Uma lista de nomes alternativos ou sinônimos que podem ser usados para se referir a este campo. Por exemplo: ["id", "customerid", "cust_id"]. No momento, usado apenas para fontes de dados do BigQuery. |
tags[] |
Opcional. Uma lista de tags ou palavras-chave associadas ao campo, usadas para categorização. Por exemplo: ["identifier", "customer", "pii"]. No momento, usado apenas para fontes de dados do BigQuery. |
displayName |
Opcional. É o displayName do campo (igual ao rótulo em |
subfields[] |
Opcional. É uma propriedade recursiva para estruturas aninhadas de esquemas. |
category |
Opcional. É a categoria do campo, sendo útil apenas para o Looker por enquanto. |
valueFormat |
Opcional. Somente Looker. Formato do valor do campo. Ref.: https://cloud.google.com/looker/docs/reference/param-field-value-format |
DataFilter
Um filtro nos dados subjacentes de uma fonte de dados. Documentação da sintaxe de filtro: https://cloud.google.com/looker/docs/filter-expressions
| Representação JSON |
|---|
{
"field": string,
"value": string,
"type": enum ( |
| Campos | |
|---|---|
field |
Opcional. O campo a ser filtrado. Por exemplo: ["event_date", "customer_id", "product_category"] |
value |
Opcional. O valor padrão usado para esse filtro se ele não for substituído em uma consulta. Por exemplo: ["after 2024-01-01", "123", "-fashion"] |
type |
Opcional. O tipo de filtro presente em uma fonte de dados, como ALWAYS_FILTER. |
DataFilterType
O tipo de filtro presente em uma fonte de dados, como ALWAYS_FILTER.
| Tipos enumerados | |
|---|---|
DATA_FILTER_TYPE_UNSPECIFIED |
O tipo de filtro não foi especificado. |
ALWAYS_FILTER |
Um filtro que o usuário configura, e todas as consultas do recurso "Análise" sempre aplicam esse filtro por padrão. No momento, usado apenas para fontes de dados do Looker. |
StudioDatasourceReferences
Mensagem que representa as referências a fontes de dados do Looker Studio.
| Representação JSON |
|---|
{
"studioReferences": [
{
object ( |
| Campos | |
|---|---|
studioReferences[] |
Opcional. São as referências às fontes de dados do Looker Studio. |
StudioDatasourceReference
Mensagem que representa uma referência a uma única fonte de dados do Looker Studio.
| Representação JSON |
|---|
{ "datasourceId": string } |
| Campos | |
|---|---|
datasourceId |
Obrigatório. É o ID da fonte de dados. |
LookerExploreReferences
Mensagem que representa as referências a Análises do Looker.
| Representação JSON |
|---|
{
"exploreReferences": [
{
object ( |
| Campos | |
|---|---|
exploreReferences[] |
Obrigatório. São referências às Análises do Looker. |
LookerExploreReference
Mensagem que representa uma referência a uma única Análise do Looker.
| Representação JSON |
|---|
{ "lookmlModel": string, "explore": string, "schema": { object ( |
| Campos | |
|---|---|
lookmlModel |
Obrigatório. É o modelo do Looker, conforme descrito em Principais estruturas do LookML. Trata-se do nome do modelo do LookML. |
explore |
Obrigatório. É a Análise do Looker, conforme descrito em Principais estruturas do LookML. Trata-se do nome da Análise do LookML. |
schema |
Opcional. É o esquema da fonte de dados. |
Campo de união instance. É a instância da Análise do Looker. instance só pode ser uma destas opções: |
|
lookerInstanceUri |
Obrigatório. É o URL de base da instância do Looker. |
privateLookerInstanceInfo |
Inclui informações sobre a instância privada do Looker. |
PrivateLookerInstanceInfo
Mensagem que representa as informações sobre uma instância particular do Looker necessárias caso a instância esteja em uma rede privada.
| Representação JSON |
|---|
{ "lookerInstanceId": string, "serviceDirectoryName": string } |
| Campos | |
|---|---|
lookerInstanceId |
É o ID da instância do Looker. |
serviceDirectoryName |
É o nome do diretório de serviços da instância do Looker. |
ConversationOptions
São opções para a conversa.
| Representação JSON |
|---|
{ "analysis": { object ( |
| Campos | |
|---|---|
analysis |
Opcional. São opções de análise. |
datasource |
Opcional. Opções para fontes de dados. |
model |
Opcional. O modelo a ser usado no loop do agente. |
AnalysisOptions
São opções de análise.
| Representação JSON |
|---|
{
"python": {
object ( |
| Campos | |
|---|---|
python |
Opcional. São opções para análise em Python. |
Python
São opções para análise em Python.
| Representação JSON |
|---|
{ "enabled": boolean } |
| Campos | |
|---|---|
enabled |
Opcional. Indica se a análise em Python precisa ser ativada. O padrão é "falso". |
DatasourceOptions
Opções para configurações de fontes de dados.
| Representação JSON |
|---|
{ "bigQueryMaxBilledBytes": string } |
| Campos | |
|---|---|
bigQueryMaxBilledBytes |
Opcional. Essa opção se aplica apenas a fontes de dados que exigem consultas do BigQuery. Limita os bytes faturados para cada job de consulta do BigQuery. As consultas que ultrapassarem o limite de bytes faturados vão falhar (sem gerar cobranças). Se não for especificado, nenhum limite será aplicado. |
Modelo
Modelos permitidos para o agente/conversa.
| Tipos enumerados | |
|---|---|
MODEL_UNSPECIFIED |
Nenhum modelo especificado. O modelo pode ser definido na solicitação de chat ou o modelo padrão será usado. |
LATEST_GA_MODEL |
Use o modelo não disponível em prévia mais atualizado. Isso pode restringir algumas configurações no nível da solicitação. |
ExampleQuery
Exemplo de uma consulta SQL relevante e usada com frequência e as consultas correspondentes em linguagem natural, se disponíveis. No momento, usado apenas para fontes de dados do BigQuery.
| Representação JSON |
|---|
{ "naturalLanguageQuestion": string, "parameters": [ { object ( |
| Campos | |
|---|---|
naturalLanguageQuestion |
Opcional. Uma pergunta em linguagem natural que um usuário pode fazer. Por exemplo: "Quantos pedidos foram feitos no mês passado?" |
parameters[] |
Opcional. A lista de parâmetros de consulta. Exemplo: a consulta SQL parametrizada "SELECT * FROM my_table WHERE id = @id" pode ser correspondida a qualquer valor de ID. |
Campo de união query. A consulta SQL ou do Looker que precisa ser gerada para responder à consulta em linguagem natural. query pode ser apenas de um dos tipos a seguir: |
|
sqlQuery |
Opcional. A consulta SQL que precisa ser gerada para responder à pergunta em linguagem natural. Por exemplo: "SELECT COUNT(*) FROM orders WHERE order_date BETWEEN '2024-01-01' AND '2024-01-31'" |
QueryParameter
Uma mensagem de parâmetro de consulta representa um parâmetro que pode ser usado para parametrizar uma consulta SQL.
| Representação JSON |
|---|
{ "name": string, "description": string, "dataType": string } |
| Campos | |
|---|---|
name |
Obrigatório. O nome da referência de parâmetro na consulta SQL. |
description |
Opcional. A descrição do parâmetro que pode ser usada pelo LLM para extrair o valor de parâmetro da pergunta do usuário. |
dataType |
Obrigatório. O tipo de dados do parâmetro, por exemplo, "STRING", "INT64", "DATE" etc. Para valores válidos, consulte a documentação do BigQuery. Isso será usado para preencher google.cloud.bigquery.v2.QueryParameterType.type. |
LookerGoldenQuery
Uma consulta de ouro para o Looker, incluindo perguntas em linguagem natural e uma consulta do Looker correspondente. Análogo a ExampleQuery.
| Representação JSON |
|---|
{
"naturalLanguageQuestions": [
string
],
"lookerQuery": {
object ( |
| Campos | |
|---|---|
naturalLanguageQuestions[] |
Opcional. Perguntas em linguagem natural que um usuário pode fazer. Por exemplo: "Quantos pedidos foram feitos no mês passado?" |
lookerQuery |
Opcional. A consulta do Looker correspondente às perguntas em linguagem natural. |
LookerQuery
Objeto de consulta do Looker Documentação da API Looker.
| Representação JSON |
|---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
| Campos | |
|---|---|
model |
Obrigatório. O modelo do LookML usado para gerar a consulta. |
explore |
Obrigatório. A Análise do LookML usada para gerar a consulta. |
fields[] |
Opcional. Os campos a serem recuperados da análise. |
filters[] |
Opcional. Os filtros a serem aplicados à análise detalhada. |
sorts[] |
Opcional. As classificações a serem aplicadas à análise detalhada. |
limit |
Opcional. Limite na consulta. |
queryId |
Opcional. O identificador principal do recurso de consulta no Looker, usado para operações de API. Corresponde a |
clientId |
Opcional. O identificador alfanumérico curto da consulta, usado para links de compartilhamento e URLs do recurso Detalhar (por exemplo, no parâmetro |
Filtro
Um filtro de consulta do Looker.
| Representação JSON |
|---|
{ "field": string, "value": string } |
| Campos | |
|---|---|
field |
Obrigatório. O campo a ser filtrado. |
value |
Opcional. O valor do campo a ser filtrado. Opcional para preservar o valor padrão como uma string vazia, importante para receber um URL do Looker Explore válido e funcional. |
GlossaryTerm
Definição de um termo em um domínio específico.
| Representação JSON |
|---|
{ "displayName": string, "description": string, "labels": [ string ] } |
| Campos | |
|---|---|
displayName |
Obrigatório. Nome de exibição fácil de usar do termo do glossário que está sendo definido. Por exemplo: "CTR", "taxa de conversão", "pendente" |
description |
Obrigatório. A descrição ou o significado do termo. Por exemplo: "Taxa de cliques", "A porcentagem de usuários que concluem uma ação desejada", "Um pedido que está aguardando processamento". |
labels[] |
Opcional. Uma lista de rótulos de uso geral associados a este termo. Por exemplo: ["taxa de cliques", "clickthrough", "waiting"] |
SchemaRelationship
A relação entre duas tabelas, incluindo colunas de referência e referenciadas. É um contexto derivado recuperado dos insights de conjunto de dados do Dataplex.
| Representação JSON |
|---|
{ "leftSchemaPaths": { object ( |
| Campos | |
|---|---|
leftSchemaPaths |
Uma lista ordenada de campos para a junção da primeira tabela. O tamanho dessa lista precisa ser igual a |
rightSchemaPaths |
Uma lista ordenada de campos para a junção da segunda tabela. O tamanho dessa lista precisa ser igual a |
sources[] |
Opcional. Fontes que geraram a aresta de relação do esquema. |
confidenceScore |
Opcional. Uma pontuação de confiança para a relação sugerida. As arestas adicionadas manualmente têm a maior pontuação de confiança. |
SchemaPaths
Representa um conjunto ordenado de caminhos no esquema da tabela.
| Representação JSON |
|---|
{ "tableFqn": string, "paths": [ string ] } |
| Campos | |
|---|---|
tableFqn |
O nome completo do recurso qualificado pelo serviço da tabela. Ex.: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID |
paths[] |
A lista ordenada de caminhos no esquema da tabela. |
Origem
Origem que gerou a aresta de relação do esquema.
| Tipos enumerados | |
|---|---|
SOURCE_UNSPECIFIED |
A origem da relação de esquema não foi especificada. |
BIGQUERY_JOB_HISTORY |
A origem da relação de esquema é o histórico de jobs do BigQuery. |
LLM_SUGGESTED |
A origem da relação de esquema é sugerida pelo LLM. |
BIGQUERY_TABLE_CONSTRAINTS |
A origem da relação de esquema são as restrições da tabela do BigQuery. |
UserFunctions
Uma coleção de funções do usuário a serem incluídas no contexto.
| Representação JSON |
|---|
{
"bqRoutines": [
{
object ( |
| Campos | |
|---|---|
bqRoutines[] |
Uma lista de rotinas do BigQuery para incluir no contexto. |
BigQueryRoutine
Referência a uma rotina do BigQuery.
| Representação JSON |
|---|
{
"routineReference": {
object ( |
| Campos | |
|---|---|
routineReference |
A referência à rotina do BigQuery. |
description |
Substituição ou adição à descrição pelo usuário para informar ao agente quando usar a UDF. |
BigQueryRoutineReference
Referência a uma rotina do BigQuery.
| Representação JSON |
|---|
{ "projectId": string, "datasetId": string, "routineId": string } |
| Campos | |
|---|---|
projectId |
O ID do projeto da rotina. |
datasetId |
O ID do conjunto de dados da rotina. |
routineId |
O ID da rotina. |
Métodos |
|
|---|---|
|
Cria um objeto DataAgent em um determinado projeto e local. |
|
Cria um novo DataAgent em determinado projeto e local de forma síncrona. |
|
Exclui um único objeto DataAgent. |
|
Exclui um único DataAgent de forma síncrona. |
|
Recebe detalhes de um único DataAgent. |
|
Recebe a política do IAM para o objeto DataAgent. |
|
Lista objetos DataAgent em um determinado projeto e local. |
|
Lista objetos DataAgent acessíveis ao autor da chamada em um determinado projeto e local. |
|
Atualiza os parâmetros de um único objeto DataAgent. |
|
Define a política do IAM para um objeto DataAgent. |
|
Atualiza os parâmetros de um único DataAgent de forma síncrona. |