- Representación JSON
- Mensaje de usuario
- Mensaje del sistema
- Mensaje de texto
- Mensaje de esquema
- Consulta de esquema
- Resultado del esquema
- Fuente de datos
- Mensaje de datos
- Consulta de datos
- Resultado de datos
- Consulta de Looker
- Filtrar
- Trabajo de BigQuery
- Mensaje de análisis
- Consulta de análisis
- Evento de análisis
- Mensaje de gráfico
- Consulta de gráficos
- Resultado del gráfico
- Gota
- Mensaje de error
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. Para los mensajes de usuario, esta es la hora en que el sistema recibió el mensaje. Para los mensajes del sistema, esta es la hora en que el sistema generó el mensaje. Utiliza la RFC 3339, donde la salida generada siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan desplazamientos distintos de "Z". Ejemplos: |
messageId | Opcional. Identificador único del mensaje en la conversación para persistencia. |
kind de campo de unión. El kind de mensaje solo puede ser uno de los siguientes: | |
userMessage | Un mensaje del usuario que está interactuando con el sistema. |
systemMessage | Un mensaje del sistema en respuesta al usuario. |
Mensaje de usuario
Un mensaje del usuario que está interactuando 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 uno de los siguientes: | |
text | El texto debe utilizar este campo en lugar de blob. |
Mensaje del sistema
Un mensaje del sistema en respuesta al usuario. Este mensaje también puede ser un mensaje del usuario como contexto histórico para conversaciones multiturno con el sistema.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
kind de campo de unión. El tipo de contenido del mensaje del sistema. kind solo puede ser uno de los siguientes: | |
text | Una respuesta directa en lenguaje natural al mensaje del usuario. |
schema | Un mensaje producido durante la resolución del esquema. |
data | Un mensaje producido durante la recuperación de datos. |
analysis | Un mensaje producido durante el análisis. |
chart | Un mensaje producido durante la generación del gráfico. |
error | Un mensaje de error. |
Mensaje de texto
Un mensaje de texto de varias partes.
Representación JSON |
---|
{ "parts": [ string ] } |
Campos | |
---|---|
parts[] | Solo salida. Las partes del mensaje. |
Mensaje de esquema
Un mensaje producido 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 solo puede ser uno de los siguientes: | |
query | Una consulta de resolución de esquema. |
result | El resultado de una consulta de resolución de esquema. |
Consulta de esquema
Una consulta para resolver el esquema relevante a la pregunta planteada.
Representación JSON |
---|
{ "question": string } |
Campos | |
---|---|
question | Solo salida. La pregunta que se enviará al sistema para la resolución del esquema. |
Resultado del esquema
El resultado de la resolución del esquema.
Representación JSON |
---|
{
"datasources": [
{
object ( |
Campos | |
---|---|
datasources[] | Solo salida. Las fuentes de datos utilizadas para resolver la consulta del esquema. |
Fuente de datos
Una fuente de datos que se puede utilizar para responder preguntas.
Representación JSON |
---|
{ "schema": { object ( |
Campos | |
---|---|
schema | Solo salida. El esquema de la fuente de datos. |
reference de campo de unión. La reference a la fuente de datos solo puede ser una de las siguientes: | |
bigqueryTableReference | Una referencia a una tabla de BigQuery. |
studioDatasourceId | Una referencia a una fuente de datos de Looker Studio. |
lookerExploreReference | Una referencia a una exploración de Looker. |
Mensaje de datos
Un mensaje producido 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 solo puede ser uno de los siguientes: | |
query | Una consulta de recuperación de datos. |
generatedSql | SQL generado por el sistema para recuperar datos. |
result | Datos recuperados. |
generatedLookerQuery | Consulta Looker generada por el sistema para recuperar datos. |
bigQueryJob | Un trabajo de BigQuery ejecutado por el sistema para recuperar datos. |
Consulta de datos
Una consulta para recuperar datos.
Representación JSON |
---|
{
"name": string,
"question": string,
"datasources": [
{
object ( |
Campos | |
---|---|
name | Solo salida. Un nombre de consulta con mayúsculas y minúsculas que refleja su propósito. Se utiliza para nombrar el resultado de datos correspondiente, de modo que se pueda referenciar en pasos posteriores. Ejemplo: "ventas_totales_por_producto" Ejemplo: "ventas_por_producto_12345" |
question | Solo salida. La pregunta a responder. |
datasources[] | Solo salida. Las fuentes de datos disponibles para responder la pregunta. |
Resultado de datos
Datos recuperados.
Representación JSON |
---|
{
"name": string,
"schema": {
object ( |
Campos | |
---|---|
name | Solo salida. Un nombre con mayúsculas y minúsculas para el resultado de los datos que refleja su contenido. El nombre se utiliza para transmitir el resultado por referencia y sirve como indicador de su significado. Ejemplo: "ventas_totales_por_producto" Ejemplo: "ventas_por_producto_12345" |
schema | Solo salida. El esquema de los datos. |
data[] | Solo salida. 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 estructuras. |
Consulta de Looker
Consulta para recuperar datos de un Looker Explore. Consulte Ejecutar consulta en línea .
Representación JSON |
---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
Campos | |
---|---|
model | Obligatorio. El modelo LookML utilizado para generar la consulta. |
explore | Obligatorio. El explorador LookML utilizado para generar la consulta. |
fields[] | Opcional. Los campos a recuperar de la exploración. |
filters[] | Opcional. Los filtros que se aplicarán a la exploración. |
sorts[] | Opcional. Los tipos que se aplicarán a la exploración. |
limit | Opcional. Límite en la consulta. |
Filtrar
Un filtro de consulta de Looker.
Representación JSON |
---|
{ "field": string, "value": string } |
Campos | |
---|---|
field | Obligatorio. El campo por el que se filtrará. |
value | Obligatorio. El valor del campo f para filtrar. |
Trabajo de BigQuery
Un trabajo de BigQuery ejecutado por el sistema.
Representación JSON |
---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
Campos | |
---|---|
projectId | Obligatorio. El proyecto al que pertenece el trabajo. Ver JobReference . |
jobId | Obligatorio. El ID del trabajo. Ver JobReference . |
location | Opcional. La ubicación del trabajo. Ver JobReference . |
destinationTable | Solo salida. Una referencia a la tabla de destino de los resultados de la consulta del trabajo. Consulte JobConfigurationQuery . |
schema | Solo salida. El esquema de los resultados de la consulta del trabajo. Consulte JobStatistics2 . |
Mensaje de análisis
Un mensaje producido 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 uno de los siguientes: | |
query | Una consulta de análisis. |
progressEvent | Un evento que indica el progreso del análisis. |
Consulta de análisis
Una consulta para realizar un análisis.
Representación JSON |
---|
{ "question": string, "dataResultNames": [ string ] } |
Campos | |
---|---|
question | Solo salida. Una pregunta de análisis para ayudar a responder la pregunta original del usuario. |
dataResultNames[] | Solo salida. Los nombres de los resultados de datos recuperados previamente para analizar. |
Evento de análisis
Un evento que indica el progreso de un análisis.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
kind de campo de unión. El tipo de evento ocurrido durante el análisis. kind solo puede ser uno de los siguientes: | |
plannerReasoning | Razonamiento del planificador de generación de código en Python. |
coderInstruction | Instrucciones emitidas para la generación de código. |
code | Código generado. |
executionOutput | Salida de la ejecución del código. |
executionError | Un error de ejecución del código. |
resultVegaChartJson | Resultado como cadena JSON del gráfico Vega. |
resultNaturalLanguage | Resultado como cadena NL. |
resultCsvData | Resultado como cadena CSV. |
resultReferenceData | Resultado como referencia a una fuente de datos. |
error | Un mensaje de error genérico. |
Mensaje de gráfico
Un mensaje producido 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 solo puede ser uno de los siguientes: | |
query | Una consulta para generar un gráfico. |
result | El resultado de una consulta de generación de gráficos. |
Consulta de gráficos
Una consulta para generar un gráfico.
Representación JSON |
---|
{ "instructions": string, "dataResultName": string } |
Campos | |
---|---|
instructions | Solo salida. Instrucciones en lenguaje natural para generar el gráfico. |
dataResultName | Solo salida. El nombre de un resultado de datos recuperado previamente para usar en el gráfico. |
Resultado del gráfico
El resultado de una consulta de generación de gráficos.
Representación JSON |
---|
{
"vegaConfig": {
object
},
"image": {
object ( |
Campos | |
---|---|
vegaConfig | Solo salida. Configuración de gráfico de Vega generada. Consulta https://vega.github.io/vega/docs/config/ |
image | Opcional. Una representación del gráfico si se solicitó en el contexto. |
Gota
Un blob de datos con un tipo MIME.
Representación JSON |
---|
{ "mimeType": string, "data": string } |
Campos | |
---|---|
mimeType | Obligatorio. El tipo MIME estándar de la IANA de los datos del mensaje. |
data | Obligatorio. Los datos se representan como bytes. Una cadena codificada en base64. |
Mensaje de error
Un mensaje de error.
Representación JSON |
---|
{ "text": string } |
Campos | |
---|---|
text | Solo salida. El texto del error. |