Saltearse al contenido
Nappai Documentation

Zep Chat Memory

Zep Chat Memory es un componente que permite a los usuarios de Nappai guardar y recuperar el historial de conversaciones con un servicio externo llamado Zep. Con él, las interacciones de los usuarios con la IA se mantienen en un registro persistente, lo que facilita la continuidad de las conversaciones y la personalización de las respuestas.

¿Cómo funciona?

Cuando configuras el componente, introduces la URL de tu instancia de Zep, la API Key que te permite acceder a ella y, opcionalmente, el Session ID que identifica la conversación. El componente también te permite elegir entre dos versiones de la API (api/v1 o api/v2). Internamente, el componente crea un cliente de Zep (ZepClient) y utiliza la clase ZepChatMessageHistory para leer y escribir mensajes en la sesión especificada. El resultado es un objeto BaseChatMessageHistory que puede ser usado por otros componentes de Nappai para acceder al historial de chat.

Entradas

  • API Base Path: Selecciona la versión de la API de Zep que usarás (api/v1 o api/v2).
  • API Key: La clave secreta que autoriza el acceso a tu instancia de Zep.
  • Session ID: Identificador único de la conversación. Si lo dejas vacío, el componente generará uno automáticamente.
  • Zep URL: Dirección web de tu servidor Zep (por ejemplo, https://myzep.example.com).

Salidas

  • Memory: Un objeto BaseChatMessageHistory que contiene todos los mensajes de la sesión. Este objeto se puede pasar a otros componentes que necesiten acceder al historial de chat, como generadores de respuestas o analizadores de sentimiento.

Ejemplo de Uso

  1. Añade el componente “Zep Chat Memory” al panel de tu dashboard.
  2. Configura los campos:
    • Zep URL: https://myzep.example.com
    • API Key: sk-xxxxxxxxxxxxxxxxxxxx
    • Session ID: chat-12345 (opcional)
    • API Base Path: api/v1
  3. Conecta la salida “Memory” a cualquier componente que requiera historial de chat, por ejemplo, un “Chatbot” que utilice la memoria para mantener el contexto.
  4. Ejecuta el flujo. El chatbot podrá leer los mensajes anteriores y responder de manera coherente con la conversación.

Componentes Relacionados

  • LCChatMemoryComponent – Base sobre la que se construye Zep Chat Memory.
  • ZepClient – Cliente de la API de Zep que gestiona la comunicación.
  • ZepChatMessageHistory – Clase que maneja la lectura y escritura de mensajes en Zep.

Consejos y Mejores Prácticas

  • Mantén la API Key segura: Usa la entrada API Key como un secreto y evita exponerla en el código.
  • Revisa la versión de la API: Si tu instancia de Zep está en la nube, utiliza api/v2; si es local, api/v1.
  • Gestiona el Session ID: Para conversaciones continuas, reutiliza el mismo ID; para nuevas sesiones, genera uno nuevo.
  • Monitorea el uso: Zep puede limitar la cantidad de mensajes por sesión; revisa la documentación de Zep para evitar errores de límite.

Consideraciones de Seguridad

  • La API Key debe guardarse como secreto y nunca compartirse públicamente.
  • Asegúrate de que la URL de Zep sea accesible solo desde entornos seguros (por ejemplo, mediante VPN o reglas de firewall).
  • Si tu instancia de Zep está expuesta a Internet, habilita HTTPS para cifrar la comunicación.

Con estos pasos, podrás integrar fácilmente la memoria de chat de Zep en tus flujos de Nappai, garantizando que tus usuarios disfruten de conversaciones coherentes y personalizadas.