Best Practices für die Verwendung der ConversationalAnalytics API-Endpunkte in der Looker API

Mit den ConversationalAnalytics-API-Endpunkten von Looker können Sie benutzerdefinierte Conversational Analytics-Funktionen in Ihre eingebetteten Anwendungen einbinden. Diese APIs spiegeln die Endpunkte wider, die die Conversational Analytics-Funktion von Looker unterstützen, und bieten dieselben Funktionen innerhalb der Looker API. Dazu gehören CRUD-Vorgänge (Create, Read, Update, Delete) für Agents, Unterhaltungen und Nachrichten sowie eine Chat-API für die Interaktion mit dem Konversations-Agent. Damit die Entwicklung reibungslos verläuft und eine optimale Leistung erzielt wird, ist es wichtig, bestimmte Einschränkungen zu kennen und die empfohlenen Best Practices bei der Verwendung dieser APIs zu beachten.

Typischer Workflow

Ein typischer Workflow für eine Multi-Turn-Unterhaltung umfasst die gemeinsame Verwendung von Agents, Unterhaltungen, Nachrichten und Chat-APIs.

  1. Agent erstellen: Wenn Sie noch keinen Agent haben, erstellen Sie einen mit POST /agents. Der Agent ist für die Verwendung bestimmter Looker-Modelle und ‑Explores konfiguriert.
  2. Unterhaltung erstellen: Starten Sie eine neue Unterhaltung, die einem KI-Agenten zugeordnet ist, indem Sie POST /conversations verwenden. Dadurch wird eine Unterhaltungs-ID zurückgegeben.
  3. Nachricht senden: Rufen Sie für jede Runde in der Unterhaltung POST /conversational_analytics/chat mit dem conversation_id und der Nachricht des Nutzers auf. Dieser Endpunkt gibt eine oder mehrere Systemnachrichten vom Agent zurück.
  4. Nachrichten beibehalten: Der /conversational_analytics/chat-Endpunkt behält die Nutzernachricht oder die zurückgegebenen Systemnachrichten nicht bei. Damit der Unterhaltungsverlauf für nachfolgende Sprecherwechsel erhalten bleibt, müssen Sie sowohl die Nutzernachricht als auch die Systemnachricht(en) beibehalten, indem Sie POST /conversations/:conversation_id/messages aufrufen, nachdem Sie die Chat API aufgerufen haben.

Empfehlungen

Mit diesen Empfehlungen erhalten Sie die besten Ergebnisse:

  • Alle Nachrichten beibehalten: Rufen Sie nach jedem Aufruf von /conversational_analytics/chat unbedingt POST /conversations/:conversation_id/messages auf, um sowohl die Nachricht des Nutzers aus dieser Runde als auch alle Systemnachrichten zu speichern, die von der Chat-API zurückgegeben werden. Das ist für Multi-Turn Conversations unerlässlich.
  • Streaming verarbeiten: Verwenden Sie nach Möglichkeit die Streamingfunktion der Chat-API, um dem Nutzer Feedback zu geben, während der Agent die Anfrage verarbeitet. Die während des Streamings empfangenen Nachrichten können verwendet werden, um anzuzeigen, dass der Agent „nachdenkt“.

Einschränkungen und Überlegungen

Beachten Sie bei der Verwendung der ConversationalAnalytics-API-Endpunkte die folgenden Einschränkungen:

  • Nachrichtenspeicherung: Es liegt in Ihrer Verantwortung, Nachrichten über den POST /conversations/:conversation_id/messages-Endpunkt zu speichern. Wenn Nachrichten nach jedem Aufruf von /conversational_analytics/chat nicht beibehalten werden, wird der Unterhaltungsverlauf nicht gespeichert und der Agent hat keinen Kontext für Folgefragen in einer Unterhaltung mit mehreren Anfragen.
  • Streaming-Unterstützung: Die Chat-API ist eine Streaming-API. So können Sie Nachrichten empfangen, während sie vom Agent generiert werden. Das kann die Nutzerfreundlichkeit bei zeitaufwendigen Anfragen verbessern. Allerdings wird Streaming nicht von allen Looker SDK-Sprachen unterstützt. Wenn Sie ein SDK verwenden, das kein Streaming unterstützt, gibt die API die vollständige Antwort synchron zurück, nachdem alle Nachrichten generiert wurden. Wenn Streaming unbedingt erforderlich ist und von Ihrer SDK-Sprache nicht unterstützt wird, müssen Sie möglicherweise HTTP-Aufrufe direkt ausführen, um Streaming zu verwenden.