REST Resource: projects.locations.dataAgents

Recurso: DataAgent

Mensaje que describe un objeto DataAgent.

Representación 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. Nombre de recurso único de un DataAgent. Formato: projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} es el ID del recurso y debe tener 63 caracteres o menos, así como coincidir con el formato descrito en https://google.aip.dev/122#resource-id-segments.

Ejemplo: projects/1234567890/locations/us-central1/dataAgents/my-agent

Se recomienda omitir la configuración de este campo durante la creación del agente, ya que se inferirá automáticamente y se sobrescribirá con {parent}/dataAgents/{dataAgentId}.
displayName

string

Opcional. Nombre visible fácil de usar.

  • Debe tener entre 1 y 256 caracteres.
description

string

Opcional. Descripción del agente.

  • Debe tener entre 1 y 1024 caracteres.
labels

map (key: string, value: string)

Opcional. Etiquetas para ayudar a los usuarios a filtrar agentes relacionados. Por ejemplo, "ventas", "empresa", "etl", etc. Las etiquetas de notas solo se usan para filtrar, no para las políticas. Consulta más información sobre el uso de etiquetas en la documentación de etiquetas.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }
createTime

string (Timestamp format)

Solo de salida. Hora en la que se creó el agente de datos.

Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo de salida. Hora a la que se actualizó el agente de datos por última vez.

Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
deleteTime

string (Timestamp format)

Solo de salida. [Solo salida] Hora en la que se eliminó provisionalmente el agente de datos.

Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
purgeTime

string (Timestamp format)

Solo de salida. Marca de tiempo UTC de cuándo se considera que este agente de datos ha caducado. Este valor siempre se proporciona en la salida, independientemente de lo que se haya enviado en la entrada.

Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
Campo de unión type. El tipo de agente. Puede ser uno de los siguientes: * Agente de analíticas de datos. * El agente de ingeniería de datos type solo puede ser uno de los siguientes:
dataAnalyticsAgent

object (DataAnalyticsAgent)

Agente de analíticas de datos.

DataAnalyticsAgent

Mensaje que describe un objeto DataAnalyticsAgent.

Representación JSON 
{
  "stagingContext": {
    object (Context)
  },
  "publishedContext": {
    object (Context)
  },
  "lastPublishedContext": {
    object (Context)
  }
}
Campos
stagingContext

object (Context)

Opcional. El contexto de staging del agente. Este contexto se usa para probar y validar los cambios antes de publicarlos.
publishedContext

object (Context)

Opcional. El contexto publicado del agente. La API Chat usa este contexto en producción.
lastPublishedContext

object (Context)

Solo de salida. El último contexto publicado del agente. Este campo es de solo salida y lo rellena el sistema cuando se actualiza el contexto publicado. Se usa para restaurar el agente a un estado anterior.

Contexto

Una colección de contexto que se aplicará a esta conversación.

