En esta página se describe la estructura recomendada para escribir peticiones eficaces para tus agentes de datos de la API Conversational Analytics. Estas peticiones son contextos creados que se definen como cadenas mediante el parámetro system_instruction. Las instrucciones del sistema bien estructuradas pueden mejorar la precisión y la relevancia de las respuestas que proporciona la API.
Para ver ejemplos de contexto creado en diferentes entornos, consulta las siguientes páginas de documentación:
- Definir el contexto del agente de datos para las fuentes de datos de BigQuery
- Definir el contexto del agente de datos para las fuentes de datos de Looker
¿Qué son las instrucciones del sistema?
Las instrucciones del sistema son directrices definidas por el usuario que los desarrolladores pueden proporcionar para dar forma al comportamiento de un agente de datos y para refinar las respuestas de la API. Las instrucciones del sistema forman parte del contexto que usa la API para responder a las preguntas. Este contexto también incluye fuentes de datos conectadas (tablas de BigQuery, Exploraciones de Looker y fuentes de datos de Looker Studio) y el historial de conversaciones (en el caso de las conversaciones de varias interacciones).
Si proporcionas instrucciones claras y estructuradas a través de las instrucciones del sistema, puedes mejorar la capacidad del agente para interpretar las preguntas de los usuarios y generar respuestas útiles y precisas. Las instrucciones del sistema bien definidas son especialmente útiles si te conectas a datos como tablas de BigQuery, donde puede que no haya una capa semántica predefinida como en Exploraciones de Looker.
Por ejemplo, puedes usar instrucciones del sistema para proporcionar los siguientes tipos de orientación a un agente:
- Lógica específica de la empresa: define a un cliente fiel como aquel que ha hecho más de cinco compras en un periodo determinado.
- Formato de respuesta: resume todas las respuestas de tu agente de datos en 20 palabras o menos para ahorrar tiempo a tus usuarios.
- Presentación de datos: da formato a todos los números para que coincidan con la guía de estilo de la empresa.
Proporcionar instrucciones del sistema
Puede proporcionar instrucciones del sistema a la API Conversational Analytics como una cadena con formato YAML mediante el parámetro system_instruction. Aunque el parámetro system_instruction es opcional y la estructura depende de ti, te recomendamos que proporciones instrucciones del sistema bien estructuradas para obtener respuestas precisas y relevantes.
Puedes definir la cadena con formato YAML en tu código durante la configuración inicial, tal como se muestra en Configurar los ajustes iniciales y la autenticación (HTTP) o Especificar el proyecto de facturación y las instrucciones del sistema (SDK de Python). Después, puede incluir el parámetro system_instruction en las siguientes llamadas a la API:
- Crear un agente de datos persistente: incluye la cadena
system_instructionen el objetopublished_contextdel cuerpo de la solicitud para configurar el comportamiento del agente que se mantiene en varias conversaciones. Para obtener más información, consulta Crear un agente de datos (HTTP) o Configurar el contexto para una conversación con o sin estado (SDK de Python). - Enviar una solicitud sin estado: proporciona la cadena
system_instructionen el objetoinline_contextde la solicitud de chat para definir el comportamiento y el contexto del agente durante esa llamada a la API específica. Para obtener más información, consulta Crear una conversación sin estado de varias interacciones (HTTP) o Enviar una solicitud de chat sin estado con contexto insertado (SDK de Python).
Recursos relacionados
- Definir el contexto del agente de datos para las fuentes de datos de BigQuery
- Definir el contexto del agente de datos para las fuentes de datos de Looker