- Representación JSON
- UserMessage
- SystemMessage
- TextMessage
- SchemaMessage
- SchemaQuery
- SchemaResult
- Datasource
- DataMessage
- DataQuery
- DataResult
- LookerQuery
- Filtro
- BigQueryJob
- AnalysisMessage
- AnalysisQuery
- AnalysisEvent
- ChartMessage
- ChartQuery
- ChartResult
- BLOB
- ErrorMessage
Es un mensaje de una interacción entre el usuario y el sistema.
Representación JSON |
---|
{ "timestamp": string, "messageId": string, // Union field |
Campos | |
---|---|
timestamp |
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: |
messageId |
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 |
Es un mensaje del usuario que interactúa con el sistema. |
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 |
Campos | |
---|---|
Campo de unión kind . Es el tipo de contenido del mensaje del usuario. kind puede ser solo uno de los siguientes: |
|
text |
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 |
Campos | |
---|---|
Campo de unión kind . Es el tipo de contenido del mensaje del sistema. kind puede ser solo uno de los siguientes: |
|
text |
Es una respuesta directa en lenguaje natural al mensaje del usuario. |
schema |
Es un mensaje que se produce durante la resolución del esquema. |
data |
Es un mensaje que se produce durante la recuperación de datos. |
analysis |
Es un mensaje que se produce durante el análisis. |
chart |
Es un mensaje que se produce durante la generación del gráfico. |
error |
Es un mensaje de error. |
groupId |
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[] |
Opcional. Son las partes del mensaje. |
SchemaMessage
Es un mensaje que se produce durante la resolución del esquema.
Representación JSON |
---|
{ // Union field |
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 |
Es una consulta de resolución de esquema. |
result |
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 |
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 ( |
Campos | |
---|---|
datasources[] |
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 ( |
Campos | |
---|---|
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 |
Es una referencia a una tabla de BigQuery. |
studioDatasourceId |
Es una referencia a una fuente de datos de Looker Studio. |
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 |
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 |
Es una consulta de recuperación de datos. |
generatedSql |
Es el código SQL que genera el sistema para recuperar datos. |
result |
Son datos recuperados. |
generatedLookerQuery |
Es la consulta de Looker que genera el sistema para recuperar datos. |
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 ( |
Campos | |
---|---|
question |
Opcional. Es una pregunta en lenguaje natural que se debe responder. |
name |
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.
|
datasources[] |
Opcional. Son las fuentes de datos disponibles para responder la pregunta. |
DataResult
Son datos recuperados.
Representación JSON |
---|
{
"name": string,
"schema": {
object ( |
Campos | |
---|---|
name |
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.
|
schema |
Opcional. Es el esquema de los datos. |
data[] |
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 ( |
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[] |
Opcional. Son los campos que se recuperarán de la exploración. |
filters[] |
Opcional. Son los filtros que se aplicarán a la exploración. |
sorts[] |
Opcional. Son los ordenamientos que se aplicarán a la exploración. |
limit |
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 |
Obligatorio. Es el campo por el que se filtrará. |
value |
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 ( |
Campos | |
---|---|
projectId |
Obligatorio. Es el proyecto al que pertenece el trabajo. Consulta JobReference. |
jobId |
Obligatorio. Es el ID del trabajo. Consulta JobReference. |
location |
Opcional. Es la ubicación del trabajo. Consulta JobReference. |
destinationTable |
Opcional. Es una referencia a la tabla de destino de los resultados de la consulta del trabajo. Consulta JobConfigurationQuery. |
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 |
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 |
Es una consulta de análisis. |
progressEvent |
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 |
Opcional. Es una pregunta de análisis que ayuda a responder la pregunta original del usuario. |
dataResultNames[] |
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 |
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 |
Es el razonamiento del planificador para la generación de código de Python. |
coderInstruction |
Son las instrucciones que se emiten para la generación de código. |
code |
Es el código generado. |
executionOutput |
Es el resultado de la ejecución del código. |
executionError |
Es un error de la ejecución del código. |
resultVegaChartJson |
Es el resultado como cadena JSON del gráfico de Vega. |
resultNaturalLanguage |
Es el resultado como una cadena NL. |
resultCsvData |
Es el resultado como una cadena CSV. |
resultReferenceData |
Es el resultado como referencia a una fuente de datos. |
error |
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 |
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 |
Es una consulta para generar un gráfico. |
result |
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 |
Opcional. Son las instrucciones en lenguaje natural para generar el gráfico. |
dataResultName |
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 ( |
Campos | |
---|---|
vegaConfig |
Opcional. Es un parámetro de configuración del gráfico generado de Vega. Consulta https://vega.github.io/vega/docs/config/ |
image |
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 |
Obligatorio. Es el tipo de MIME estándar de IANA de los datos del mensaje. |
data |
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 |
Solo salida. Es el texto del error. |