REST Resource: projects.locations.dataAgents

Recurso: DataAgent

Es un 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. Es el identificador. Es el nombre único del recurso de un DataAgent. Formato: projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} es el ID del recurso y debe tener 63 caracteres o menos, y debe coincidir con el formato que se describe 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. Es el nombre visible fácil de usar.

  • Debe tener entre 1 y 256 caracteres.
description

string

Opcional. Es la descripción del agente.

  • Debe tener entre 1 y 1,024 caracteres.
labels

map (key: string, value: string)

Opcional. Son etiquetas que ayudan a los usuarios a filtrar los agentes relacionados. Por ejemplo, "ventas", "negocios", "etl", etcétera. Las etiquetas de notas solo se usan para filtrar y no para las políticas. Consulta la documentación sobre etiquetas para obtener más detalles sobre su uso.

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

string (Timestamp format)

Solo salida. Es la fecha y hora en que se creó el agente de datos.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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 salida. Fecha y hora en que se actualizó el agente de datos por última vez.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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 salida. [Solo salida] Es la fecha y hora en que se borró de forma no definitiva el agente de datos.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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 salida. Marca de tiempo en UTC del momento en que este agente de datos se consideró vencido. Esto siempre se proporciona en la salida, sin importar si se envió en la entrada.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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. Es el tipo de agente. Puede ser uno de los siguientes: * Agente de análisis de datos. * El agente de ingeniería de datos type solo puede ser uno de los siguientes:
dataAnalyticsAgent

object (DataAnalyticsAgent)

Es un agente de análisis de datos.

DataAnalyticsAgent

Es un mensaje que describe un objeto DataAnalyticsAgent.

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

object (Context)

Opcional. Es el contexto de etapa de pruebas del agente. Este contexto se usa para probar y validar los cambios antes de publicarlos.
publishedContext

object (Context)

Opcional. Es el contexto publicado para el agente. La API de Chat usa este contexto en producción.
lastPublishedContext

object (Context)

Solo salida. Es el contexto publicado más reciente del agente. Este es un campo de solo salida que el sistema completa cuando se actualiza el contexto publicado. Se usa para restablecer el agente a un estado anterior.

Contexto

Es una colección de contexto para aplicar a esta conversación.

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

string

Opcional. Es el punto de entrada básico para los propietarios de datos que crean conocimiento del dominio para el agente.

