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.
  "kmsKey": string
}
Campos
name

string

Es 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/global/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 reemplazará por {parent}/dataAgents/{dataAgentId}.
displayName

string

Es opcional. Es el nombre visible fácil de usar.

  • Debe tener entre 1 y 256 caracteres.
description

string

Es opcional. Es la descripción del agente.

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

map (key: string, value: string)

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 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 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: "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 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: "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 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: "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 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: "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)

Agente de análisis de datos.
kmsKey

string

Es opcional. Es la clave de encriptación administrada por el cliente (CMEK) que se usará para encriptar los recursos de DataAgent. Las claves criptográficas de Cloud KMS deben residir en la misma ubicación que el DataAgent. El formato esperado es projects/*/locations/*/keyRings/*/cryptoKeys/*.

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)

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

object (Context)

Es opcional. Es el contexto publicado del 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)
    }
  ],
  "lookerGoldenQueries": [
    {
      object (LookerGoldenQuery)
    }
  ],
  "glossaryTerms": [
    {
      object (GlossaryTerm)
    }
  ],
  "schemaRelationships": [
    {
      object (SchemaRelationship)
    }
  ],
  "userFunctions": {
    object (UserFunctions)
  }
}
Campos
systemInstruction

string

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 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)

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

object (ExampleQuery)

Es opcional. Es una lista de ejemplos de consultas que proporciona ejemplos de consultas en SQL relevantes y de uso frecuente, y sus correspondientes consultas en lenguaje natural (opcionalmente). Actualmente, solo se usa para las fuentes de datos y las bases de datos de BigQuery (fuentes de datos de AlloyDB, Cloud SQL y Spanner).
lookerGoldenQueries[]

object (LookerGoldenQuery)

Es opcional. Es una lista de búsquedas de referencia que proporciona ejemplos de búsquedas de Looker relevantes y de uso frecuente, y sus correspondientes búsquedas en lenguaje natural (opcional). Solo se admite para las fuentes de datos de Looker.
glossaryTerms[]

object (GlossaryTerm)

Es opcional. Definiciones de términos (actualmente, solo las creadas por el usuario): No se admiten para las fuentes de datos de bases de datos (AlloyDB, Cloud SQL, Spanner).
schemaRelationships[]

object (SchemaRelationship)

Es opcional. Relaciones entre el esquema de la tabla, incluidas las columnas de referencia y las columnas a las que se hace referencia
userFunctions

object (UserFunctions)

Es opcional. Es una colección de funciones del usuario que se incluirán en el contexto.

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)
  },
  "alloydb": {
    object (AlloyDbReference)
  },
  "spannerReference": {
    object (SpannerReference)
  },
  "cloudSqlReference": {
    object (CloudSqlReference)
  }
  // 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 parámetros 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.
alloydb

object (AlloyDbReference)

Es una referencia a una base de datos de AlloyDB. Solo se admite para el método QueryData.
spannerReference

object (SpannerReference)

Es una referencia a una base de datos de Spanner. Solo se admite para el método QueryData.
cloudSqlReference

object (CloudSqlReference)

Es una referencia a una base de datos de Cloud SQL. Solo se admite para el método QueryData.

BigQueryTableReferences

Es un mensaje que representa referencias a tablas de BigQuery y gráficos de propiedades. Se debe completar al menos uno de los campos tableReferences, propertyGraphReferences o searchScope.

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

object (BigQueryTableReference)

Es opcional. Son referencias a tablas de BigQuery.
propertyGraphReferences[]

object (BigQueryPropertyGraphReference)

Es opcional. Función de versión preliminar. Son referencias a los gráficos de propiedades de BigQuery. Nota: Las fuentes de datos deben usar exclusivamente tablas o gráficos de propiedades, no ambos. Cuando se usan gráficos de propiedades, se admite un máximo de una referencia de gráfico.

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)

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 (Field)
    }
  ],
  "description": string,
  "synonyms": [
    string
  ],
  "tags": [
    string
  ],
  "displayName": string,
  "filters": [
    {
      object (DataFilter)
    }
  ]
}
Campos
fields[]

object (Field)

Es opcional. Son los campos del esquema.
description

string

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

string

Es 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

Es 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

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

object (DataFilter)

Es 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

Es opcional. El nombre del campo
type

string

Es opcional. Es el tipo del campo.
description

string

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

string

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

string

Es 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

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

string

Es opcional. Field displayName (igual que la etiqueta en
subfields[]

object (Field)

Es opcional. Es una propiedad recursiva para estructuras de esquemas anidadas.
category

string

Es opcional. Categoría del campo, no obligatoria, actualmente solo útil para Looker.
valueFormat

string

Es 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 de la sintaxis de filtros: https://cloud.google.com/looker/docs/filter-expressions

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

string

Es opcional. Es el campo por el que se filtrará. Por ejemplo: ["event_date", "customer_id", "product_category"]
value

string

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

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 búsqueda en la exploración siempre aplicará este filtro de forma predeterminada. Actualmente, solo se usa para las fuentes de datos de Looker.

BigQueryPropertyGraphReference

Es un mensaje que representa una referencia a un solo gráfico de propiedades de BigQuery.

Representación JSON 
{
  "projectId": string,
  "datasetId": string,
  "propertyGraphId": string
}
Campos
projectId

string

Obligatorio. Es el proyecto al que pertenece el gráfico de propiedades.
datasetId

string

Obligatorio. Es el conjunto de datos al que pertenece el gráfico de propiedades.
propertyGraphId

string

Obligatorio. Es el ID del gráfico de propiedades.

StudioDatasourceReferences

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

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

object (StudioDatasourceReference)

Es opcional. 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
(deprecated)

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

Es 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 parámetros siguientes:
lookerInstanceUri

string

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

object (PrivateLookerInstanceInfo)

Es información privada de la instancia 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 puede ser solo uno de los parámetros siguientes:
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 parámetros siguientes:
secret

object (SecretBased)

Son credenciales de OAuth basadas en secretos.
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.

AlloyDbReference

Es un mensaje que representa una 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 (AlloyDbDatabaseReference)
  },
  "agentContextReference": {
    object (AgentContextReference)
  }
}
Campos
databaseReference

object (AlloyDbDatabaseReference)

Obligatorio. Es un arquetipo singular que admite la especificación de qué base de datos y tablas se deben incluir.
agentContextReference

object (AgentContextReference)

Es opcional. Son parámetros para recuperar datos del contexto del agente.

AlloyDbDatabaseReference

Es un 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 (DatabaseTableReference)
    }
  ]
}
Campos
projectId

string

Obligatorio. Es el proyecto al que pertenece la instancia.
region

string

Obligatorio. Es la región de la instancia.
clusterId

string

Obligatorio. Es el ID del clúster.
instanceId

string

Obligatorio. Es el ID de la instancia.
databaseId

string

Obligatorio. Es el ID de la base de datos.
tableIds[]

string

Es opcional. Son los IDs de las tablas. Si no se configura, denota todas las tablas.
databaseTableReferences[]

object (DatabaseTableReference)

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 a la consulta.

DatabaseTableReference

Mensaje que representa una tabla, incluido su esquema.

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

string

Obligatorio. Nombre de la tabla tal 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 que se almacena 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 la forma en que 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 se almacena. No agregues ningún carácter de comillas de identificador específico de la base de datos (p.ej., ", `, []).

Ejemplos: - Nombre simple: "orders", "UserActivity" - Sensible a mayúsculas y 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 llamador deben tener los permisos de base de datos necesarios para acceder al esquema y los datos de la tabla.
schema

object (Schema)

Es opcional. Es el esquema de la tabla.

AgentContextReference

Mensaje que representa una referencia al contexto del agente.

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

string

Obligatorio. Es el ID del conjunto de contextos que se recuperará.

SpannerReference

Es un mensaje que representa una 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 (SpannerDatabaseReference)
  },
  "agentContextReference": {
    object (AgentContextReference)
  }
}
Campos
databaseReference

object (SpannerDatabaseReference)

Obligatorio. Es un arquetipo singular que admite la especificación de qué base de datos y tablas se deben incluir.
agentContextReference

object (AgentContextReference)

Es opcional. Son parámetros para recuperar datos del contexto del agente.

SpannerDatabaseReference

Es un mensaje que representa una referencia a una sola base de datos de Spanner.

Representación JSON 
{
  "engine": enum (Engine),
  "projectId": string,
  "instanceId": string,
  "databaseId": string,
  "tableIds": [
    string
  ],
  "databaseTableReferences": [
    {
      object (DatabaseTableReference)
    }
  ],
  "priority": string,
  "requestTag": string
}
Campos
engine

enum (Engine)

Obligatorio. Es el motor de la instancia de Spanner.
projectId

string

Obligatorio. Es el proyecto al que pertenece la instancia.
instanceId

string

Obligatorio. Es el ID de la instancia.
databaseId

string

Obligatorio. Es el ID de la base de datos.
tableIds[]

string

Es opcional. Son los IDs de las tablas. Si no se configura, denota todas las tablas.
databaseTableReferences[]

object (DatabaseTableReference)

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 a la consulta.
priority

string

Es opcional. Prioridad de las consultas a Spanner. Debe ser un valor compatible con Cloud Spanner, p.ej.: BAJA, MEDIA y ALTA. 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

string

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.

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 una 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 (CloudSqlDatabaseReference)
  },
  "agentContextReference": {
    object (AgentContextReference)
  }
}
Campos
databaseReference

object (CloudSqlDatabaseReference)

Obligatorio. Es un arquetipo singular que admite la especificación de qué base de datos y tablas se deben incluir.
agentContextReference

object (AgentContextReference)

Es opcional. Son parámetros para recuperar datos del contexto del agente.

CloudSqlDatabaseReference

Es un mensaje que representa una referencia a una sola base de datos de Cloud SQL.

Representación JSON 
{
  "engine": enum (Engine),
  "projectId": string,
  "region": string,
  "instanceId": string,
  "databaseId": string,
  "tableIds": [
    string
  ],
  "databaseTableReferences": [
    {
      object (DatabaseTableReference)
    }
  ]
}
Campos
engine

enum (Engine)

Obligatorio. Es el motor de la instancia de Cloud SQL.
projectId

string

Obligatorio. Es el proyecto al que pertenece la instancia.
region

string

Obligatorio. Es la región de la instancia.
instanceId

string

Obligatorio. Es el ID de la instancia.
databaseId

string

Obligatorio. Es el ID de la base de datos.
tableIds[]

string

Es opcional. Son los IDs de las tablas. Si no se configura, denota todas las tablas.
databaseTableReferences[]

object (DatabaseTableReference)

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 a la consulta.

Motor

Es el motor de base de datos.

Enums
ENGINE_UNSPECIFIED No se especificó el motor.
POSTGRESQL PostgreSQL
MYSQL MySQL

ConversationOptions

Son las opciones de la conversación.

Representación JSON 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  },
  "datasource": {
    object (DatasourceOptions)
  },
  "model": enum (Model)
}
Campos
chart

object (ChartOptions)

Es opcional. Son las opciones para generar gráficos.
analysis

object (AnalysisOptions)

Es opcional. Son las opciones de análisis.
datasource

object (DatasourceOptions)

Es opcional. Son las opciones de las fuentes de datos.
model

enum (Model)

Es opcional. Es el modelo que se usará para el bucle del agente.

ChartOptions

Son las opciones para generar gráficos.

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

object (ImageOptions)

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 
{

  // 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. Tipo de imagen que se renderizará. kind puede ser solo uno de los parámetros 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)

Es 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

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

DatasourceOptions

Son opciones para configurar fuentes de datos.

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

string (Int64Value format)

Es opcional. Esta opción se aplica solo 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 establecer en la solicitud de chat o se usará el modelo predeterminado.
LATEST_GA_MODEL Usa el modelo que no sea de vista previa más actualizado. Esto puede restringir ciertos parámetros de configuración a nivel de la solicitud.

ExampleQuery

Ejemplo de una consulta en SQL pertinente y de uso frecuente, y sus correspondientes consultas en lenguaje natural que se pueden incluir de forma opcional. Actualmente, solo se usa para las fuentes de datos de BigQuery.

Representación JSON 
{
  "naturalLanguageQuestion": string,
  "parameters": [
    {
      object (QueryParameter)
    }
  ],

  // 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

Es opcional. Es una pregunta en lenguaje natural que podría hacer un usuario. Por ejemplo: "¿Cuántos pedidos se hicieron el mes pasado?"
parameters[]

object (QueryParameter)

Es opcional. Es la lista de parámetros de consulta. Ejemplo: La consulta en SQL con parámetros "SELECT * FROM my_table WHERE id = @id" puede coincidir con cualquier valor de id.
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 parámetros siguientes:
sqlQuery

string

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

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

string

Obligatorio. Es el nombre de la referencia del parámetro en la consulta en SQL.
description

string

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

string

Obligatorio. Tipo de datos del parámetro, p.ej., "STRING", "INT64", "DATE", etcétera. Para conocer los valores válidos, consulta la documentación de BigQuery. Se usará para completar 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 análogo a ExampleQuery.

Representación JSON 
{
  "naturalLanguageQuestions": [
    string
  ],
  "lookerQuery": {
    object (LookerQuery)
  }
}
Campos
naturalLanguageQuestions[]

string

Es opcional. Son preguntas en lenguaje natural que podría hacer un usuario. Por ejemplo: "¿Cuántos pedidos se hicieron el mes pasado?"
lookerQuery

object (LookerQuery)

Es opcional. Es la consulta de Looker que corresponde a las preguntas en lenguaje natural.

LookerQuery

Objeto de consulta de Looker Documentación de la API de Looker

Representación JSON 
{
  "model": string,
  "explore": string,
  "fields": [
    string
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "sorts": [
    string
  ],
  "limit": string,
  "queryId": string,
  "clientId": string
}
Campos
model

string

Obligatorio. Es el modelo de LookML que se usó para generar la consulta.
explore

string

Obligatorio. Es la exploración de LookML que se usó para generar la consulta.
fields[]

string

Es opcional. Son los campos que se recuperarán de la exploración.
filters[]

object (Filter)

Es opcional. Son los filtros que se aplicarán a la exploración.
sorts[]

string

Es opcional. Son los ordenamientos que se aplicarán a la exploración.
limit

string

Es opcional. Es el límite de la consulta.
queryId

string

Es opcional. Es el identificador principal del recurso de consulta en Looker, que se usa para las operaciones de la API. Se asigna a id (o slug) en el recurso Query de la API de Looker.
clientId

string

Es opcional. Es el identificador alfanumérico corto de la búsqueda, que se usa para los vínculos para compartir y las URLs de Explorar (p.ej., en el parámetro qid). Se asigna a clientId en el recurso Query de la API de Looker.

Filtro

Es un filtro de consulta de Looker.

Representación JSON 
{
  "field": string,
  "value": string
}
Campos
field

string

Obligatorio. Es el campo por el que se filtrará.
value

string

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 Explorar de Looker válida y en funcionamiento.

GlossaryTerm

Es la definición de un término dentro de un dominio específico.

Representación JSON 
{
  "displayName": string,
  "description": string,
  "labels": [
    string
  ]
}
Campos
displayName

string

Obligatorio. Nombre visible fácil de usar del término del glosario que se define. Por ejemplo, "CTR", "porcentaje de conversiones", "pendiente".
description

string

Obligatorio. Es la descripción o el significado del término. Por ejemplo: "Porcentaje de clics", "El porcentaje de usuarios que completan una acción deseada", "Un pedido que está en espera de ser procesado".
labels[]

string

Es opcional. Es una lista de etiquetas de uso general asociadas a este término. Por ejemplo: ["tasa de clics", "clic de redireccionamiento", "espera"]

SchemaRelationship

Es la relación entre dos tablas, incluidas las columnas de referencia y las columnas a las que se hace referencia. Es un contexto derivado que se recupera de Dataplex Dataset Insights.

Representación JSON 
{
  "leftSchemaPaths": {
    object (SchemaPaths)
  },
  "rightSchemaPaths": {
    object (SchemaPaths)
  },
  "sources": [
    enum (Source)
  ],
  "confidenceScore": number
}
Campos
leftSchemaPaths

object (SchemaPaths)

Es una lista ordenada de los campos de la unión de la primera tabla. El tamaño de esta lista debe ser el mismo que el de rightSchemaPaths. Cada campo en el índice i de esta lista debe corresponder a un campo en el mismo índice de la lista rightSchemaPaths.
rightSchemaPaths

object (SchemaPaths)

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 leftSchemaPaths. Cada campo en el índice i de esta lista debe corresponder a un campo en el mismo índice de la lista leftSchemaPaths.
sources[]

enum (Source)

Es opcional. Son las fuentes que generaron la arista de relación del esquema.
confidenceScore

number

Es opcional. Es una puntuación de confianza para la relación sugerida. Las aristas agregadas manualmente 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

string

Nombre completo del recurso de la tabla calificado por el servicio. P. ej., bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
paths[]

string

Lista ordenada de rutas de acceso dentro del esquema de la tabla.

Fuente

Es la fuente que generó la arista de 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 del esquema es el historial de trabajos de BigQuery.
LLM_SUGGESTED La fuente de la relación del esquema es sugerida por el LLM.
BIGQUERY_TABLE_CONSTRAINTS La fuente de la relación del esquema son las restricciones de la tabla de BigQuery.

UserFunctions

Es una colección de funciones del usuario que se incluirán en el contexto.

Representación JSON 
{
  "bqRoutines": [
    {
      object (BigQueryRoutine)
    }
  ]
}
Campos
bqRoutines[]

object (BigQueryRoutine)

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 (BigQueryRoutineReference)
  },
  "description": string
}
Campos
routineReference

object (BigQueryRoutineReference)

Es la referencia a la rutina de BigQuery.
description

string

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

string

Es el ID del proyecto de la rutina.
datasetId

string

Es el ID del conjunto de datos de la rutina.
routineId

string

Es el ID de la rutina.

Métodos

create

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

createSync

 Crea un nuevo DataAgent en un proyecto y una ubicación determinados de forma síncrona.

delete

 Borra un solo DataAgent.

deleteSync

 Borra un solo DataAgent de forma síncrona.

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.

updateSync

 Actualiza los parámetros de un solo DataAgent de forma síncrona.