Representación JSON 
{
  "systemInstruction": string,
  "datasourceReferences": {
    object (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  },
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Campos
systemInstruction

string

Opcional. El punto de entrada básico para los propietarios de datos que crean conocimientos de dominio para el agente.

Por qué: la jerga empresarial (por ejemplo, Los datos de ingresos acumulados en lo que va de año se calculan de la siguiente forma: la edad de jubilación en EE. UU. es de 65 años, etc. Las instrucciones del sistema (por ejemplo, responder como un pirata) pueden ayudar al modelo a entender el contexto empresarial de una pregunta de un usuario.
datasourceReferences

object (DatasourceReferences)

Obligatorio. Fuentes de datos disponibles para responder a la pregunta.
options

object (ConversationOptions)

Opcional. Opciones adicionales de la conversación.
exampleQueries[]

object (ExampleQuery)

Opcional. Una lista de consultas de ejemplo, que proporciona ejemplos de consultas de SQL relevantes y de uso habitual, así como sus correspondientes consultas en lenguaje natural (opcional). Actualmente solo se usa para las fuentes de datos de BigQuery.

DatasourceReferences

Una colección de referencias a fuentes de datos.

Representación 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ón references. Las fuentes de datos que se van a usar. references solo puede ser una de las siguientes cosas:
bq

object (BigQueryTableReferences)

Referencias a tablas de BigQuery.
studio

object (StudioDatasourceReferences)

Referencias a fuentes de datos de Looker Studio.
looker

object (LookerExploreReferences)

Referencias a Exploraciones de Looker.

BigQueryTableReferences

Mensaje que representa las referencias a tablas de BigQuery.

Representación JSON 
{
  "tableReferences": [
    {
      object (BigQueryTableReference)
    }
  ]
}
Campos
tableReferences[]

object (BigQueryTableReference)

Obligatorio. Referencias a tablas de BigQuery.

BigQueryTableReference

Mensaje que representa una referencia a una sola tabla de BigQuery.

Representación JSON 
{
  "projectId": string,
  "datasetId": string,
  "tableId": string,
  "schema": {
    object (Schema)
  }
}
Campos
projectId

string

Obligatorio. Proyecto al que pertenece la tabla.
datasetId

string

Obligatorio. Conjunto de datos al que pertenece la tabla.
tableId

string

Obligatorio. El ID de la tabla.
schema

object (Schema)

Opcional. El esquema de la fuente de datos.

Esquema

El esquema de una instancia de Datasource o QueryResult.

Representación JSON 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "description": string,
  "synonyms": [
    string
  ],
  "tags": [
    string
  ],
  "displayName": string,
  "filters": [
    {
      object (DataFilter)
    }
  ]
}
Campos
fields[]

object (Field)

Opcional. Los campos del esquema.
description

string

Opcional. Una descripción textual del contenido y el propósito de la tabla. Por ejemplo: "Contiene información sobre los pedidos de los clientes en nuestra tienda de comercio electrónico". Actualmente solo se usa para las fuentes de datos de BigQuery.
synonyms[]

string

Opcional. Lista de nombres alternativos o sinónimos que se pueden usar para hacer referencia a la tabla. Por ejemplo: ["ventas", "pedidos", "compras"]. Actualmente solo se usa para las fuentes de datos de BigQuery.
tags[]

string

Opcional. Lista de etiquetas o palabras clave asociadas a la tabla, que se usa para la categorización. Por ejemplo: ["transaction", "revenue", "customer_data"]. Actualmente solo se usa para las fuentes de datos de BigQuery.
displayName

string

Opcional. Table displayName (igual que la etiqueta en cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), no es obligatorio, actualmente solo Looker tiene este campo.
filters[]

object (DataFilter)

Opcional. Los filtros de los datos subyacentes de la fuente de datos. Actualmente solo se usa para fuentes de datos de Looker.

Campo

Un campo de un esquema.

Representación 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. Nombre del campo.
type

string

Opcional. Tipo del campo.
description

string

Opcional. Una breve descripción del campo.
mode

string

Opcional. El modo del campo (por ejemplo, NULLABLE, REPEATED).
synonyms[]

string

Opcional. Lista de nombres alternativos o sinónimos que se pueden usar para hacer referencia a este campo. Por ejemplo: ["id", "customerid", "cust_id"]. Actualmente solo se usa para las fuentes de datos de BigQuery.
tags[]

string

Opcional. Lista de etiquetas o palabras clave asociadas al campo, que se usa para la categorización. Por ejemplo: ["identifier", "customer", "pii"]. Actualmente solo se usa para las fuentes de datos de BigQuery.
displayName

string

Opcional. Field displayName (same as label in
subfields[]

object (Field)

Opcional. Propiedad recursiva para estructuras de esquemas anidadas.
category

string

Opcional. Categoría del campo, no obligatoria, actualmente solo útil para Looker. Usamos una cadena para no depender de un paquete externo y mantener este paquete independiente.
valueFormat

string

Opcional. Solo Looker. Formato del valor del campo. Ref.: https://cloud.google.com/looker/docs/reference/param-field-value-format

DataFilter

Un filtro de los datos subyacentes de una fuente de datos. Documentación sobre la sintaxis de los filtros: https://cloud.google.com/looker/docs/filter-expressions

Representación JSON 
{
  "field": string,
  "value": string,
  "type": enum (DataFilterType)
}
Campos
field

string

Opcional. El campo por el que se va a filtrar. Por ejemplo: ["event_date", "customer_id", "product_category"]
value

string

Opcional. El valor predeterminado que se usa en este filtro si no se anula en una consulta. Por ejemplo: ["after 2024-01-01", "123", "-fashion"]
type

enum (DataFilterType)

Opcional. El tipo de filtro presente en una fuente de datos, como ALWAYS_FILTER.

DataFilterType

El tipo de filtro presente en una fuente de datos, como ALWAYS_FILTER.

Enumeraciones
DATA_FILTER_TYPE_UNSPECIFIED No se ha especificado el tipo de filtro.
ALWAYS_FILTER Un filtro que configura el usuario y que se aplicará siempre de forma predeterminada a las consultas de Exploración. Actualmente solo se usa para fuentes de datos de Looker.

StudioDatasourceReferences

Mensaje que representa las referencias a fuentes de datos de Looker Studio.

Representación JSON 
{
  "studioReferences": [
    {
      object (StudioDatasourceReference)
    }
  ]
}
Campos
studioReferences[]

object (StudioDatasourceReference)

Las referencias a las fuentes de datos de Studio.

StudioDatasourceReference

Mensaje que representa una referencia a una sola fuente de datos de Looker Studio.

Representación JSON 
{
  "datasourceId": string
}
Campos
datasourceId

string

Obligatorio. Es el ID de la fuente de datos.

LookerExploreReferences

Mensaje que representa las referencias a las Exploraciones de Looker.

Representación JSON 
{
  "exploreReferences": [
    {
      object (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
Campos
exploreReferences[]

object (LookerExploreReference)

Obligatorio. Referencias a Exploraciones de Looker.
credentials

object (Credentials)

Opcional. Las credenciales que se deben usar al llamar a la API de Looker.

Actualmente, admite tanto tokens de OAuth como credenciales basadas en claves de API, tal como se describe en Autenticación con un SDK.

LookerExploreReference

Mensaje que representa una referencia a una sola Exploración de Looker.

Representación 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

Obligatorio. Modelo de Looker, tal como se describe en Estructuras principales de LookML. Nombre del modelo de LookML.
explore

string

Obligatorio. Explora de Looker, tal como se describe en Estructuras principales de LookML. Nombre de la Exploración de LookML.
schema

object (Schema)

Opcional. El esquema de la fuente de datos.
Campo de unión instance. La instancia de la exploración de Looker. instance solo puede ser una de las siguientes cosas:
lookerInstanceUri

string

Obligatorio. La URL base de la instancia de Looker.
privateLookerInstanceInfo

object (PrivateLookerInstanceInfo)

Información privada de la instancia de Looker.

PrivateLookerInstanceInfo

Mensaje que representa la información de una instancia privada de Looker. Es obligatorio si la instancia de Looker está detrás de una red privada.

Representación JSON 
{
  "lookerInstanceId": string,
  "serviceDirectoryName": string
}
Campos
lookerInstanceId

string

ID de la instancia de Looker.
serviceDirectoryName

string

Nombre del directorio de servicios de la instancia de Looker.

Credenciales

Representa diferentes formas de especificación de credenciales.

Representación 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ón kind. El tipo de credenciales. } El elemento kind solo puede ser una de las siguientes cosas:
oauth

object (OAuthCredentials)

Credenciales de OAuth.

OAuthCredentials

Representa las credenciales de OAuth.

Representación 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ón kind. El tipo de credenciales de OAuth. kind solo puede ser una de las siguientes cosas:
secret

object (SecretBased)

Credenciales de OAuth basadas en secretos.
token

object (TokenBased)

Credenciales de OAuth basadas en tokens.

SecretBased

Nombre del secreto que contiene el token de acceso. Representa las credenciales de OAuth basadas en secretos.

Representación JSON 
{
  "clientId": string,
  "clientSecret": string
}
Campos
clientId

string

Obligatorio. Un ID de cliente de OAuth.
clientSecret

string

Obligatorio. Un secreto de cliente de OAuth.

TokenBased

Consulta más información sobre los tokens de acceso de Looker en este enlace: https://developers.looker.com/api/advanced-usage/looker-api-oauth.

Representación JSON 
{
  "accessToken": string
}
Campos
accessToken

string

Obligatorio. Nombre del secreto que contiene el token de acceso.

ConversationOptions

Opciones de la conversación.

Representación JSON 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  }
}
Campos
chart

object (ChartOptions)

Opcional. Opciones para generar gráficos.
analysis

object (AnalysisOptions)

Opcional. Opciones de análisis.

ChartOptions

Opciones para generar gráficos.

Representación JSON 
{
  "image": {
    object (ImageOptions)
  }
}
Campos
image

object (ImageOptions)

Opcional. Si se especifica, el agente renderizará los gráficos generados con el formato proporcionado. El valor predeterminado es sin imagen.

ImageOptions

Opciones para renderizar imágenes de gráficos generados.

Representación 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ón kind. El tipo de imagen que se debe renderizar. kind solo puede ser una de las siguientes cosas:
noImage

object (NoImage)

No hay imagen.
svg

object (SvgOptions)

Formato SVG.

NoImage

Este tipo no tiene campos.

No hay imagen.

SvgOptions

Este tipo no tiene campos.

Opciones de SVG.

AnalysisOptions

Opciones de análisis.

Representación JSON 
{
  "python": {
    object (Python)
  }
}
Campos
python

object (Python)

Opcional. Opciones de análisis de Python.

Python

Opciones de análisis de Python.

Representación JSON 
{
  "enabled": boolean
}
Campos
enabled

boolean

Opcional. Indica si se debe habilitar el análisis de Python. El valor predeterminado es "false".

ExampleQuery

Ejemplo de consulta SQL pertinente y de uso habitual, y sus correspondientes consultas en lenguaje natural (opcional). Actualmente solo se usa para las fuentes de datos de BigQuery.

Representación 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. Una pregunta en lenguaje natural que puede hacer un usuario. Por ejemplo: "¿Cuántos pedidos se hicieron el mes pasado?"
Campo de unión query. La consulta de SQL o de Looker que se debe generar para responder a la consulta en lenguaje natural. query solo puede ser una de las siguientes cosas:
sqlQuery

string

Opcional. La consulta de SQL que se debe generar para responder a la pregunta en lenguaje natural. Por ejemplo: "SELECT COUNT(*) FROM orders WHERE order_date BETWEEN '2024-01-01' AND '2024-01-31'"

Métodos

create

 Crea un DataAgent en un proyecto y una ubicación determinados.

delete

 Elimina un único DataAgent.

get

 Obtiene los detalles de un solo DataAgent.

getIamPolicy

 Obtiene la política de gestión de identidades y accesos de DataAgent.

list

 Muestra los DataAgents de un proyecto y una ubicación determinados.

listAccessible

 Muestra los DataAgents a los que puede acceder la persona que llama en un proyecto y una ubicación determinados.

patch

 Actualiza los parámetros de un solo DataAgent.

setIamPolicy

 Define la política de gestión de identidades y accesos de un DataAgent.