Les points de terminaison de l'API ConversationalAnalytics de Looker vous permettent de créer des expériences d'analyse conversationnelle personnalisées dans vos applications intégrées. Ces API reflètent les points de terminaison qui alimentent la fonctionnalité Conversational Analytics de Looker et fournissent les mêmes fonctions dans l'API Looker. Elles incluent les opérations CRUD (créer, mettre à jour, lire et supprimer) pour les agents, les conversations et les messages, ainsi qu'une API de chat pour interagir avec l'agent conversationnel. Pour garantir un processus de développement fluide et des performances optimales, il est important de comprendre certaines limites et de suivre les bonnes pratiques recommandées lorsque vous utilisez ces API.
Méthode de travail standard
Un workflow type pour une conversation multitour consiste à utiliser ensemble les API Agents, Conversations, Messages et Chat.
- Créez un agent : si vous n'en avez pas, créez-en un à l'aide de
POST /agents. L'agent est configuré pour utiliser des modèles et des explorations Looker spécifiques. - Créer une conversation : démarrez une conversation associée à un agent à l'aide de
POST /conversations. Un ID de conversation sera renvoyé. - Envoyer un message : pour chaque tour de conversation, appelez
POST /conversational_analytics/chatavecconversation_idet le message de l'utilisateur. Ce point de terminaison renvoie un ou plusieurs messages système de l'agent. - Persister les messages : le point de terminaison
/conversational_analytics/chatne conserve pas le message utilisateur ni les messages système renvoyés. Pour conserver l'historique des conversations pour les tours suivants, vous devez conserver le message de l'utilisateur et le ou les messages du système en appelantPOST /conversations/:conversation_id/messagesaprès avoir appelé l'API Chat.
Recommandations
Pour obtenir les meilleurs résultats, suivez ces recommandations :
- Conserver tous les messages : après chaque appel à
/conversational_analytics/chat, veillez à appelerPOST /conversations/:conversation_id/messagespour enregistrer à la fois le message de l'utilisateur pour ce tour et tous les messages système renvoyés par l'API Chat. C'est essentiel pour les conversations multitours. - Gérer le streaming : lorsque cela est possible, utilisez la fonctionnalité de streaming de l'API de chat pour fournir un retour à l'utilisateur pendant que l'agent traite sa demande. Les messages reçus pendant le streaming peuvent être utilisés pour indiquer que l'agent "réfléchit".
Limites et points à noter
Lorsque vous utilisez les points de terminaison de l'API ConversationalAnalytics, tenez compte des limites suivantes :
- Persistance des messages : il vous incombe de rendre les messages persistants à l'aide du point de terminaison
POST /conversations/:conversation_id/messages. Si vous ne conservez pas les messages après chaque appel à/conversational_analytics/chat, l'historique des conversations ne sera pas conservé et l'agent n'aura pas de contexte pour les questions de suivi dans une conversation en plusieurs tours. - Assistance pour le streaming : l'API Chat est une API de streaming qui vous permet de recevoir les messages à mesure qu'ils sont générés par l'agent. Cela peut améliorer l'expérience utilisateur pour les requêtes de longue durée. Toutefois, tous les langages du SDK Looker ne sont pas compatibles avec le streaming. Si vous utilisez un SDK qui ne prend pas en charge le streaming, l'API renverra la réponse complète de manière synchrone une fois tous les messages générés. Si le streaming est essentiel et n'est pas pris en charge par le langage de votre SDK, vous devrez peut-être effectuer des appels HTTP directement pour utiliser le streaming.