Message

Es un mensaje de una interacción entre el usuario y el sistema.

Representación JSON
{
  "timestamp": string,
  "messageId": string,

  // Union field kind can be only one of the following:
  "userMessage": {
    object (UserMessage)
  },
  "systemMessage": {
    object (SystemMessage)
  }
  // End of list of possible types for union field kind.
}
Campos
timestamp

string (Timestamp format)

Solo salida. En el caso de los mensajes del usuario, es la hora en la que el sistema recibió el mensaje. En el caso de los mensajes del sistema, esta es la hora en la que el sistema generó el mensaje.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z, y usa 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".

messageId

string

Opcional. Es el ID único del mensaje en la conversación para conservarla.

Campo de unión kind. Es el tipo de mensaje. kind puede ser solo uno de los siguientes:
userMessage

object (UserMessage)

Es un mensaje del usuario que interactúa con el sistema.

systemMessage

object (SystemMessage)

Es un mensaje del sistema en respuesta al usuario.

UserMessage

Es un mensaje del usuario que interactúa con el sistema.

Representación JSON
{

  // Union field kind can be only one of the following:
  "text": string
  // End of list of possible types for union field kind.
}
Campos
Campo de unión kind. Es el tipo de contenido del mensaje del usuario. kind puede ser solo uno de los siguientes:
text

string

El texto debe usar este campo en lugar de BLOB.

SystemMessage

Es 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 kind can be only one of the following:
  "text": {
    object (TextMessage)
  },
  "schema": {
    object (SchemaMessage)
  },
  "data": {
    object (DataMessage)
  },
  "analysis": {
    object (AnalysisMessage)
  },
  "chart": {
    object (ChartMessage)
  },
  "error": {
    object (ErrorMessage)
  }
  // End of list of possible types for union field kind.
  "groupId": integer
}
Campos
Campo de unión kind. Es el tipo de contenido del mensaje del sistema. kind puede ser solo uno de los siguientes:
text

object (TextMessage)

Es una respuesta directa en lenguaje natural al mensaje del usuario.

schema

object (SchemaMessage)

Es un mensaje que se produce durante la resolución del esquema.

data

object (DataMessage)

Es un mensaje que se produce durante la recuperación de datos.

analysis

object (AnalysisMessage)

Es un mensaje que se produce durante el análisis.

chart

object (ChartMessage)

Es un mensaje que se produce durante la generación del gráfico.

error

object (ErrorMessage)

Es un mensaje de error.

groupId

integer

Identifica el grupo al que pertenece el evento. Se considera que los eventos similares son lógicamente pertinentes entre sí y deben mostrarse juntos en la IU.

TextMessage

Es un mensaje de texto de varias partes.

Representación JSON
{
  "parts": [
    string
  ]
}
Campos
parts[]

string

Opcional. Son las partes del mensaje.

SchemaMessage

Es un mensaje que se produce durante la resolución del esquema.

