Obter resumo da conversa

Obtenha um resumo conciso de uma conversa: o título, o resumo gerado da transcrição, se a chamada foi bem-sucedida e — somente quando a conversa é curta — as mensagens simples do chat. Chamadas de ferramentas, resultados de ferramentas e atualizações contextuais são omitidos para manter a resposta pequena. Use isto em vez do endpoint de conversa completa quando precisar apenas do essencial (por exemplo, um agente lendo muitas conversas); use GET /v1/convai/conversations/{conversation_id} quando precisar da transcrição completa com chamadas de ferramentas e atualizações contextuais.

Parâmetros de caminho

conversation_idstringObrigatório

O ID da conversa na qual você está realizando a ação.

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

max_messagesintegerOpcional1-200Padrão é 40

Número máximo de turnos de mensagens de chat a incluir inline. Quando a conversa tiver mais turnos do que isso, as mensagens serão omitidas e messages_omitted será definido.

Resposta

Resposta bem-sucedida

conversation_idstring
agent_idstring
statusenum
Valores permitidos:
message_countinteger

Número de turnos de mensagens de chat simples na conversa.

notestring

Orientações que indicam ao agente como obter a transcrição completa.

call_summary_titlestring or nullOpcional

Título curto gerado para a conversa.

transcript_summarystring or nullOpcional
Resumo da chamada gerado em linguagem natural.
call_successfulenum or nullOpcional
Valores permitidos:
messageslist of objects or nullOpcional

As mensagens simples do chat (apenas função e texto). Incluídas somente quando message_count não excede o max_messages solicitado; caso contrário, null e messages_omitted é true.

messages_omittedbooleanOpcionalPadrão é false

True quando as mensagens do chat foram omitidas porque a conversa era longa demais. Busque a transcrição completa para obter as mensagens.

Erros

422
Unprocessable Entity Error