Best practice per l'utilizzo degli endpoint dell'API ConversationalAnalytics nell'API di Looker

Gli endpoint API di Looker ConversationalAnalytics ti consentono di creare esperienze di analisi conversazionale personalizzate all'interno delle tue applicazioni incorporate. Queste API rispecchiano gli endpoint che alimentano la funzionalità Conversational Analytics di Looker e forniscono le stesse funzioni all'interno dell'API Looker. Queste includono operazioni di creazione, aggiornamento, lettura ed eliminazione (CRUD) per agenti, conversazioni e messaggi, nonché un'API di chat per interagire con l'agente conversazionale. Per garantire un processo di sviluppo senza intoppi e un rendimento ottimale, è importante comprendere alcune limitazioni e seguire le best practice consigliate quando utilizzi queste API.

Flusso di lavoro tipico

Un flusso di lavoro tipico per una conversazione multi-turno prevede l'utilizzo combinato di agenti, conversazioni, messaggi e API di chat.

  1. Crea un agente: se non ne hai uno, crealo utilizzando POST /agents. L'agente è configurato per utilizzare modelli ed esplorazioni di Looker specifici.
  2. Crea una conversazione: avvia una nuova conversazione associata a un agente utilizzando POST /conversations. Verrà restituito un ID conversazione.
  3. Invia un messaggio: per ogni turno della conversazione, chiama POST /conversational_analytics/chat con conversation_id e il messaggio dell'utente. Questo endpoint restituisce uno o più messaggi di sistema dell'agente.
  4. Persistenza dei messaggi: l'endpoint /conversational_analytics/chat non rende persistenti il messaggio dell'utente o i messaggi di sistema restituiti. Per mantenere la cronologia della conversazione per i turni successivi, devi rendere persistenti sia il messaggio dell'utente sia i messaggi di sistema chiamando POST /conversations/:conversation_id/messages dopo aver chiamato l'API chat.

Consigli

Per ottenere risultati ottimali, segui questi consigli:

  • Mantieni tutti i messaggi: dopo ogni chiamata a /conversational_analytics/chat, assicurati di chiamare POST /conversations/:conversation_id/messages per salvare sia il messaggio dell'utente del turno sia tutti i messaggi di sistema restituiti dall'API Chat. Questo è essenziale per le conversazioni multi-turno.
  • Gestisci lo streaming: quando possibile, utilizza la funzionalità di streaming dell'API Chat per fornire feedback all'utente durante l'elaborazione dell'agente. I messaggi ricevuti durante lo streaming possono essere utilizzati per indicare che l'agente sta "pensando".

Limitazioni e considerazioni

Quando utilizzi gli endpoint API ConversationalAnalytics, tieni presente le seguenti limitazioni:

  • Persistenza dei messaggi: è tua responsabilità rendere persistenti i messaggi utilizzando l'endpoint POST /conversations/:conversation_id/messages. Se non vengono conservati i messaggi dopo ogni chiamata a /conversational_analytics/chat, la cronologia delle conversazioni non verrà mantenuta e l'agente non avrà il contesto per le domande successive in una conversazione a più turni.
  • Supporto dello streaming: l'API Chat è un'API di streaming che ti consente di ricevere i messaggi man mano che vengono generati dall'agente, il che può migliorare l'esperienza utente per le query di lunga durata. Tuttavia, non tutte le lingue dell'SDK Looker supportano lo streaming. Se utilizzi un SDK che non supporta lo streaming, l'API restituirà la risposta completa in modo sincrono dopo la generazione di tutti i messaggi. Se lo streaming è essenziale e non è supportato dalla lingua dell'SDK, potresti dover effettuare chiamate HTTP direttamente per utilizzarlo.