Motivo: Jerga empresarial (p.ej., Los ejemplos (p. ej., Los ingresos acumulados en el año se calculan de la siguiente manera…, La edad de jubilación es de 65 años en EE.UU., etc.) y las instrucciones del sistema (p. ej., responde como un pirata) pueden ayudar al modelo a comprender el contexto empresarial en torno a una pregunta del usuario.
datasourceReferences

object (DatasourceReferences)

Obligatorio. Son las fuentes de datos disponibles para responder la pregunta.
options

object (ConversationOptions)

Opcional. Son opciones adicionales para la conversación.
exampleQueries[]

object (ExampleQuery)

Opcional. Es una lista de ejemplos de consultas que proporciona ejemplos de consultas en SQL pertinentes y de uso frecuente, y sus correspondientes consultas en lenguaje natural (opcional). Actualmente, solo se usa para las fuentes de datos de BigQuery.

DatasourceReferences

Es 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. Son las fuentes de datos que se usarán. references puede ser solo uno de los siguientes:
bq

object (BigQueryTableReferences)

Son referencias a tablas de BigQuery.
studio

object (StudioDatasourceReferences)

Son referencias a fuentes de datos de Looker Studio.
looker

object (LookerExploreReferences)

Son referencias a las exploraciones de Looker.

BigQueryTableReferences

Es un mensaje que representa referencias a tablas de BigQuery.

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

object (BigQueryTableReference)

Obligatorio. Son referencias a tablas de BigQuery.

BigQueryTableReference

Es un 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. Es el proyecto al que pertenece la tabla.
datasetId

string

Obligatorio. Es el conjunto de datos al que pertenece la tabla.
tableId

string

Obligatorio. Es el ID de la tabla.
schema

object (Schema)

Opcional. Es el esquema de la fuente de datos.

Esquema

Es 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. Son los campos del esquema.
description

string

Opcional. Es 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. Es una 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. Es una 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. displayName de la tabla (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. Son los filtros aplicados a los datos subyacentes de la fuente de datos. Actualmente, solo se usa para las fuentes de datos de Looker.

Campo

Es un campo en 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. El nombre del campo
type

string

Opcional. Es el tipo del campo.
description

string

Opcional. Es una breve descripción del campo.
mode

string

Opcional. Es el modo del campo (p.ej., NULLABLE, REPEATED).
synonyms[]

string

Opcional. Es una 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. Es una 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. displayName del campo (igual que la etiqueta en
subfields[]

object (Field)

Opcional. Es una 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 evitar depender de un paquete externo y mantener este paquete autónomo.
valueFormat

string

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

DataFilter

Es un filtro aplicado a 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. Es el campo por el que se filtrará. Por ejemplo: ["event_date", "customer_id", "product_category"]
value

string

Opcional. Es el valor predeterminado que se usa para este filtro si no se anula en una búsqueda. Por ejemplo: ["after 2024-01-01", "123", "-fashion"]
type

enum (DataFilterType)

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

DataFilterType

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

Enums
DATA_FILTER_TYPE_UNSPECIFIED No se especificó el tipo de filtro.
ALWAYS_FILTER Es un filtro que configura el usuario y que todas las búsquedas en la función Explorar siempre aplicarán de forma predeterminada. Actualmente, solo se usa para las fuentes de datos de Looker.

StudioDatasourceReferences

Es un mensaje que representa referencias a fuentes de datos de Looker Studio.

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

object (StudioDatasourceReference)

Son las referencias a las fuentes de datos del estudio.

StudioDatasourceReference

Es un 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

Es un mensaje que representa referencias a exploraciones de Looker.

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

object (LookerExploreReference)

Obligatorio. Son referencias a las exploraciones de Looker.
credentials

object (Credentials)

Opcional. Son las credenciales que se usarán cuando se llame a la API de Looker.

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

LookerExploreReference

Es un 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, como se describe en Estructuras principales de LookML Nombre del modelo de LookML.
explore

string

Obligatorio. Looker Explore, como se describe en Estructuras principales de LookML Nombre de la exploración de LookML.
schema

object (Schema)

Opcional. Es el esquema de la fuente de datos.
Campo de unión instance. Es la instancia de la exploración de Looker. instance puede ser solo uno de los siguientes:
lookerInstanceUri

string

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

object (PrivateLookerInstanceInfo)

Es información de la instancia privada de Looker.

PrivateLookerInstanceInfo

Es un mensaje que representa la información de una instancia privada de Looker que se requiere si la instancia de Looker se encuentra detrás de una red privada.

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

string

Es el ID de la instancia de Looker.
serviceDirectoryName

string

Es el 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. Es el tipo de credenciales. } kind solo puede ser una de las siguientes opciones:
oauth

object (OAuthCredentials)

Son las 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. Es el tipo de credenciales de OAuth. kind puede ser solo uno de los siguientes:
secret

object (SecretBased)

Son credenciales de OAuth basadas en un secreto.
token

object (TokenBased)

Son credenciales de OAuth basadas en tokens.

SecretBased

Nombre del Secret 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. Es un ID de cliente de OAuth.
clientSecret

string

Obligatorio. Es el secreto del cliente de OAuth.

TokenBased

Obtén más información sobre los tokens de acceso de Looker aquí: https://developers.looker.com/api/advanced-usage/looker-api-oauth

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

string

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

ConversationOptions

Son las opciones de la conversación.

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

object (ChartOptions)

Opcional. Son las opciones para generar gráficos.
analysis

object (AnalysisOptions)

Opcional. Son las opciones de análisis.

ChartOptions

Son las opciones para generar gráficos.

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

object (ImageOptions)

Opcional. Cuando se especifica, el agente renderizará los gráficos generados con el formato proporcionado. La configuración predeterminada es sin imagen.

ImageOptions

Son 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. Es el tipo de imagen que se renderizará. kind puede ser solo uno de los siguientes:
noImage

object (NoImage)

Sin imagen.
svg

object (SvgOptions)

Formato SVG

NoImage

Este tipo no tiene campos.

Sin imagen.

SvgOptions

Este tipo no tiene campos.

Opciones de SVG

AnalysisOptions

Son las opciones de análisis.

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

object (Python)

Opcional. Son las opciones para el análisis de Python.

Python

Son las opciones para el análisis de Python.

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

boolean

Opcional. Indica si se debe habilitar el análisis de Python. La configuración predeterminada es "false".

ExampleQuery

Ejemplo de una consulta en SQL pertinente y de uso frecuente, y sus correspondientes consultas en lenguaje natural que pueden estar presentes de forma 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. Es una pregunta en lenguaje natural que podría hacer un usuario. Por ejemplo: "¿Cuántos pedidos se hicieron el mes pasado?"
Campo de unión query. Es la consulta en SQL o Looker que se debe generar para responder la consulta en lenguaje natural. query puede ser solo uno de los siguientes:
sqlQuery

string

Opcional. Es la consulta en SQL que se debe generar para responder 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 nuevo DataAgent en un proyecto y una ubicación determinados.

delete

 Borra un solo DataAgent.

get

 Obtiene detalles de un solo DataAgent.

getIamPolicy

 Obtiene la política de IAM para DataAgent

list

 Enumera los DataAgents en una ubicación y un proyecto determinados.

listAccessible

 Enumera los DataAgents a los que puede acceder el llamador en una ubicación y un proyecto determinados.

patch

 Actualiza los parámetros de un solo DataAgent.

setIamPolicy

 Establece la política de IAM para un DataAgent.