Renderiza respuestas del agente para fuentes de datos de Looker

En esta guía, se describen los enfoques recomendados para renderizar los resultados de la API de Conversational Analytics en una interfaz de usuario (IU) con fuentes de datos de Looker.

Cuando un usuario consulta la API, la respuesta puede incluir pasos de razonamiento intermedios, además de la respuesta final. En esta guía, se describe cómo renderizar respuestas de la API con diferentes niveles de detalle implementando una vista de respuesta principal y una vista de detalles completos:

  • La vista de respuesta principal muestra la respuesta a la pregunta del usuario directamente. Esta vista proporciona una presentación concisa y no incluye detalles sobre el razonamiento del agente por adelantado.
  • La vista de detalles completa muestra el proceso de razonamiento completo que sigue el agente para llegar a la respuesta final, incluidos todos los elementos de la vista de respuesta principal.

Un patrón de IU recomendado es mostrar la vista de respuesta principal de forma predeterminada y proporcionar un control de IU, como un botón o un botón de activación, que permita a los usuarios cambiar a la vista de detalles completa. Si bien los detalles del razonamiento son útiles para validar la lógica, mostrarlos de forma predeterminada puede agregar detalles innecesarios para los usuarios que se interesan principalmente en la respuesta final.

Vista principal de la respuesta

Para renderizar solo la respuesta directa final a la pregunta del usuario, sigue los pasos que se indican en esta sección. Esta vista se enfoca en el resultado final y excluye los pasos intermedios.

Guía para la renderización de mensajes del sistema

En la siguiente tabla, se describen los mensajes del sistema que se consideran respuestas directas finales, junto con recomendaciones para renderizarlos.

Mensaje del sistema Orientación sobre el procesamiento
DataQuery Renderiza con el resultado asociado. Renderiza este mensaje solo en los casos en los que renderices el mensaje DataResult correspondiente.

No renderices mensajes de DataQuery en los siguientes casos:
  • El campo name del mensaje DataQuery termina en _sample_values (por ejemplo, products_brand_sample_values).
  • El campo name del mensaje DataResult correspondiente termina en _sample_values.
  • El campo data del mensaje DataResult correspondiente está vacío.
Te recomendamos que coloques el texto de la búsqueda dentro de un botón de activación para mostrar la búsqueda de origen a pedido. Por ejemplo, Conversational Analytics en Looker usa un control "¿Cómo se calculó esto?".
DataResult Renderiza todos los mensajes de DataResult, excepto los resultados intermedios y vacíos.

No renderices mensajes de DataResult en los siguientes casos:
  • El campo name finaliza en _sample_values. Estos son pasos intermedios para recuperar valores de muestra para un campo específico.
  • El campo data está vacío. Estos resultados se resumen en la respuesta final de TextMessage.
ChartResult Renderiza todos los gráficos. Renderiza todos los mensajes ChartResult en la respuesta de la API.
TextMessage Solo renderiza las respuestas finales. Renderiza mensajes TextMessage solo cuando el valor de TextType es FINAL_RESPONSE.

Ejemplo: Renderiza la vista de respuesta principal

Puedes implementar un botón de activación, como Mostrar explicación, para permitir que los usuarios cambien de la vista de respuesta principal a la vista de detalles completa.

Un botón de activación con la etiqueta "Mostrar razonamiento" en estado contraído.

La siguiente transcripción muestra la vista de respuesta principal. En el caso de los mensajes de DataQuery, recomendamos ocultar los detalles de la búsqueda detrás de un botón de activación intercalado, indicado en la transcripción con un ícono contraído (), para proporcionar acceso opcional a la lógica de búsqueda subyacente.

Usuario: Compara las ventas totales de Cymbal Group en 2022 y 2023. Representa el resultado en un gráfico.

Agente:

Este es el resultado de la consulta para las ventas totales de Cymbal Group en 2022 y 2023.

Año de creación Ventas totales
2023 $96,627.00
2022 $93,095.50

Ventas totales de Cymbal Group en 2022 y 2023

Gráfico de barras que compara las ventas de 2022 y 2023.

Las ventas totales de Cymbal Group en 2022 fueron de USD 93,095.50 y, en 2023, de USD 96,627.00.

En la siguiente tabla, se asignan los elementos de la interacción de ejemplo a sus correspondientes mensajes del sistema de la API.

Elemento Mensaje fuente
Consulta generada (JSON oculto detrás del botón de activación de forma predeterminada) DataQuery
Tabla de datos DataResult
Gráfico de barras ChartResult
Respuesta de texto final TextMessage (FINAL_RESPONSE)

Vista de detalles completa

Usa esta guía para renderizar el proceso de razonamiento completo. Esta vista incluye todo lo que se muestra en la vista de respuesta principal y muestra el contenido y los pasos en el orden en que los genera el agente. En esta vista, se muestran todos los pasos que sigue el agente para llegar a la respuesta final, incluidos su razonamiento y los datos intermedios.

Orientación para la renderización del razonamiento y la recuperación de datos detallados

