Práticas recomendadas para usar os endpoints da API ConversationalAnalytics na API do Looker

Com os endpoints da API ConversationalAnalytics do Looker, é possível criar experiências personalizadas de análise de conversação nos seus aplicativos incorporados. Essas APIs espelham os endpoints que alimentam o recurso de análise de conversas do Looker e oferecem as mesmas funções na API Looker. Elas incluem operações de criação, atualização, leitura e exclusão (CRUD) para agentes, conversas e mensagens, além de uma API de chat para interagir com o agente de conversação. Para garantir um processo de desenvolvimento tranquilo e um desempenho ideal, é importante entender algumas limitações e seguir as práticas recomendadas ao usar essas APIs.

Fluxo de trabalho típico

Um fluxo de trabalho típico para uma conversa multiturno envolve o uso conjunto de agentes, conversas, mensagens e APIs de chat.

  1. Crie um agente: se você não tiver um, crie usando POST /agents. O agente é configurado para usar modelos e análises detalhadas específicos do Looker.
  2. Criar uma conversa: inicie uma nova conversa associada a um agente usando POST /conversations. Isso vai retornar um ID de conversa.
  3. Enviar uma mensagem: para cada turno na conversa, chame POST /conversational_analytics/chat com o conversation_id e a mensagem do usuário. Esse endpoint retorna uma ou mais mensagens do sistema do agente.
  4. Persistir mensagens: o endpoint /conversational_analytics/chat não persiste a mensagem do usuário nem as mensagens retornadas do sistema. Para manter o histórico de conversas em turnos subsequentes, é necessário manter a mensagem do usuário e as mensagens do sistema chamando POST /conversations/:conversation_id/messages depois de chamar a API de chat.

Recomendações

Siga estas recomendações para ter os melhores resultados:

  • Persistir todas as mensagens: depois de cada chamada para /conversational_analytics/chat, chame POST /conversations/:conversation_id/messages para salvar a mensagem do usuário da vez e todas as mensagens do sistema retornadas pela API de chat. Isso é essencial para conversas com vários turnos.
  • Processar streaming: quando possível, use a capacidade de streaming da API de chat para fornecer feedback ao usuário enquanto o agente está processando. As mensagens recebidas durante o streaming podem ser usadas para indicar que o agente está "pensando".

Limitações e considerações

Ao usar os endpoints da API ConversationalAnalytics, considere as seguintes limitações:

  • Persistência de mensagens: é sua responsabilidade manter as mensagens usando o endpoint POST /conversations/:conversation_id/messages. Se você não persistir as mensagens após cada chamada para /conversational_analytics/chat, o histórico de conversas não será mantido, e o agente não terá contexto para perguntas complementares em uma conversa de várias rodadas.
  • Suporte a streaming: a API Chat é uma API de streaming que permite receber mensagens à medida que são geradas pelo agente, o que pode melhorar a experiência do usuário em consultas de longa duração. No entanto, nem todas as linguagens do SDK do Looker oferecem suporte a streaming. Se você estiver usando um SDK que não oferece suporte a streaming, a API vai retornar a resposta completa de forma síncrona depois que todas as mensagens forem geradas. Se o streaming for essencial e não for compatível com a linguagem do SDK, talvez seja necessário fazer chamadas HTTP diretamente para usar o streaming.