- Recurso: DataAgent
- DataAnalyticsAgent
- Contexto
- DatasourceReferences
- BigQueryTableReferences
- SearchScope
- BigQueryDatasetReference
- BigQueryTableReference
- Esquema
- Campo
- DataFilter
- DataFilterType
- BigQueryPropertyGraphReference
- AgentContextReference
- StudioDatasourceReferences
- StudioDatasourceReference
- LookerExploreReferences
- LookerExploreReference
- PrivateLookerInstanceInfo
- Credenciales
- OAuthCredentials
- SecretBased
- TokenBased
- AlloyDbReference
- AlloyDbDatabaseReference
- DatabaseTableReference
- SpannerReference
- SpannerDatabaseReference
- Motor
- CloudSqlReference
- CloudSqlDatabaseReference
- Motor
- BigtableReference
- BigtableDatabaseReference
- FirestoreReference
- FirestoreDatabaseReference
- ConversationOptions
- ChartOptions
- ImageOptions
- NoImage
- SvgOptions
- AnalysisOptions
- Python
- DatasourceOptions
- Modelo
- ExampleQuery
- QueryParameter
- LookerGoldenQuery
- LookerQuery
- Filtro
- GlossaryTerm
- SchemaRelationship
- SchemaPaths
- Fuente
- UserFunctions
- BigQueryRoutine
- BigQueryRoutineReference
- Métodos
Recurso: DataAgent
Es el 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,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"dataAnalyticsAgent": {
object ( |
| Campos | |
|---|---|
name |
Es opcional. Es el identificador. Es el nombre único del recurso de un DataAgent. Formato: Ejemplo: Se recomienda omitir la configuración de este campo durante la creación del agente, ya que se inferirá automáticamente y se reemplazará por {parent}/dataAgents/{dataAgentId}. |
displayName |
Es opcional. Nombre visible fácil de usar.
|
description |
Es opcional. Es la descripción del agente.
|
labels |
Es opcional. Son etiquetas para ayudar a los usuarios a filtrar 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 de etiquetas para obtener más detalles sobre el uso de etiquetas. Un objeto que contiene una lista de pares |
createTime |
Solo salida. Es la hora en la que se creó el agente de datos. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
updateTime |
Solo salida. La hora en la que se actualizó el agente de datos por última vez. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
deleteTime |
Solo salida. [Solo salida] Es la 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 usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
purgeTime |
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 usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
| Es el tipo de agente. Puede ser uno de los siguientes: * Agente de análisis de datos. * Agente de ingeniería de datos La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
dataAnalyticsAgent |
Agente de análisis de datos |
| Fin de los campos mutuamente excluyentes. | |
kmsKey |
Es opcional. Es la clave de encriptación administrada por el cliente (CMEK) que se usará para encriptar los recursos de DataAgent. Las CryptoKeys de Cloud KMS deben residir en la misma ubicación que el DataAgent. El formato esperado es |
DataAnalyticsAgent
Es el mensaje que describe un objeto DataAnalyticsAgent.
| Representación JSON |
|---|
{ "stagingContext": { object ( |
| Campos | |
|---|---|
stagingContext |
Es opcional. Es el contexto de etapa de pruebas para el agente. Este contexto se usa para probar y validar los cambios antes de publicarlos. |
publishedContext |
Es opcional. Es el contexto publicado para el agente. La API de Chat usa este contexto en producción. |
lastPublishedContext |
Solo salida. Es el último contexto publicado para el agente. Este es un campo de solo salida que completa el sistema cuando se actualiza el contexto publicado. Se usa para restablecer el agente a un estado anterior. |
Contexto
Es una colección de contexto que se aplicará a esta conversación.
| Representación JSON |
|---|
{ "systemInstruction": string, "datasourceReferences": { object ( |
| Campos | |
|---|---|
systemInstruction |
Es opcional. Es el punto de entrada básico para los propietarios de datos que crean conocimiento del dominio para el agente. Por qué: La jerga empresarial (p. ej., los ingresos del año hasta la fecha se calculan como…, 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 la pregunta de un usuario. |
datasourceReferences |
Obligatorio. Son las fuentes de datos que están disponibles para responder la pregunta. |
options |
Es opcional. Opciones adicionales para la conversación. |
exampleQueries[] |
Es opcional. Una lista de consultas de ejemplo, que proporciona ejemplos de consultas en SQL relevantes y de uso frecuente, y sus consultas en lenguaje natural correspondientes, que se presentan de forma opcional. Actualmente, solo se usa para fuentes de datos de BigQuery y bases de datos (alloydb, cloudsql, spanner). |
lookerGoldenQueries[] |
Es opcional. Es una lista de consultas de referencia, que proporciona ejemplos de consultas de Looker relevantes y de uso frecuente, y sus consultas de lenguaje natural correspondientes, que están presentes de forma opcional. Solo se admite para las fuentes de datos de Looker. |
glossaryTerms[] |
Es opcional. Definiciones de términos (actualmente, solo creadas por el usuario) No se admiten para fuentes de datos de bases de datos (alloydb, cloudsql, spanner). |
schemaRelationships[] |
Es opcional. Relaciones entre el esquema de la tabla, incluidas las columnas de referencia y las columnas a las que se hace referencia. |
userFunctions |
Es opcional. Es una colección de funciones de usuario que se incluirán en el contexto. |
DatasourceReferences
Es una colección de referencias a fuentes de datos.
| Representación JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "bq": { object ( |
| Campos | |
|---|---|
| Son las fuentes de datos que se usarán. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
bq |
Son referencias a tablas de BigQuery. |
studio |
Son referencias a fuentes de datos de Looker Studio. |
looker |
Son referencias a exploraciones de Looker. |
alloydb |
Es la referencia a una base de datos de AlloyDB. Solo se admite para el método |
spannerReference |
Es una referencia a una base de datos de Spanner. Solo se admite para el método |
cloudSqlReference |
Referencia a una base de datos de Cloud SQL. Solo se admite para el método |
bigtableReference |
Es una referencia a una instancia de Bigtable. |
firestoreReference |
Referencia a una base de datos de Firestore. |
| Fin de los campos mutuamente excluyentes. | |
BigQueryTableReferences
Mensaje que representa referencias a tablas de BigQuery y grafos de propiedades. Se debe completar al menos uno de los siguientes campos: tableReferences, propertyGraphReferences o searchScope.
| Representación JSON |
|---|
{ "tableReferences": [ { object ( |
| Campos | |
|---|---|
tableReferences[] |
Es opcional. Son referencias a tablas de BigQuery. |
propertyGraphReferences[] |
Es opcional. Referencias a grafos de BigQuery. Nota: "Gráfico de propiedades" es el nombre anterior de BigQuery Graph. Los nombres de los campos y los mensajes conservan el término original para mantener la retrocompatibilidad; ambos hacen referencia al mismo recurso. |
searchScope |
Es opcional. Busca en los recursos de BigQuery para descubrir las tablas más relevantes para la consulta. Cuando se establece, al menos uno de los campos Nota: |
agentContextReference |
Es opcional. Son los parámetros para recuperar datos del contexto del agente. |
SearchScope
Mensaje que representa los filtros que se aplicarán para buscar en las tablas de BigQuery.
Se debe completar al menos uno de los campos includeProjectIds o includeDatasetReferences con identificadores que no estén en blanco. Se incluyen las tablas que coinciden con cualquiera de los campos, por lo que los dos campos se unen (OR) en lugar de cruzarse.
Nota: SearchScope solo se admite para conversaciones independientes (ChatRequest.inline_context o ClientManagedResourceContext.inline_context) y no se admite en DataAgent.
| Representación JSON |
|---|
{
"includeProjectIds": [
string
],
"includeDatasetReferences": [
{
object ( |
| Campos | |
|---|---|
includeProjectIds[] |
Es opcional. Son los IDs de los proyectos de BigQuery en los que se realizará la búsqueda. |
includeDatasetReferences[] |
Es opcional. Son las referencias del conjunto de datos de BigQuery en las que se realizará la búsqueda. |
BigQueryDatasetReference
Mensaje que representa una referencia a un solo conjunto de datos de BigQuery.
| Representación JSON |
|---|
{ "projectId": string, "datasetId": string } |
| Campos | |
|---|---|
projectId |
Obligatorio. Es el ID del proyecto al que pertenece el conjunto de datos. |
datasetId |
Obligatorio. Es el ID del conjunto de datos. |
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 ( |
| Campos | |
|---|---|
projectId |
Obligatorio. Es el proyecto al que pertenece la tabla. |
datasetId |
Obligatorio. Es el conjunto de datos al que pertenece la tabla. |
tableId |
Obligatorio. Es el ID de la tabla. |
schema |
Es 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 ( |
| Campos | |
|---|---|
fields[] |
Es opcional. Son los campos del esquema. |
description |
Es 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[] |
Es opcional. Es una lista de nombres alternativos o sinónimos que se pueden usar para hacer referencia a la tabla. Por ejemplo: ["sales", "orders", "purchases"]. Actualmente, solo se usa para las fuentes de datos de BigQuery. |
tags[] |
Es opcional. Es una lista de etiquetas o palabras clave asociadas con 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 |
Es opcional. Es el 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[] |
Es opcional. Son los filtros de 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 ( |
| Campos | |
|---|---|
name |
Es opcional. El nombre del campo |
type |
Es opcional. Es el tipo de campo. |
description |
Es opcional. Es una breve descripción del campo. |
mode |
Es opcional. Es el modo del campo (p.ej., NULLABLE, REPEATED). |
synonyms[] |
Es opcional. Es una lista de nombres o sinónimos alternativos 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[] |
Es opcional. Es una lista de etiquetas o palabras clave asociadas con el 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 |
Es opcional. displayName del campo (igual que la etiqueta en |
subfields[] |
Es opcional. Propiedad recursiva para estructuras de esquemas anidados. |
category |
Es opcional. Categoría del campo, no es obligatoria, actualmente solo es útil para Looker. |
valueFormat |
Es opcional. Solo Looker. Es el formato del valor del campo. Ref.: https://cloud.google.com/looker/docs/reference/param-field-value-format |
DataFilter
Es un filtro de los datos subyacentes de una fuente de datos. Documentación sobre la sintaxis de filtros: https://cloud.google.com/looker/docs/filter-expressions
| Representación JSON |
|---|
{
"field": string,
"value": string,
"type": enum ( |
| Campos | |
|---|---|
field |
Es opcional. Es el campo por el que se filtrará. Por ejemplo: ["event_date", "customer_id", "product_category"] |
value |
Es opcional. Es el valor predeterminado que se usa para este filtro si no se anula en una consulta. Por ejemplo: ["after 2024-01-01", "123", "-fashion"] |
type |
Es 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 cualquier consulta a la exploración siempre aplicará este filtro de forma predeterminada. Actualmente, solo se usa para las fuentes de datos de Looker. |
BigQueryPropertyGraphReference
Mensaje que representa una referencia a un solo grafo de propiedades de BigQuery.
| Representación JSON |
|---|
{ "projectId": string, "datasetId": string, "propertyGraphId": string } |
| Campos | |
|---|---|
projectId |
Obligatorio. Es el proyecto al que pertenece el grafo de propiedades. |
datasetId |
Obligatorio. Es el conjunto de datos al que pertenece el grafo de propiedades. |
propertyGraphId |
Obligatorio. Es el ID del gráfico de propiedades. |
AgentContextReference
Es un mensaje que representa una referencia al contexto del agente.
| Representación JSON |
|---|
{ "contextSetId": string } |
| Campos | |
|---|---|
contextSetId |
Obligatorio. Es el ID del conjunto de contextos que se recuperará. |
StudioDatasourceReferences
Es un mensaje que representa referencias a fuentes de datos de Looker Studio.
| Representación JSON |
|---|
{
"studioReferences": [
{
object ( |
| Campos | |
|---|---|
studioReferences[] |
Es opcional. Son 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 |
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 ( |
| Campos | |
|---|---|
exploreReferences[] |
Obligatorio. Son referencias a exploraciones de Looker. |
credentials |
Es opcional. Obsoleto: Usa credenciales en ChatRequest. 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 el mensaje que representa una referencia a una sola exploración de Looker.
| Representación JSON |
|---|
{ "lookmlModel": string, "explore": string, "schema": { object ( |
| Campos | |
|---|---|
lookmlModel |
Obligatorio. Modelo de Looker, como se describe en Estructuras principales de LookML. Es el nombre del modelo de LookML. |
explore |
Obligatorio. Exploración de Looker, como se describe en Estructuras principales de LookML. Es el nombre de la exploración de LookML. |
schema |
Es opcional. Es el esquema de la fuente de datos. |
| Es la instancia de la exploración de Looker. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
lookerInstanceUri |
Obligatorio. Es la URL base de la instancia de Looker. |
privateLookerInstanceInfo |
Información de la instancia privada de Looker. |
| Fin de los campos mutuamente excluyentes. | |
PrivateLookerInstanceInfo
Mensaje que representa la información de una instancia privada de Looker que se requiere si la instancia de Looker está detrás de una red privada.
| Representación JSON |
|---|
{ "lookerInstanceId": string, "serviceDirectoryName": string } |
| Campos | |
|---|---|
lookerInstanceId |
Es el ID de la instancia de Looker. |
serviceDirectoryName |
Es el nombre del directorio de servicios de la instancia de Looker. |
Credenciales
Representa diferentes formas de especificación de credenciales.
| Representación JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"oauth": {
object ( |
| Campos | |
|---|---|
| Es el tipo de credenciales. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
oauth |
Credenciales de OAuth |
| Fin de los campos mutuamente excluyentes. | |
OAuthCredentials
Representa las credenciales de OAuth.
| Representación JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "secret": { object ( |
| Campos | |
|---|---|
| Es el tipo de credenciales de OAuth. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
secret |
Credenciales de OAuth basadas en secretos. |
token |
Credenciales de OAuth basadas en tokens. |
| Fin de los campos mutuamente excluyentes. | |
SecretBased
Es el 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 |
Obligatorio. Un ID de cliente de OAuth. |
clientSecret |
Obligatorio. Es un 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 |
Obligatorio. Es el nombre del Secret que contiene el token de acceso. |
AlloyDbReference
Es un mensaje que representa la referencia a una base de datos de AlloyDB y al contexto del agente. Solo se admite para el método QueryData.
| Representación JSON |
|---|
{ "databaseReference": { object ( |
| Campos | |
|---|---|
databaseReference |
Obligatorio. Es la referencia que especifica qué base de datos y tablas se deben incluir. |
agentContextReference |
Es opcional. Son los parámetros para recuperar datos del contexto del agente. |
AlloyDbDatabaseReference
Mensaje que representa una referencia a una sola base de datos de AlloyDB.
| Representación JSON |
|---|
{
"projectId": string,
"region": string,
"clusterId": string,
"instanceId": string,
"databaseId": string,
"tableIds": [
string
],
"databaseTableReferences": [
{
object ( |
| Campos | |
|---|---|
projectId |
Obligatorio. Es el proyecto al que pertenece la instancia. |
region |
Obligatorio. Es la región de la instancia. |
clusterId |
Obligatorio. Es el ID del clúster. |
instanceId |
Obligatorio. Es el ID de la instancia. |
databaseId |
Obligatorio. Es el ID de la base de datos. |
tableIds[] |
Es opcional. Los IDs de tabla. Indica todas las tablas si no se establece. |
databaseTableReferences[] |
Es opcional. Son referencias a tablas dentro de la base de datos. Cada referencia especifica una tabla y, de manera opcional, puede incluir el esquema de la tabla para proporcionar contexto para la consulta. |
DatabaseTableReference
Mensaje que representa una tabla, incluido su esquema.
| Representación JSON |
|---|
{
"tableId": string,
"schema": {
object ( |
| Campos | |
|---|---|
tableId |
Obligatorio. Es el nombre de la tabla como se define en la base de datos. Nota: El sistema de base de datos específico determina las reglas precisas para nombrar tablas, incluidos los caracteres válidos, los límites de longitud y la distinción entre mayúsculas y minúsculas. Requisitos: - Coincidencia exacta: El nombre proporcionado debe ser idéntico al nombre almacenado en la base de datos. - Distinción entre mayúsculas y minúsculas: Respeta las reglas de distinción entre mayúsculas y minúsculas del sistema de base de datos específico y cómo se creó la tabla. Por ejemplo, "Pedidos" y "pedidos" pueden ser nombres de tablas distintos. - Caracteres especiales o palabras clave: Si el nombre de la tabla incluye espacios, caracteres especiales o es una palabra clave reservada de la base de datos, proporciona el nombre literal tal como está almacenado. No agregues caracteres de comillas de identificador específicos de la base de datos (p.ej., ", `, []). Ejemplos: - Nombre simple: "orders", "UserActivity" - Distingue mayúsculas de minúsculas: "MyTable" - Nombre con espacios: "Order Details" - Nombre con otros caracteres especiales: "user/data", "order-items" - Nombre que es una palabra clave: "Group", "Order" Permisos: Las credenciales del emisor deben tener los permisos de base de datos necesarios para acceder al esquema y a los datos de la tabla. |
schema |
Es opcional. Es el esquema de la tabla. |
SpannerReference
Es un mensaje que representa la referencia a una base de datos de Spanner y al contexto del agente. Solo se admite para el método QueryData.
| Representación JSON |
|---|
{ "databaseReference": { object ( |
| Campos | |
|---|---|
databaseReference |
Obligatorio. Es la referencia que especifica qué base de datos y tablas se deben incluir. |
agentContextReference |
Es opcional. Son los parámetros para recuperar datos del contexto del agente. |
SpannerDatabaseReference
Mensaje que representa una referencia a una sola base de datos de Spanner.
| Representación JSON |
|---|
{ "engine": enum ( |
| Campos | |
|---|---|
engine |
Obligatorio. Es el motor de la instancia de Spanner. |
projectId |
Obligatorio. Es el proyecto al que pertenece la instancia. |
instanceId |
Obligatorio. Es el ID de la instancia. |
databaseId |
Obligatorio. Es el ID de la base de datos. |
tableIds[] |
Es opcional. Los IDs de tabla. Indica todas las tablas si no se establece. |
databaseTableReferences[] |
Es opcional. Son referencias a tablas dentro de la base de datos. Cada referencia especifica una tabla y, de manera opcional, puede incluir el esquema de la tabla para proporcionar contexto para la consulta. |
priority |
Es opcional. Es la prioridad de las consultas a Spanner. Debe ser un valor compatible con Cloud Spanner, p.ej.: LOW, MEDIUM, HIGH. Se ignorarán los valores no admitidos. Consulta https://docs.cloud.google.com/spanner/docs/reference/rest/v1/RequestOptions#Priority para obtener la lista completa. |
requestTag |
Es la etiqueta que se adjuntará a todas las consultas a Spanner. Permite identificar y supervisar las consultas que el servicio de GDA envía a Spanner. |
graphIds[] |
Es opcional. Son los IDs de los gráficos que se consultarán. |
Motor
Es el motor de base de datos.
| Enums | |
|---|---|
ENGINE_UNSPECIFIED |
No se especificó el motor. |
GOOGLE_SQL |
Google SQL |
POSTGRESQL |
PostgreSQL |
CloudSqlReference
Es un mensaje que representa la referencia a una base de datos de Cloud SQL y al contexto del agente. Solo se admite para el método QueryData.
| Representación JSON |
|---|
{ "databaseReference": { object ( |
| Campos | |
|---|---|
databaseReference |
Obligatorio. Es la referencia que especifica qué base de datos y tablas se deben incluir. |
agentContextReference |
Es opcional. Son los parámetros para recuperar datos del contexto del agente. |
CloudSqlDatabaseReference
Mensaje que representa una referencia a una sola base de datos de Cloud SQL.
| Representación JSON |
|---|
{ "engine": enum ( |
| Campos | |
|---|---|
engine |
Obligatorio. Es el motor de la instancia de Cloud SQL. |
projectId |
Obligatorio. Es el proyecto al que pertenece la instancia. |
region |
Obligatorio. Es la región de la instancia. |
instanceId |
Obligatorio. Es el ID de la instancia. |
databaseId |
Obligatorio. Es el ID de la base de datos. |
tableIds[] |
Es opcional. Los IDs de tabla. Indica todas las tablas si no se establece. |
databaseTableReferences[] |
Es opcional. Son referencias a tablas dentro de la base de datos. Cada referencia especifica una tabla y, de manera opcional, puede incluir el esquema de la tabla para proporcionar contexto para la consulta. |
Motor
Es el motor de base de datos.
| Enums | |
|---|---|
ENGINE_UNSPECIFIED |
No se especificó el motor. |
POSTGRESQL |
PostgreSQL |
MYSQL |
MySQL |
BigtableReference
Mensaje que representa la referencia a una instancia de Bigtable y al contexto del agente.
| Representación JSON |
|---|
{ "databaseReference": { object ( |
| Campos | |
|---|---|
databaseReference |
Obligatorio. Es una referencia que especifica qué instancia y tablas se deben incluir. |
agentContextReference |
Es opcional. Son los parámetros para recuperar datos del contexto del agente. |
BigtableDatabaseReference
Mensaje que representa la referencia a la base de datos de Bigtable.
| Representación JSON |
|---|
{
"projectId": string,
"instanceId": string,
"tableIds": [
string
],
"databaseTableReferences": [
{
object ( |
| Campos | |
|---|---|
projectId |
Obligatorio. Es el proyecto al que pertenece la instancia. |
instanceId |
Obligatorio. Es el ID de la instancia. |
tableIds[] |
Es opcional. Los IDs de tabla. Indica todas las tablas si no se establece. |
databaseTableReferences[] |
Es opcional. Son referencias a tablas dentro de la base de datos. Cada referencia especifica una tabla y, de manera opcional, puede incluir el esquema de la tabla para proporcionar contexto para la consulta. |
FirestoreReference
Es un mensaje que representa la referencia a una base de datos de Firestore y al contexto del agente.
| Representación JSON |
|---|
{ "databaseReference": { object ( |
| Campos | |
|---|---|
databaseReference |
Obligatorio. Es la referencia que especifica qué base de datos y colecciones se deben incluir. |
agentContextReference |
Es opcional. Son los parámetros para recuperar datos del contexto del agente. |
FirestoreDatabaseReference
Es el mensaje que representa una referencia a una sola base de datos de Firestore.
| Representación JSON |
|---|
{
"projectId": string,
"databaseId": string,
"collectionIds": [
string
],
"databaseTableReferences": [
{
object ( |
| Campos | |
|---|---|
projectId |
Obligatorio. Es el proyecto al que pertenece la base de datos de Firestore. |
databaseId |
Obligatorio. Es el ID de la base de datos. |
collectionIds[] |
Es opcional. Son los IDs de la colección. Indica todas las colecciones si no se establece. |
databaseTableReferences[] |
Es opcional. Son referencias a colecciones dentro de la base de datos. Cada referencia especifica una colección y, de manera opcional, puede incluir el esquema de la colección para proporcionar contexto para la consulta. |
ConversationOptions
Opciones para la conversación.
| Representación JSON |
|---|
{ "chart": { object ( |
| Campos | |
|---|---|
chart |
Es opcional. Opciones para la generación de gráficos. |
analysis |
Es opcional. Opciones para el análisis. |
datasource |
Es opcional. Opciones para las fuentes de datos. |
model |
Es opcional. Es el modelo que se usará para el bucle del agente. |
ChartOptions
Opciones para la generación de gráficos.
| Representación JSON |
|---|
{
"image": {
object ( |
| Campos | |
|---|---|
image |
Es 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 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "noImage": { object ( |
| Campos | |
|---|---|
| Es el tipo de imagen que se renderizará. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
noImage |
No hay imagen. |
svg |
Formato SVG. |
| Fin de los campos mutuamente excluyentes. | |
NoImage
Este tipo no tiene campos.
No hay imagen.
SvgOptions
Este tipo no tiene campos.
Opciones de SVG.
AnalysisOptions
Opciones para el análisis.
| Representación JSON |
|---|
{
"python": {
object ( |
| Campos | |
|---|---|
python |
Es opcional. Opciones para el análisis de Python. |
Python
Opciones para el análisis de Python.
| Representación JSON |
|---|
{ "enabled": boolean } |
| Campos | |
|---|---|
enabled |
Es opcional. Indica si se debe habilitar el análisis de Python. La configuración predeterminada es "false". |
DatasourceOptions
Opciones para la configuración de fuentes de datos.
| Representación JSON |
|---|
{ "bigQueryMaxBilledBytes": string } |
| Campos | |
|---|---|
bigQueryMaxBilledBytes |
Es opcional. Esta opción solo se aplica a las fuentes de datos que requieren consultas de BigQuery. Limita los bytes que se facturan por cada trabajo de consulta de BigQuery. Las consultas que tengan bytes facturados que superen este límite fallarán (sin generar cargos). Si no se especifica, no se aplicará ningún límite. |
Modelo
Modelos permitidos para el agente o la conversación.
| Enums | |
|---|---|
MODEL_UNSPECIFIED |
No se especificó ningún modelo. El modelo se puede configurar en la solicitud de chat o se usará el modelo predeterminado. |
LATEST_GA_MODEL |
Usa el modelo más actualizado que no sea de versión preliminar. Esto puede restringir ciertos parámetros de configuración a nivel de la solicitud. |
ExampleQuery
Ejemplo de una consulta en SQL relevante y de uso frecuente, y sus consultas en lenguaje natural correspondientes, que se presentan de forma opcional. Actualmente, solo se usa para las fuentes de datos de BigQuery.
| Representación JSON |
|---|
{
"naturalLanguageQuestion": string,
"parameters": [
{
object ( |
| Campos | |
|---|---|
naturalLanguageQuestion |
Es opcional. Es una pregunta en lenguaje natural que un usuario podría hacer. Por ejemplo: "¿Cuántos pedidos se hicieron el mes pasado?". |
parameters[] |
Es opcional. Es la lista de parámetros de consulta. Ejemplo: La consulta en SQL parametrizada "SELECT * FROM my_table WHERE id = @id" puede coincidir con cualquier valor de id. |
| La consulta en SQL o Looker que se debe generar para responder la consulta en lenguaje natural. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
sqlQuery |
Es 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'" |
| Fin de los campos mutuamente excluyentes. | |
QueryParameter
Un mensaje de parámetro de consulta representa un parámetro que se puede usar para parametrizar una consulta en SQL.
| Representación JSON |
|---|
{ "name": string, "description": string, "dataType": string } |
| Campos | |
|---|---|
name |
Obligatorio. Es el nombre de la referencia del parámetro en la consulta en SQL. |
description |
Es opcional. Es la descripción del parámetro que el LLM puede usar para extraer el valor del parámetro de la pregunta del usuario. |
dataType |
Obligatorio. Es el tipo de datos del parámetro, p.ej., "STRING", "INT64", "DATE", etc. Para conocer los valores válidos, consulta la documentación de BigQuery. Se usará para propagar google.cloud.bigquery.v2.QueryParameterType.type. |
LookerGoldenQuery
Es una consulta de referencia para Looker, que incluye preguntas en lenguaje natural y una consulta de Looker correspondiente. Es similar a ExampleQuery.
| Representación JSON |
|---|
{
"naturalLanguageQuestions": [
string
],
"lookerQuery": {
object ( |
| Campos | |
|---|---|
naturalLanguageQuestions[] |
Es opcional. Son preguntas en lenguaje natural que un usuario podría hacer. Por ejemplo: "¿Cuántos pedidos se hicieron el mes pasado?". |
lookerQuery |
Es opcional. Es la consulta de Looker que corresponde a las preguntas en lenguaje natural. |
LookerQuery
Documentación de la API de Looker sobre el objeto de consulta de Looker.
| Representación JSON |
|---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
| Campos | |
|---|---|
model |
Obligatorio. Es el modelo de LookML que se usó para generar la consulta. |
explore |
Obligatorio. Es la exploración de LookML que se usó para generar la consulta. |
fields[] |
Es opcional. Son los campos que se recuperarán de la exploración. |
filters[] |
Es opcional. Son los filtros que se aplicarán a la exploración. |
sorts[] |
Es opcional. Son los ordenamientos que se aplicarán a la exploración. |
limit |
Es opcional. Es el límite de la consulta. |
queryId |
Es opcional. Es el identificador principal del recurso de consulta en Looker, que se usa para las operaciones de la API. Se asigna a |
clientId |
Es opcional. Es el identificador alfanumérico corto de la consulta, que se usa para compartir vínculos y URLs de Explorar (p.ej., en el parámetro |
Filtro
Es un filtro de consulta de Looker.
| Representación JSON |
|---|
{ "field": string, "value": string } |
| Campos | |
|---|---|
field |
Obligatorio. Es el campo por el que se filtrará. |
value |
Es opcional. Es el valor del campo por el que se filtrará. Es opcional para que podamos conservar el valor predeterminado como una cadena vacía, lo que es importante para obtener una URL de exploración de Looker válida y que funcione. |
GlossaryTerm
Definición de un término dentro de un dominio específico.
| Representación JSON |
|---|
{ "displayName": string, "description": string, "labels": [ string ] } |
| Campos | |
|---|---|
displayName |
Obligatorio. Nombre visible fácil de usar del término del glosario que se define. Por ejemplo: "CTR", "porcentaje de conversiones", "pendiente" |
description |
Obligatorio. La descripción o el significado del término. Por ejemplo: "Tasa de clics", "El porcentaje de usuarios que completan una acción deseada", "Un pedido que está esperando ser procesado". |
labels[] |
Es opcional. Es una lista de etiquetas de uso general asociadas con este término. Por ejemplo: ["tasa de clics", "clics", "espera"] |
SchemaRelationship
Es la relación entre dos tablas, incluidas las columnas de referencia y las de referencia. Este es un contexto derivado que se recupera de las estadísticas de conjuntos de datos de Dataplex.
| Representación JSON |
|---|
{ "leftSchemaPaths": { object ( |
| Campos | |
|---|---|
leftSchemaPaths |
Es una lista ordenada de campos para la unión de la primera tabla. El tamaño de esta lista debe ser el mismo que el de |
rightSchemaPaths |
Es una lista ordenada de campos para la unión de la segunda tabla. El tamaño de esta lista debe ser el mismo que el de |
sources[] |
Es opcional. Son las fuentes que generaron el borde de la relación del esquema. |
confidenceScore |
Es opcional. Es una puntuación de confianza para la relación sugerida. Los bordes agregados de forma manual tienen la puntuación de confianza más alta. |
SchemaPaths
Representa un conjunto ordenado de rutas de acceso dentro del esquema de la tabla.
| Representación JSON |
|---|
{ "tableFqn": string, "paths": [ string ] } |
| Campos | |
|---|---|
tableFqn |
Es el nombre completo del recurso de la tabla calificado por el servicio. Por ejemplo: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID |
paths[] |
Es la lista ordenada de rutas de acceso dentro del esquema de la tabla. |
Fuente
Es la fuente que generó el borde de la relación del esquema.
| Enums | |
|---|---|
SOURCE_UNSPECIFIED |
No se especifica la fuente de la relación del esquema. |
BIGQUERY_JOB_HISTORY |
La fuente de la relación de esquemas es el historial de trabajos de BigQuery. |
LLM_SUGGESTED |
La fuente de la relación de esquema es sugerida por el LLM. |
BIGQUERY_TABLE_CONSTRAINTS |
La fuente de la relación de esquema son las restricciones de la tabla de BigQuery. |
UserFunctions
Es una colección de funciones de usuario que se incluirán en el contexto.
| Representación JSON |
|---|
{
"bqRoutines": [
{
object ( |
| Campos | |
|---|---|
bqRoutines[] |
Es una lista de rutinas de BigQuery que se incluirán en el contexto. |
BigQueryRoutine
Es una referencia a una rutina de BigQuery.
| Representación JSON |
|---|
{
"routineReference": {
object ( |
| Campos | |
|---|---|
routineReference |
Es la referencia a la rutina de BigQuery. |
description |
Anulación o adición del usuario a la descripción para indicarle al agente cuándo usar la UDF. |
BigQueryRoutineReference
Es una referencia a una rutina de BigQuery.
| Representación JSON |
|---|
{ "projectId": string, "datasetId": string, "routineId": string } |
| Campos | |
|---|---|
projectId |
Es el ID del proyecto de la rutina. |
datasetId |
Es el ID del conjunto de datos de la rutina. |
routineId |
Es el ID de la rutina. |
Métodos |
|
|---|---|
|
Crea un nuevo DataAgent en un proyecto y una ubicación determinados. |
|
Crea un nuevo DataAgent en un proyecto y una ubicación determinados de forma síncrona. |
|
Borra un solo DataAgent. |
|
Borra un solo DataAgent de forma síncrona. |
|
Obtiene detalles de un solo DataAgent. |
|
Obtiene la política de IAM para DataAgent |
|
Enumera los DataAgents en una ubicación y un proyecto determinados. |
|
Enumera los DataAgents a los que puede acceder el emisor en un proyecto y una ubicación determinados. |
|
Actualiza los parámetros de un solo DataAgent. |
|
Establece la política de IAM para un DataAgent. |
|
Actualiza los parámetros de un solo DataAgent de forma síncrona. |