- Representación JSON
- UserMessage
- SystemMessage
- TextMessage
- SchemaMessage
- SchemaQuery
- SchemaResult
- Fuente de datos
- DataMessage
- DataQuery
- DataResult
- LookerQuery
- Filtrar
- BigQueryJob
- AnalysisMessage
- AnalysisQuery
- AnalysisEvent
- ChartMessage
- ChartQuery
- ChartResult
- Blob
- ErrorMessage
Un mensaje de una interacción entre el usuario y el sistema.
Representación JSON |
---|
{ "timestamp": string, "messageId": string, // Union field |
Campos | |
---|---|
timestamp |
Solo de salida. En el caso de los mensajes de usuario, es la hora a la que el sistema recibió el mensaje. En el caso de los mensajes del sistema, es la hora a la que el sistema generó el mensaje. Usa RFC 3339, donde la salida generada siempre se normalizará con Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: |
messageId |
Opcional. ID único del mensaje en la conversación para la persistencia. |
Campo de unión kind . El tipo de mensaje. kind solo puede ser una de las siguientes cosas: |
|
userMessage |
Un mensaje del usuario que interactúa con el sistema. |
systemMessage |
Un mensaje del sistema en respuesta al usuario. |
UserMessage
Un mensaje del usuario que interactúa con el sistema.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión kind . El tipo de contenido del mensaje del usuario. kind solo puede ser una de las siguientes cosas: |
|
text |
El texto debe usar este campo en lugar de blob. |
SystemMessage
Un mensaje del sistema en respuesta al usuario. Este mensaje también puede ser un mensaje del usuario como contexto histórico para las conversaciones de varios turnos con el sistema.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión kind . El tipo de contenido del mensaje del sistema. kind solo puede ser una de las siguientes cosas: |
|
text |
Una respuesta directa en lenguaje natural al mensaje del usuario. |
schema |
Mensaje generado durante la resolución del esquema. |
data |
Mensaje generado durante la recuperación de datos. |
analysis |
Mensaje generado durante el análisis. |
chart |
Mensaje generado durante la creación del gráfico. |
error |
Un mensaje de error. |
groupId |
Identifica el grupo al que pertenece el evento. Se considera que los eventos similares son lógicamente relevantes entre sí y deben mostrarse juntos en la interfaz de usuario. |
TextMessage
Un mensaje de texto de varias partes.
Representación JSON |
---|
{ "parts": [ string ] } |
Campos | |
---|---|
parts[] |
Opcional. Las partes del mensaje. |
SchemaMessage
Mensaje generado durante la resolución del esquema.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión kind . Si este mensaje contiene la consulta o el resultado de la resolución del esquema. kind solo puede ser una de las siguientes cosas: |
|
query |
Una consulta de resolución de esquemas. |
result |
El resultado de una consulta de resolución de esquemas. |
SchemaQuery
Consulta para resolver el esquema pertinente a la pregunta planteada.
Representación JSON |
---|
{ "question": string } |
Campos | |
---|---|
question |
Opcional. La pregunta que se enviará al sistema para resolver el esquema. |
SchemaResult
El resultado de la resolución del esquema.
Representación JSON |
---|
{
"datasources": [
{
object ( |
Campos | |
---|---|
datasources[] |
Opcional. Las fuentes de datos que se usan para resolver la consulta de esquema. |
Fuente de datos
Una fuente de datos que se puede usar para responder a preguntas.
Representación JSON |
---|
{ "schema": { object ( |
Campos | |
---|---|
schema |
Opcional. El esquema de la fuente de datos. |
Campo de unión reference . Referencia a la fuente de datos. reference solo puede ser una de las siguientes cosas: |
|
bigqueryTableReference |
Referencia a una tabla de BigQuery. |
studioDatasourceId |
Referencia a una fuente de datos de Looker Studio. |
lookerExploreReference |
Referencia a una Exploración de Looker. |
DataMessage
Mensaje generado durante la recuperación de datos.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión kind . Si este mensaje contiene la consulta, el resultado o el código SQL generado para la recuperación de datos. kind solo puede ser una de las siguientes cosas: |
|
query |
Una consulta de recuperación de datos. |
generatedSql |
SQL generado por el sistema para obtener datos. |
result |
Datos recuperados. |
generatedLookerQuery |
Consulta de Looker generada por el sistema para obtener datos. |
bigQueryJob |
Una tarea de BigQuery ejecutada por el sistema para recuperar datos. |
DataQuery
Una consulta para obtener datos.
Representación JSON |
---|
{
"question": string,
"name": string,
"datasources": [
{
object ( |
Campos | |
---|---|
question |
Opcional. Una pregunta en lenguaje natural que responder. |
name |
Opcional. Nombre en formato snake_case de la consulta que refleje su intención. Se usa para asignar un nombre al resultado de datos correspondiente, de modo que se pueda hacer referencia a él en pasos posteriores.
|
datasources[] |
Opcional. Las fuentes de datos disponibles para responder a la pregunta. |
DataResult
Datos recuperados.
Representación JSON |
---|
{
"name": string,
"schema": {
object ( |
Campos | |
---|---|
name |
Opcional. Nombre en formato snake_case del resultado de datos que refleja su contenido. El nombre se usa para transferir el resultado por referencia y sirve como señal sobre su significado.
|
schema |
Opcional. El esquema de los datos. |
data[] |
Opcional. El contenido de los datos. Cada fila es una estructura que coincide con el esquema. Los valores simples se representan como cadenas, mientras que las estructuras anidadas se representan como listas o structs. |
LookerQuery
Consulta para obtener datos de una Exploración de Looker. Consulta Ejecutar consulta insertada.
Representación JSON |
---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
Campos | |
---|---|
model |
Obligatorio. El modelo de LookML usado para generar la consulta. |
explore |
Obligatorio. El Explore de LookML usado para generar la consulta. |
fields[] |
Opcional. Los campos que se van a obtener de la exploración. |
filters[] |
Opcional. Los filtros que se aplican a la exploración. |
sorts[] |
Opcional. Los tipos de ordenación que se aplicarán a la exploración. |
limit |
Opcional. Límite de la consulta. |
Filtro
Un filtro de consulta de Looker.
Representación JSON |
---|
{ "field": string, "value": string } |
Campos | |
---|---|
field |
Obligatorio. El campo por el que se va a filtrar. |
value |
Obligatorio. El campo de valor por el que filtrar. |
BigQueryJob
Un trabajo de BigQuery ejecutado por el sistema.
Representación JSON |
---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
Campos | |
---|---|
projectId |
Obligatorio. Proyecto al que pertenece el trabajo. Consulta JobReference. |
jobId |
Obligatorio. Es el ID del trabajo. Consulta JobReference. |
location |
Opcional. La ubicación del trabajo. Consulta JobReference. |
destinationTable |
Opcional. Referencia a la tabla de destino de los resultados de la consulta de la tarea. Consulta JobConfigurationQuery. |
schema |
Opcional. Esquema de los resultados de la consulta de la tarea. Consulta JobStatistics2. |
AnalysisMessage
Mensaje generado durante el análisis.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión kind . Indica si este mensaje contiene la consulta o uno de los eventos del análisis. kind solo puede ser una de las siguientes cosas: |
|
query |
Una consulta de análisis. |
progressEvent |
Evento que indica el progreso del análisis. |
AnalysisQuery
Consulta para realizar un análisis.
Representación JSON |
---|
{ "question": string, "dataResultNames": [ string ] } |
Campos | |
---|---|
question |
Opcional. Una pregunta de análisis para ayudar a responder a la pregunta original del usuario. |
dataResultNames[] |
Opcional. Los nombres de los resultados de datos obtenidos anteriormente que se van a analizar. |
AnalysisEvent
Evento que indica el progreso de un análisis.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión kind . El tipo de evento que se ha producido durante el análisis. kind solo puede ser una de las siguientes cosas: |
|
plannerReasoning |
Razonamiento del planificador de generación de código de Python. |
coderInstruction |
Se han emitido instrucciones para generar código. |
code |
Código generado. |
executionOutput |
Salida de la ejecución del código. |
executionError |
Error de ejecución de código. |
resultVegaChartJson |
Resultado como cadena JSON de gráfico de Vega. |
resultNaturalLanguage |
Resultado como cadena de lenguaje natural. |
resultCsvData |
Resultado como cadena CSV. |
resultReferenceData |
Resultado como referencia a una fuente de datos. |
error |
Un mensaje de error genérico. |
ChartMessage
Mensaje generado durante la creación del gráfico.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión kind . Indica si este mensaje contiene la consulta o el resultado de la generación del gráfico. kind solo puede ser una de las siguientes cosas: |
|
query |
Una consulta para generar un gráfico. |
result |
El resultado de una consulta de generación de gráficos. |
ChartQuery
Una consulta para generar un gráfico.
Representación JSON |
---|
{ "instructions": string, "dataResultName": string } |
Campos | |
---|---|
instructions |
Opcional. Instrucciones en lenguaje natural para generar el gráfico. |
dataResultName |
Opcional. Nombre de un resultado de datos obtenido anteriormente que se va a usar en el gráfico. |
ChartResult
El resultado de una consulta de generación de gráficos.
Representación JSON |
---|
{
"vegaConfig": {
object
},
"image": {
object ( |
Campos | |
---|---|
vegaConfig |
Opcional. Configuración de un gráfico Vega generado. Consulta https://vega.github.io/vega/docs/config/. |
image |
Opcional. Una representación del gráfico, si se ha solicitado en el contexto. |
Blob
Un blob de datos con un tipo MIME.
Representación JSON |
---|
{ "mimeType": string, "data": string } |
Campos | |
---|---|
mimeType |
Obligatorio. Tipo MIME estándar de IANA de los datos del mensaje. |
data |
Obligatorio. Los datos representados como bytes. Cadena codificada en base64. |
ErrorMessage
Un mensaje de error.
Representación JSON |
---|
{ "text": string } |
Campos | |
---|---|
text |
Solo de salida. El texto del error. |