REST Resource: projects.locations.dataAgents

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 type can be only one of the following:
  "dataAnalyticsAgent": {
    object (DataAnalyticsAgent)
  }
  // End of list of possible types for union field type.
}
Campos
name

string

Opcional. Identificador. O nome de recurso exclusivo de um DataAgent. Formato: projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} é o ID do recurso. Ele pode ter até 63 caracteres e precisa seguir o formato descrito em https://google.aip.dev/122#resource-id-segments (link em inglês).

Exemplo: projects/1234567890/locations/us-central1/dataAgents/my-agent.

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

string

Opcional. É um nome de exibição fácil de usar.

  • Precisa ter entre 1 e 256 caracteres.
description

string

Opcional. É a descrição do agente.

  • Precisa ter entre 1 e 1.024 caracteres.
labels

map (key: string, value: string)

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 "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
deleteTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
purgeTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
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

object (DataAnalyticsAgent)

É o agente de análise de dados.

DataAnalyticsAgent

Mensagem que descreve um objeto DataAnalyticsAgent.

Representação JSON 
{
  "stagingContext": {
    object (Context)
  },
  "publishedContext": {
    object (Context)
  },
  "lastPublishedContext": {
    object (Context)
  }
}
Campos
stagingContext

object (Context)

Opcional. É o contexto da fase de testes do agente, usado para verificar e validar as mudanças antes da publicação.
publishedContext

object (Context)

Opcional. É o contexto publicado do agente, usado pela API Chat em produção.
lastPublishedContext

object (Context)

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 (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  },
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Campos
systemInstruction

string

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

object (DatasourceReferences)

Obrigatório. Fontes de dados disponíveis para responder à pergunta.
options

object (ConversationOptions)

Opcional. Outras opções para a conversa.
exampleQueries[]

object (ExampleQuery)

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 do BigQuery.

DatasourceReferences

Uma coleção de referências a fontes de dados.

Representação 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.
}
Campos
Campo de união references. As fontes de dados que serão usadas. references só pode ser uma destas opções:
bq

object (BigQueryTableReferences)

São referências a tabelas do BigQuery.
studio

object (StudioDatasourceReferences)

São referências a fontes de dados do Looker Studio.
looker

object (LookerExploreReferences)

São referências às Análises do Looker.

BigQueryTableReferences

Mensagem que representa as referências a tabelas do BigQuery.

Representação JSON 
{
  "tableReferences": [
    {
      object (BigQueryTableReference)
    }
  ]
}
Campos
tableReferences[]

object (BigQueryTableReference)

Obrigatório. 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 (Schema)
  }
}
Campos
projectId

string

Obrigatório. É o projeto ao qual a tabela pertence.
datasetId

string

Obrigatório. É o conjunto de dados ao qual a tabela pertence.
tableId

string

Obrigatório. É o ID da tabela.
schema

object (Schema)

Opcional. É o esquema da fonte de dados.

Esquema

É o esquema de uma instância de Datasource ou QueryResult.

Representação JSON 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "description": string,
  "synonyms": [
    string
  ],
  "tags": [
    string
  ],
  "displayName": string,
  "filters": [
    {
      object (DataFilter)
    }
  ]
}
Campos
fields[]

object (Field)

Opcional. São os campos no esquema.
description

string

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[]

string

Opcional. Uma lista de nomes alternativos ou sinônimos que podem ser usados para se referir à tabela. Por exemplo: ["vendas", "pedidos", "compras"]. No momento, usado apenas para fontes de dados do BigQuery.
tags[]

string

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

string

Opcional. É o displayName da tabela (cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), e somente o Looker tem esse campo.
filters[]

object (DataFilter)

Opcional. Os filtros nos dados subjacentes da fonte de dados. No momento, só é usado 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 (Field)
    }
  ],
  "category": string,
  "valueFormat": string
}
Campos
name

string

Opcional. É o nome do campo.
type

string

Opcional. É o tipo do campo.
description

string

Opcional. É uma breve descrição do campo.
mode

string

Opcional. É o modo do campo (por exemplo, NULLABLE, REPEATED).
synonyms[]

string

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[]

string

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

string

Opcional. É o displayName do campo (igual ao rótulo em
subfields[]

object (Field)

Opcional. É uma propriedade recursiva para estruturas aninhadas de esquemas.
category

string

Opcional. É a categoria do campo, sendo útil apenas para o Looker por enquanto. Estamos usando uma string para evitar depender de um pacote externo, mantendo a independência.
valueFormat

string

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 (DataFilterType)
}
Campos
field

string

Opcional. O campo a ser filtrado. Por exemplo: ["event_date", "customer_id", "product_category"]
value

string

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