En la siguiente tabla, se describen los mensajes del sistema que representan el razonamiento del agente y los pasos de recuperación detallados, junto con recomendaciones para renderizar estos mensajes.

Mensaje del sistema Orientación sobre el procesamiento
TextMessage con un valor de TextType de THOUGHT Renderiza los pasos de razonamiento. Muestra estos mensajes para mostrar el proceso de pensamiento interno del agente. Estos mensajes contienen dos partes:
  • parts[0] es el resumen del pensamiento, que resume brevemente el texto completo del pensamiento.
  • parts[1] es el texto completo del pensamiento.
Si tu aplicación muestra actualizaciones de estado (como un indicador de carga o una barra de progreso), te recomendamos que muestres el resumen del pensamiento (parts[0]) como indicador de estado transitorio.
TextMessage con un valor de TextType de PROGRESS Mostrar mensajes de PROGRESS Muestra estos mensajes para proporcionar estadísticas sobre las acciones del agente. Son mensajes informativos sobre el progreso del agente, como una herramienta que se está invocando. Esto se diferencia del proceso de pensamiento interno del agente (THOUGHT) y de la respuesta final al usuario (FINAL_RESPONSE). Estos mensajes contienen dos partes:
  • parts[0] es el resumen.
  • parts[1] es el texto de progreso completo.
DataQuery y DataResult con un nombre que termina en _sample_values Muestra mensajes intermedios de DataQuery y DataResult. Los mensajes DataQuery y DataResult con un campo name que termina en _sample_values son pasos intermedios para la recuperación de datos detallados y no se muestran en la vista de respuesta principal. Incluye estos pasos en la vista de respuesta completa (detrás de un botón de activación) para mostrar los pasos que sigue el agente.
DataResult con un campo data vacío Mostrar solo el mensaje de DataQuery asociado No muestres mensajes DataResult con un campo data vacío en ninguna vista. En la vista de detalles completa, muestra el mensaje DataQuery que generó el resultado vacío (detrás de un botón de activación). Esto permite que el usuario vea la consulta que se ejecutó, aunque no haya generado resultados. El resumen de la respuesta final (TextMessage con el tipo FINAL_RESPONSE) ya le habrá informado al usuario que la búsqueda no devolvió datos.

Ejemplo: Renderiza la vista de detalles completa

Cuando un usuario cambia el botón de activación Mostrar razonamiento al estado expandido, la IU revela el razonamiento paso a paso del agente.

Un botón de activación con la etiqueta "Mostrar explicación" en estado expandido.

En la siguiente transcripción, se muestra la vista de detalles completa, incluidos los pasos de razonamiento. En el caso de los mensajes de DataQuery, los detalles de la búsqueda se pueden mostrar de forma predeterminada, de manera opcional detrás de un botón de activación intercalado indicado por un ícono expandido (), como se muestra en la transcripción.

Usuario: Compara las ventas totales de Cymbal Group en 2022 y 2023. Representa el resultado en un gráfico.

Agente:

Información sobre el esquema

Para comparar las ventas totales de "Cymbal Group" en 2022 y 2023, debo consultar el Explorador "Order Items". Filtraré por el nombre del producto "Cymbal Group" y por los años 2022 y 2023. Luego, recuperaré los campos Total Sales y Created Year.

Este es el resultado de la consulta para las ventas totales de Cymbal Group en 2022 y 2023. 

[
 {"model":"thelook","view":"order_items","fields":["order_items.total_sale_price","order_items.created_year"],
 "filters":{"order_items.created_year":"2022,2023","products.brand":"Cymbal Group"}}
]
Año de creación Ventas totales
2023 $96,627.00
2022 $93,095.50

Cómo generar un gráfico de la distribución de ventas

Recuperé las ventas totales de "Cymbal Group" para 2022 y 2023. Ahora generaré un gráfico para visualizar esta comparación y, luego, proporcionaré la respuesta final.

Genera un gráfico de barras que compare las ventas totales de "Cymbal Group" en 2022 y 2023. El eje X debe representar el año y el eje Y debe representar las ventas totales.

Gráfico de barras que compara las ventas de 2022 y 2023.

Las ventas totales de Cymbal Group en 2022 fueron de USD 93,095.50 y, en 2023, de USD 96,627.00.

En la siguiente tabla, se asignan los pasos de la interacción de ejemplo a sus correspondientes mensajes del sistema de la API.

Elemento Mensaje fuente
"Cómo comprender el esquema" (resumen del pensamiento) TextMessage (tipo THOUGHT, parts[0])
"Para comparar las ventas totales…" (texto completo de la reflexión) TextMessage (tipo THOUGHT, parts[1])
Consulta generada (se muestra el JSON cuando se expande el botón de activación ) DataQuery
Tabla de datos DataResult
"Diagrama de la distribución de ventas" (resumen de la idea) TextMessage (tipo THOUGHT, parts[0])
"Recuperé…" (texto completo de la reflexión) TextMessage (tipo THOUGHT, parts[1])
Gráfico de barras ChartResult
Respuesta de texto final TextMessage (FINAL_RESPONSE)