REST Resource: projects.locations.dataAgents

Recurso: DataAgent

Mensagem que descreve 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 do recurso exclusivo de um DataAgent. Formato: projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} é o ID do recurso e deve ter 63 carateres ou menos, e corresponder ao formato descrito em https://google.aip.dev/122#resource-id-segments

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

Recomendamos que ignore a definição deste campo durante a criação do agente, uma vez que é inferido automaticamente e substituído por {parent}/dataAgents/{dataAgentId}.
displayName

string

Opcional. Nome a apresentar intuitivo.

  • Tem de ter entre 1 e 256 carateres.
description

string

Opcional. Descrição do agente.

  • Tem de ter entre 1 e 1024 carateres.
labels

map (key: string, value: string)

Opcional. Etiquetas para ajudar os utilizadores a filtrar agentes relacionados. Por exemplo, "vendas", "empresa", "etl" e assim sucessivamente. As etiquetas de notas são usadas apenas para filtragem e não para políticas. Consulte a documentação sobre etiquetas para ver mais detalhes sobre a utilização de etiquetas.

Um objeto que contém uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Apenas saída. A hora em que o agente de dados foi criado.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 saída. A hora em que o agente de dados foi atualizado pela última vez.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 saída. [Apenas saída] A hora em que o agente de dados foi eliminado temporariamente.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 saída. Data/hora em UTC em que este agente de dados é considerado expirado. Este valor é sempre fornecido na saída, independentemente do que foi enviado na entrada.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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 de agente. Pode ser uma das seguintes opções: * Agente de estatísticas de dados. * O agente de engenharia de dados type só pode ser um dos seguintes:
dataAnalyticsAgent

object (DataAnalyticsAgent)

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 de preparação para o agente. Este contexto é usado para testar e validar as alterações antes da publicação.
publishedContext

object (Context)

Opcional. O contexto publicado para o agente. Este contexto é usado pela API Chat na produção.
lastPublishedContext

object (Context)

Apenas saída. O contexto publicado mais recentemente para o agente. Este é um campo só de saída preenchido pelo sistema quando o contexto publicado é atualizado. É usado para restaurar o agente para um estado anterior.

Contexto

Uma coleção de contexto a aplicar a esta conversa

