Message

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 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 normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
messageId

string

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 estas dos opciones:
userMessage

object (UserMessage)

Un mensaje del usuario que interactúa con el sistema.
systemMessage

object (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 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. El tipo de contenido del mensaje del usuario. kind solo puede ser una de estas dos opciones:
text

string

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 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)
  },
  "exampleQueries": {
    object (ExampleQueries)
  }
  // End of list of possible types for union field kind.
  "groupId": integer
}
Campos
Campo de unión kind. El tipo de contenido del mensaje del sistema. kind solo puede ser una de estas dos opciones:
text

object (TextMessage)

Una respuesta directa en lenguaje natural al mensaje del usuario.
schema

object (SchemaMessage)

Mensaje generado durante la resolución del esquema.
data

object (DataMessage)

Mensaje generado durante la recuperación de datos.
analysis

object (AnalysisMessage)

Mensaje generado durante el análisis.
chart

object (ChartMessage)

Mensaje generado durante la creación del gráfico.
error

object (ErrorMessage)

Un mensaje de error.
exampleQueries

object (ExampleQueries)

Opcional. Un mensaje que contiene consultas de ejemplo.
groupId

integer

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
  ],
  "textType": enum (TextType)
}
Campos
parts[]

string

Opcional. Las partes del mensaje.
textType

enum (TextType)

Opcional. El tipo de mensaje de texto.

TextType

El tipo de mensaje de texto.

Enumeraciones
TEXT_TYPE_UNSPECIFIED El tipo de texto predeterminado.
FINAL_RESPONSE El texto es la respuesta final a la pregunta del usuario.
THOUGHT El texto es un plan de razonamiento generado por la herramienta de razonamiento.

SchemaMessage

Mensaje generado 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. Si este mensaje contiene la consulta o el resultado de la resolución del esquema. kind solo puede ser una de estas dos opciones:
query

object (SchemaQuery)

Una consulta de resolución de esquemas.
result

object (SchemaResult)

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

string

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 (Datasource)
    }
  ]
}
Campos
datasources[]

object (Datasource)

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 (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. El esquema de la fuente de datos.
Campo de unión reference. Referencia a la fuente de datos. reference solo puede ser una de estas dos opciones:
bigqueryTableReference

object (BigQueryTableReference)

Referencia a una tabla de BigQuery.
studioDatasourceId

string

Referencia a una fuente de datos de Looker Studio.
lookerExploreReference

object (LookerExploreReference)

Referencia a una Exploración de Looker.

DataMessage

Mensaje generado 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. 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 estas dos opciones:
query

object (DataQuery)

Una consulta de recuperación de datos.
generatedSql

string

SQL generado por el sistema para obtener datos.
result

object (DataResult)

Datos recuperados.
generatedLookerQuery
(deprecated)

object (LookerQuery)

Consulta de Looker generada por el sistema para obtener datos. OBSOLETO: la consulta de Looker generada ahora se encuentra en DataQuery.looker.
bigQueryJob

object (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 (Datasource)
    }
  ],

  // Union field query_type can be only one of the following:
  "looker": {
    object (LookerQuery)
  }
  // End of list of possible types for union field query_type.
}
Campos
question

string

Opcional. Una pregunta en lenguaje natural que responder.
name

string

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.

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

object (Datasource)

Opcional. Las fuentes de datos disponibles para responder a la pregunta.
Campo de unión query_type. Tipo de consulta que se va a ejecutar. query_type solo puede ser una de estas dos opciones:
looker

object (LookerQuery)

Opcional. Consulta para obtener datos de una exploración de Looker.

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 (Filter)
    }
  ],
  "sorts": [
    string
  ],
  "limit": string
}
Campos
model

string

Obligatorio. El modelo de LookML usado para generar la consulta.
explore

string

Obligatorio. El Explore de LookML usado para generar la consulta.
fields[]

string

Opcional. Campos que se van a obtener de la exploración.
filters[]

object (Filter)

Opcional. Los filtros que se aplican al Explorador.
sorts[]

string

Opcional. Los tipos de orden que se aplican a la exploración.
limit

string

Opcional. Límite de la consulta.

Filtro

Un filtro de consulta de Looker.

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

string

Obligatorio. El campo por el que se va a filtrar.
value

string

Obligatorio. El campo de valor por el que filtrar.

DataResult

Datos recuperados.

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

string

Opcional. Nombre en formato snake_case del resultado de los datos que refleje su contenido. El nombre se usa para transferir el resultado por referencia y sirve como señal sobre su significado.

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

object (Schema)

Opcional. El esquema de los datos.
data[]

object (Struct format)

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.

BigQueryJob

Un trabajo de BigQuery ejecutado por el sistema.

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

string

Obligatorio. Proyecto al que pertenece el trabajo.

Consulta JobReference.
jobId

string

Obligatorio. Es el ID del trabajo.

Consulta JobReference.
location

string

Opcional. La ubicación del trabajo.

Consulta JobReference.
destinationTable

object (BigQueryTableReference)

Opcional. Referencia a la tabla de destino de los resultados de la consulta de la tarea.

Consulta JobConfigurationQuery.
schema

object (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 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 consulta o uno de los eventos del análisis. kind solo puede ser una de estas dos opciones:
query

object (AnalysisQuery)

Una consulta de análisis.
progressEvent

object (AnalysisEvent)

Evento que indica el progreso del análisis.

AnalysisQuery

Consulta para realizar un análisis.

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

string

Opcional. Una pregunta de análisis para ayudar a responder a la pregunta original del usuario.
dataResultNames[]

string

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 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. El tipo de evento que se ha producido durante el análisis. kind solo puede ser una de estas dos opciones:
plannerReasoning

string

Razonamiento del planificador de generación de código de Python.
coderInstruction

string

Se han emitido instrucciones para generar código.
code

string

Código generado.
executionOutput

string

Salida de la ejecución del código.
executionError

string

Error de ejecución de código.
resultVegaChartJson

string

Resultado como cadena JSON de gráfico de Vega.
resultNaturalLanguage

string

Resultado como cadena de lenguaje natural.
resultCsvData

string

Resultado como cadena CSV.
resultReferenceData

string

El resultado como referencia a una fuente de datos.
error

string

Un mensaje de error genérico.

ChartMessage

Mensaje generado durante la creació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 solo puede ser una de estas dos opciones:
query

object (ChartQuery)

Una consulta para generar un gráfico.
result

object (ChartResult)

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

string

Opcional. Instrucciones en lenguaje natural para generar el gráfico.
dataResultName

string

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 (Blob)
  }
}
Campos
vegaConfig

object (Struct format)

Opcional. Configuración de un gráfico Vega generado. Consulta https://vega.github.io/vega/docs/config/.
image

object (Blob)

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

string

Obligatorio. Tipo MIME estándar de IANA de los datos del mensaje.
data

string (bytes format)

Obligatorio. Los datos representados como bytes.

Cadena codificada en base64.

ErrorMessage

Un mensaje de error.

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

string

Solo de salida. El texto del error.

ExampleQueries

Mensaje que contiene consultas de ejemplo derivadas y creadas.

Representación JSON 
{
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Campos
exampleQueries[]

object (ExampleQuery)

Opcional. Una lista de consultas de ejemplo derivadas y creadas, con ejemplos de consultas de SQL relevantes y de uso habitual, así como sus correspondientes consultas en lenguaje natural (opcional). Actualmente solo se usa para las fuentes de datos de BigQuery.