enum (DataFilterType)

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 "Explorar" sempre aplicam esse filtro por padrão. No momento, só é usado 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 (StudioDatasourceReference)
    }
  ]
}
Campos
studioReferences[]

object (StudioDatasourceReference)

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

string

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 (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
Campos
exploreReferences[]

object (LookerExploreReference)

Obrigatório. São referências às Análises do Looker.
credentials

object (Credentials)

Opcional. As credenciais que serão usadas ao chamar a API Looker.

Atualmente, aceita credenciais baseadas em tokens OAuth e chaves de API, conforme descrito em Autenticação com um SDK.

LookerExploreReference

Mensagem que representa uma referência a uma única Análise do Looker.

Representação 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.
}
Campos
lookmlModel

string

Obrigatório. É o modelo do Looker, conforme descrito em Principais estruturas do LookML. Trata-se do nome do modelo do LookML.
explore

string

Obrigatório. É a Análise do Looker, conforme descrito em Principais estruturas do LookML. Trata-se do nome da Análise do LookML.
schema

object (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

string

Obrigatório. É o URL de base da instância do Looker.
privateLookerInstanceInfo

object (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

string

É o ID da instância do Looker.
serviceDirectoryName

string

É o nome do diretório de serviços da instância do Looker.

Credenciais

Representa diferentes formas de especificação das credenciais.

Representação JSON 
{

  // Union field kind can be only one of the following:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de união kind. É o tipo de credencial. } kind só pode ser:
oauth

object (OAuthCredentials)

São as credenciais do OAuth.

OAuthCredentials

Representa as credenciais do OAuth.

Representação 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.
}
Campos
Campo de união kind. É o tipo de credencial do OAuth. kind só pode ser uma destas opções:
secret

object (SecretBased)

São credenciais do OAuth baseadas em Secrets.
token

object (TokenBased)

São credenciais do OAuth baseadas em tokens.

SecretBased

É o nome do Secret que contém o token de acesso. Representa as credenciais do OAuth com base em Secrets.

Representação JSON 
{
  "clientId": string,
  "clientSecret": string
}
Campos
clientId

string

Obrigatório. É um ID do cliente do OAuth.
clientSecret

string

Obrigatório. É um Secret do cliente OAuth.

TokenBased

Saiba mais sobre os tokens de acesso do Looker: https://developers.looker.com/api/advanced-usage/looker-api-oauth

Representação JSON 
{
  "accessToken": string
}
Campos
accessToken

string

Obrigatório. É o nome do Secret que contém o token de acesso.

ConversationOptions

São opções para a conversa.

Representação JSON 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  }
}
Campos
chart

object (ChartOptions)

Opcional. São opções para geração de gráficos.
analysis

object (AnalysisOptions)

Opcional. São opções de análise.

ChartOptions

São opções para geração de gráficos.

Representação JSON 
{
  "image": {
    object (ImageOptions)
  }
}
Campos
image

object (ImageOptions)

Opcional. Quando especificado, o agente vai renderizar os gráficos gerados usando o formato fornecido. O padrão é não ter imagem.

ImageOptions

São opções para renderizar imagens de gráficos gerados.

Representação 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.
}
Campos
Campo de união kind. É o tipo de imagem que será renderizada. kind só pode ser uma destas opções:
noImage

object (NoImage)

Sem imagem.
svg

object (SvgOptions)

Formato SVG.

NoImage

Esse tipo não tem campos.

Sem imagem.

SvgOptions

Esse tipo não tem campos.

Opções de SVG.

AnalysisOptions

São opções de análise.

Representação JSON 
{
  "python": {
    object (Python)
  }
}
Campos
python

object (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

boolean

Opcional. Indica se a análise em Python precisa ser ativada. O padrão é "false".

ExampleQuery

Exemplo de uma consulta SQL relevante e usada com frequência e as consultas correspondentes em linguagem natural, que podem estar presentes. No momento, usado apenas para fontes de dados do BigQuery.

Representação 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.
}
Campos
naturalLanguageQuestion

string

Opcional. Uma pergunta em linguagem natural que um usuário pode fazer. Por exemplo: "Quantos pedidos foram feitos no mês passado?"
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

string

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'"

Métodos

create

 Cria um objeto DataAgent em um determinado projeto e local.

delete

 Exclui um único objeto DataAgent.

get

 Recebe detalhes de um único objeto DataAgent.

getIamPolicy

 Recebe a política do IAM para o objeto DataAgent.

list

 Lista objetos DataAgent em um determinado projeto e local.

listAccessible

 Lista objetos DataAgent acessíveis ao autor da chamada em um determinado projeto e local.

patch

 Atualiza os parâmetros de um único objeto DataAgent.

setIamPolicy

 Define a política do IAM para um objeto DataAgent.