Representação JSON 
{
  "systemInstruction": string,
  "datasourceReferences": {
    object (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  },
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Campos
systemInstruction

string

Opcional. O ponto de entrada básico para os proprietários de dados que criam conhecimentos do domínio para o agente.

Porquê: a gíria empresarial (por exemplo, As informações específicas da empresa (por exemplo, a receita desde o início do ano é calculada como…, a idade de reforma é de 65 anos nos EUA, etc.) e as instruções do sistema (por exemplo, responder como um pirata) podem ajudar o modelo a compreender o contexto empresarial em torno de uma pergunta do utilizador.
datasourceReferences

object (DatasourceReferences)

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

object (ConversationOptions)

Opcional. Opções adicionais para a conversa.
exampleQueries[]

object (ExampleQuery)

Opcional. Uma lista de consultas de exemplo, que fornece exemplos de consultas SQL relevantes e usadas com frequência, e as respetivas consultas de linguagem natural, que podem estar presentes. Atualmente, apenas é usado para origens de dados do BigQuery.

DatasourceReferences

Uma coleção de referências a origens 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 origens de dados a usar. references só pode ser uma das seguintes opções:
bq

object (BigQueryTableReferences)

Referências a tabelas do BigQuery.
studio

object (StudioDatasourceReferences)

Referências a origens de dados do Looker Studio.
looker

object (LookerExploreReferences)

Referências a opções Explorar do Looker.

BigQueryTableReferences

Mensagem que representa referências a tabelas do BigQuery.

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

object (BigQueryTableReference)

Obrigatório. 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 origem de dados.

Esquema

O esquema de uma instância 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. 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 as encomendas dos clientes na nossa loja de comércio eletrónico." Atualmente, apenas é usado para origens de dados do BigQuery.
synonyms[]

string

Opcional. Uma lista de nomes alternativos ou sinónimos que podem ser usados para fazer referência à tabela. Por exemplo: ["vendas", "encomendas", "compras"]. Atualmente, apenas é usado para origens de dados do BigQuery.
tags[]

string

Opcional. Uma lista de etiquetas ou palavras-chave associadas à tabela, usadas para categorização. Por exemplo: ["transaction", "revenue", "customer_data"]. Atualmente, apenas é usado para origens de dados do BigQuery.
displayName

string

Opcional. displayName da tabela (igual à etiqueta em cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), não obrigatório, atualmente apenas o Looker tem este campo.
filters[]

object (DataFilter)

Opcional. Os filtros nos dados subjacentes da origem de dados. Atualmente, apenas usado para origens de dados do Looker.

Campo

Um campo num 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 de 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"]. Atualmente, apenas é usado para origens de dados do BigQuery.
tags[]

string

Opcional. Uma lista de etiquetas ou palavras-chave associadas ao campo, usadas para categorização. Por exemplo: ["identifier", "customer", "pii"]. Atualmente, apenas é usado para origens de dados do BigQuery.
displayName

string

Opcional. Nome a apresentar do campo (igual à etiqueta em
subfields[]

object (Field)

Opcional. Propriedade recursiva para estruturas de esquemas aninhadas.
category

string

Opcional. Categoria do campo, não obrigatória, atualmente útil apenas para o Looker. Estamos a usar uma string para evitar depender de um pacote externo e manter este pacote autónomo.
valueFormat

string

Opcional. Apenas o 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 origem de dados. Documentação da sintaxe de filtros: 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 filtrar. Por exemplo: ["event_date", "customer_id", "product_category"]
value

string

Opcional. O valor predefinido usado para este filtro se o filtro não for substituído numa consulta. Por exemplo: ["after 2024-01-01", "123", "-fashion"]
type

enum (DataFilterType)

Opcional. O tipo de filtro presente numa origem de dados, como ALWAYS_FILTER.

DataFilterType

O tipo de filtro presente numa origem de dados, como ALWAYS_FILTER.

Enumerações
DATA_FILTER_TYPE_UNSPECIFIED O tipo de filtro não foi especificado.
ALWAYS_FILTER Um filtro que o utilizador configura e que todas as consultas ao Explorar aplicam sempre por predefinição. Atualmente, apenas usado para origens de dados do Looker.

StudioDatasourceReferences

Mensagem que representa referências a origens de dados do Looker Studio.

Representação JSON 
{
  "studioReferences": [
    {
      object (StudioDatasourceReference)
    }
  ]
}
Campos
studioReferences[]

object (StudioDatasourceReference)

As referências às origens de dados do Studio.

StudioDatasourceReference

Mensagem que representa uma referência a uma única origem de dados do Looker Studio.

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

string

Obrigatório. O ID da origem de dados.

LookerExploreReferences

Mensagem que representa referências a explorações do Looker.

Representação JSON 
{
  "exploreReferences": [
    {
      object (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
Campos
exploreReferences[]

object (LookerExploreReference)

Obrigatório. Referências a explorações do Looker.
credentials

object (Credentials)

Opcional. As credenciais a usar quando chamar a API Looker.

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

LookerExploreReference

Mensagem que representa uma referência a uma única exploração 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. Modelo do Looker, conforme descrito em Estruturas principais do LookML. Nome do modelo do LookML.
explore

string

Obrigatório. Explorar do Looker, conforme descrito em Estruturas principais do LookML. Nome da exploração do LookML.
schema

object (Schema)

Opcional. O esquema da origem de dados.
Campo de união instance. A instância do Explorar do Looker. instance só pode ser uma das seguintes opções:
lookerInstanceUri

string

Obrigatório. O URL base da instância do Looker.
privateLookerInstanceInfo

object (PrivateLookerInstanceInfo)

Informações da instância do Looker privada.

PrivateLookerInstanceInfo

Mensagem que representa as informações de uma instância privada do Looker necessárias se a instância do Looker estiver atrás de 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 de 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 credenciais. } kind só pode ser uma das seguintes opções:
oauth

object (OAuthCredentials)

Credenciais do OAuth.

OAuthCredentials

Representa 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 credenciais do OAuth. kind só pode ser uma das seguintes opções:
secret

object (SecretBased)

Credenciais do OAuth baseadas em segredos.
token

object (TokenBased)

Credenciais OAuth baseadas em tokens.

SecretBased

O nome do segredo que contém o token de acesso. Representa credenciais OAuth baseadas em segredos.

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

string

Obrigatório. Um ID de cliente OAuth.
clientSecret

string

Obrigatório. Um segredo do cliente OAuth.

TokenBased

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

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

string

Obrigatório. O nome do segredo que contém o token de acesso.

ConversationOptions

Opções para a conversa.

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

object (ChartOptions)

Opcional. Opções para a geração de gráficos.
analysis

object (AnalysisOptions)

Opcional. Opções de análise.

ChartOptions

Opções para a 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 com o formato fornecido. A predefinição é sem imagem.

ImageOptions

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 a renderizar. kind só pode ser uma das seguintes opções:
noImage

object (NoImage)

Sem imagem.
svg

object (SvgOptions)

SVG.

NoImage

Este tipo não tem campos.

Sem imagem.

SvgOptions

Este tipo não tem campos.

Opções SVG.

AnalysisOptions

Opções de análise.

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

object (Python)

Opcional. Opções para a análise do Python.

Python

Opções para a análise do Python.

Representação JSON 
{
  "enabled": boolean
}
Campos
enabled

boolean

Opcional. Ativar ou não a análise de Python. A predefinição é false.

ExampleQuery

Exemplo de uma consulta SQL relevante e usada com frequência, e as respetivas consultas de linguagem natural, que podem estar presentes ou não. Atualmente, apenas é usado para origens 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 utilizador pode fazer. Por exemplo: "Quantas encomendas foram feitas no mês passado?"
Campo de união query. A consulta SQL ou do Looker que deve ser gerada para responder à consulta de linguagem natural. query só pode ser uma das seguintes opções:
sqlQuery

string

Opcional. A consulta SQL que deve 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 novo DataAgent num determinado projeto e localização.

delete

 Elimina um único DataAgent.

get

 Obtém detalhes de um único DataAgent.

getIamPolicy

 Obtém a Política IAM para DataAgent

list

 Lista os DataAgents num determinado projeto e localização.

listAccessible

 Lista os DataAgents acessíveis ao autor da chamada num determinado projeto e localização.

patch

 Atualiza os parâmetros de um único DataAgent.

setIamPolicy

 Define a Política IAM para um DataAgent.