Representación JSON
{

  // Union field kind can be only one of the following:
  "query": {
    object (SchemaQuery)
  },
  "result": {
    object (SchemaResult)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de unión kind. Indica si este mensaje contiene la consulta o el resultado de la resolución del esquema. kind puede ser solo uno de los siguientes:
query

object (SchemaQuery)

Es una consulta de resolución de esquema.

result

object (SchemaResult)

Es el resultado de una consulta de resolución de esquema.

SchemaQuery

Es una consulta para resolver el esquema pertinente a la pregunta planteada.

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

string

Opcional. Es la pregunta que se enviará al sistema para la resolución del esquema.

SchemaResult

Es el resultado de la resolución del esquema.

Representación JSON
{
  "datasources": [
    {
      object (Datasource)
    }
  ]
}
Campos
datasources[]

object (Datasource)

Opcional. Son las fuentes de datos que se usan para resolver la consulta de esquema.

Datasource

Es una fuente de datos que se puede usar para responder preguntas.

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

  // Union field reference can be only one of the following:
  "bigqueryTableReference": {
    object (BigQueryTableReference)
  },
  "studioDatasourceId": string,
  "lookerExploreReference": {
    object (LookerExploreReference)
  }
  // End of list of possible types for union field reference.
}
Campos
schema

object (Schema)

Opcional. Es el esquema de la fuente de datos.

Campo de unión reference. Es la referencia a la fuente de datos. reference puede ser solo uno de los siguientes:
bigqueryTableReference

object (BigQueryTableReference)

Es una referencia a una tabla de BigQuery.

studioDatasourceId

string

Es una referencia a una fuente de datos de Looker Studio.

lookerExploreReference

object (LookerExploreReference)

Es una referencia a una exploración de Looker.

DataMessage

Es un mensaje que se produce durante la recuperación de datos.

Representación JSON
{

  // Union field kind can be only one of the following:
  "query": {
    object (DataQuery)
  },
  "generatedSql": string,
  "result": {
    object (DataResult)
  },
  "generatedLookerQuery": {
    object (LookerQuery)
  },
  "bigQueryJob": {
    object (BigQueryJob)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de unión kind. Indica si este mensaje contiene la consulta, el resultado o el SQL generado para la recuperación de datos. kind puede ser solo uno de los siguientes:
query

object (DataQuery)

Es una consulta de recuperación de datos.

generatedSql

string

Es el código SQL que genera el sistema para recuperar datos.

result

object (DataResult)

Son datos recuperados.

generatedLookerQuery

object (LookerQuery)

Es la consulta de Looker que genera el sistema para recuperar datos.

bigQueryJob

object (BigQueryJob)

Es un trabajo de BigQuery que ejecuta el sistema para recuperar datos.

DataQuery

Es una consulta para recuperar datos.

Representación JSON
{
  "question": string,
  "name": string,
  "datasources": [
    {
      object (Datasource)
    }
  ]
}
Campos
question

string

Opcional. Es una pregunta en lenguaje natural que se debe responder.

name

string

Opcional. Nombre en minúsculas con guiones bajos para la consulta que refleja su intención. Se usa para nombrar el resultado de datos correspondiente, de modo que se pueda hacer referencia a él en pasos posteriores.

  • Ejemplo: "total_sales_by_product"
  • Ejemplo: "sales_for_product_12345"
datasources[]

object (Datasource)

Opcional. Son las fuentes de datos disponibles para responder la pregunta.

DataResult

Son datos recuperados.

Representación JSON
{
  "name": string,
  "schema": {
    object (Schema)
  },
  "data": [
    {
      object
    }
  ]
}
Campos
name

string

Opcional. Es un nombre en minúsculas con guiones bajos para el resultado de datos que refleja su contenido. El nombre se usa para pasar el resultado por referencia y sirve como indicador de su significado.

  • Ejemplo: "total_sales_by_product"
  • Ejemplo: "sales_for_product_12345"
schema

object (Schema)

Opcional. Es el esquema de los datos.

data[]

object (Struct format)

Opcional. Es el contenido de los datos. Cada fila es una struct que coincide con el esquema. Los valores simples se representan como cadenas, mientras que las estructuras anidadas se representan como listas o structs.

LookerQuery

Es una consulta para recuperar datos de una exploración de Looker. Consulta Cómo ejecutar una consulta intercalada.

Representación JSON
{
  "model": string,
  "explore": string,
  "fields": [
    string
  ],
  "filters": [
    {
      object (Filter)
    }
  ],
  "sorts": [
    string
  ],
  "limit": 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

Opcional. Son los campos que se recuperarán de la exploración.

filters[]

object (Filter)

Opcional. Son los filtros que se aplicarán a la exploración.

sorts[]

string

Opcional. Son los ordenamientos que se aplicarán a la exploración.

limit

string

Opcional. Es el límite de la consulta.

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

Obligatorio. Es el campo de valor f por el que se filtrará.

BigQueryJob

Es un trabajo de BigQuery que ejecuta el sistema.

Representación JSON
{
  "projectId": string,
  "jobId": string,
  "location": string,
  "destinationTable": {
    object (BigQueryTableReference)
  },
  "schema": {
    object (Schema)
  }
}
Campos
projectId

string

Obligatorio. Es el proyecto al que pertenece el trabajo.

Consulta JobReference.

jobId

string

Obligatorio. Es el ID del trabajo.

Consulta JobReference.

location

string

Opcional. Es la ubicación del trabajo.

Consulta JobReference.

destinationTable

object (BigQueryTableReference)

Opcional. Es una referencia a la tabla de destino de los resultados de la consulta del trabajo.

Consulta JobConfigurationQuery.

schema

object (Schema)

Opcional. Es el esquema de los resultados de la consulta del trabajo.

Consulta JobStatistics2.

AnalysisMessage

Es un mensaje que se produce durante el análisis.

Representación JSON
{

  // Union field kind can be only one of the following:
  "query": {
    object (AnalysisQuery)
  },
  "progressEvent": {
    object (AnalysisEvent)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de unión kind. Indica si este mensaje contiene la búsqueda o uno de los eventos del análisis. kind puede ser solo uno de los siguientes:
query

object (AnalysisQuery)

Es una consulta de análisis.

progressEvent

object (AnalysisEvent)

Es un evento que indica el progreso del análisis.

AnalysisQuery

Es una consulta para realizar un análisis.

Representación JSON
{
  "question": string,
  "dataResultNames": [
    string
  ]
}
Campos
question

string

Opcional. Es una pregunta de análisis que ayuda a responder la pregunta original del usuario.

dataResultNames[]

string

Opcional. Son los nombres de los resultados de datos recuperados anteriormente que se usarán para el análisis.

AnalysisEvent

Es un evento que indica el progreso de un análisis.

Representación JSON
{

  // Union field kind can be only one of the following:
  "plannerReasoning": string,
  "coderInstruction": string,
  "code": string,
  "executionOutput": string,
  "executionError": string,
  "resultVegaChartJson": string,
  "resultNaturalLanguage": string,
  "resultCsvData": string,
  "resultReferenceData": string,
  "error": string
  // End of list of possible types for union field kind.
}
Campos
Campo de unión kind. Es el tipo de evento que ocurrió durante el análisis. kind puede ser solo uno de los siguientes:
plannerReasoning

string

Es el razonamiento del planificador para la generación de código de Python.

coderInstruction

string

Son las instrucciones que se emiten para la generación de código.

code

string

Es el código generado.

executionOutput

string

Es el resultado de la ejecución del código.

executionError

string

Es un error de la ejecución del código.

resultVegaChartJson

string

Es el resultado como cadena JSON del gráfico de Vega.

resultNaturalLanguage

string

Es el resultado como una cadena NL.

resultCsvData

string

Es el resultado como una cadena CSV.

resultReferenceData

string

Es el resultado como referencia a una fuente de datos.

error

string

Es un mensaje de error genérico.

ChartMessage

Es un mensaje que se produce durante la generación del gráfico.

Representación JSON
{

  // Union field kind can be only one of the following:
  "query": {
    object (ChartQuery)
  },
  "result": {
    object (ChartResult)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de unión kind. Indica si este mensaje contiene la consulta o el resultado de la generación del gráfico. kind puede ser solo uno de los siguientes:
query

object (ChartQuery)

Es una consulta para generar un gráfico.

result

object (ChartResult)

Es el resultado de una consulta de generación de gráficos.

ChartQuery

Es una consulta para generar un gráfico.

Representación JSON
{
  "instructions": string,
  "dataResultName": string
}
Campos
instructions

string

Opcional. Son las instrucciones en lenguaje natural para generar el gráfico.

dataResultName

string

Opcional. Es el nombre de un resultado de datos recuperado previamente para usar en el gráfico.

ChartResult

Es el resultado de una consulta de generación de gráficos.

Representación JSON
{
  "vegaConfig": {
    object
  },
  "image": {
    object (Blob)
  }
}
Campos
vegaConfig

object (Struct format)

Opcional. Es un parámetro de configuración del gráfico generado de Vega. Consulta https://vega.github.io/vega/docs/config/

image

object (Blob)

Opcional. Es una renderización del gráfico si se solicitó en el contexto.

BLOB

Es un BLOB de datos con un tipo de MIME.

Representación JSON
{
  "mimeType": string,
  "data": string
}
Campos
mimeType

string

Obligatorio. Es el tipo de MIME estándar de IANA de los datos del mensaje.

data

string (bytes format)

Obligatorio. Son los datos representados como bytes.

Es una cadena codificada en base64.

ErrorMessage

Es un mensaje de error.

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

string

Solo salida. Es el texto del error.