Metadados da transcrição do chat

Este documento explica o esquema JSON usado para estruturar metadados de transcrições de chat. Esse esquema é necessário para representar e processar conversas de chat com precisão.

Esquema de metadados de transcrição de chat

Esse esquema descreve os dados de estrutura de dados das transcrições de chat. Os componentes principais são descritos nas seções a seguir:

Informações principais da transcrição

As propriedades a seguir fornecem as informações fundamentais sobre a transcrição:

• comm_type (string). O tipo de comunicação a que essa transcrição pertence. Pode ser um chat ou uma chamada para ligações com funcionalidade de SMS combinada.

• comm_id (integer). Um identificador para a comunicação, por exemplo, chat ou chamada a que essa transcrição está relacionada.

• transcript_version (string). A versão do formato de transcrição. Isso é necessário para a compatibilidade com versões anteriores ao analisar transcrições.

• assigned_at (string, date-time). O carimbo de data/hora de quando o chat foi atribuído.

• timezone (string). O fuso horário em que o chat foi realizado.

Definições de mensagem

A seção definitions contém componentes de esquema reutilizáveis que definem a estrutura de diferentes tipos de mensagem na transcrição. Isso oferece flexibilidade no processamento de vários formatos de conteúdo:

• text (object): representa uma mensagem de texto

  • type (string): precisa ser "text"

  • content (string): o conteúdo de texto real da mensagem

  • lang (string): o idioma do conteúdo de texto

• text_template (object): representa uma mensagem de texto com modelo

  • type (string): precisa ser text_template

  • content (string): o conteúdo do modelo de texto, que pode incluir marcadores de posição

• markdown (object): representa uma mensagem usando a formatação Markdown

  • type (string): precisa ser Markdown

  • content (string): o conteúdo do modelo Markdown

• markdown_template (object): representa uma mensagem Markdown com modelo

  • type (string): precisa ser markdown_template.

  • content (string): o conteúdo do modelo Markdown, possivelmente com marcadores de posição

• photo (object): representa uma mensagem que contém uma foto

  • type (string): precisa ser photo

  • media_id (integer): o ID do arquivo de mídia da foto

• video (object): representa uma mensagem que contém um vídeo

  • title (string): título do vídeo

  • video (object): detalhes sobre o vídeo

    • url (string): URL do vídeo

    • text (string): texto alternativo ao URL do vídeo

  • media_id (integer): ID de mídia para recuperar o URL do vídeo, se não for fornecido diretamente

• image (object): representa uma mensagem que contém uma imagem

  • title (string): título da imagem

  • image (object): detalhes sobre a imagem

    • url (string): URL da imagem

    • text (string): texto alternativo ao URL da imagem

• document (object): representa uma mensagem que contém um documento

  • title (string): título do documento

  • document (object): detalhes sobre o documento

    • url (string): URL do documento.

    • text (string): texto alternativo ao URL do documento

• inline_button (object): representa um conjunto de botões inline

  • title (string): título do conjunto de botões inline

  • buttons (array): matriz de objetos de botão

    • title (string): título do botão

    • action (string): nome da ação indicada pelo botão

    • link (string): link de URL para ações de link de resposta rápida

• sticky_button (object): representa um conjunto de botões fixos

  • title (string): título do conjunto de botões fixos

  • buttons (array): matriz de objetos de botão

    • title (string): título do botão

    • action (string): nome da ação indicada pelo botão

    • link (string): link de URL para ações de link de resposta rápida

• content_card (object): representa um card de conteúdo

  • cards (array): matriz de objetos de card de conteúdo

    • title (string): título do card de conteúdo

    • body (string): texto do corpo do card de conteúdo

• server_message (object): representa uma mensagem recuperada do servidor

  • message_id (integer): ID da mensagem do servidor armazenada

  • content (string): conteúdo da mensagem recuperada do servidor

• action (object): representa uma ação realizada durante o chat. Pode ser uma das seguintes:

  • action_escalation (object): representa uma ação de escalonamento

    • action (string): precisa ser "escalation"

    • escalation_reason (string): o motivo do escalonamento.

    • menu_id (integer): o ID para o qual a comunicação precisa ser escalonada

    • language (string): código de idioma ISO 689 da fila para a qual escalonar

  • action_deflection (object): representa uma ação de desvio

    • action (string): precisa ser deflection

    • deflection_type (string): o tipo de desvio

    • sip_parameters (object or null): parâmetros SIP a serem encaminhados como parte do desvio, se presentes

  • action_end (object): representa uma ação de encerramento

    • action (string): precisa ser end

• noti (object): representa uma mensagem de notificação. Pode ser um de vários tipos de notificação:

  • noti_transfer_started (object): notificação para uma transferência que está começando.

    • type (string): precisa ser noti

    • event (string): precisa ser "transferStarted"

    • target (string): o destino da transferência, por exemplo, menu ou agente.

    • agent (object): o agente que iniciou a transferência

      • id (integer): ID do agente

      • email (string): e-mail do agente

      • name (string): nome do agente

  • noti_verification_requested (object): notificação para uma solicitação de verificação

  • type (string): precisa ser noti

  • event (string): precisa ser verificationRequested

  • agent (object): o agente que está pedindo a verificação

    • id (integer): ID do agente que está pedindo a verificação

    • email (string): e-mail do agente que está pedindo a verificação

    • name (string): nome do agente que está pedindo a verificação

  • noti_end_user_verified (object): notificação para quando um usuário final é verificado

    • type (string): precisa ser noti

    • event (string): precisa ser endUserVerified

  • Outros tipos noti_\* definem notificações para vários eventos, como solicitações de fotos, solicitações de vídeos, eventos de navegação conjunta, eventos de agente virtual de tarefas, participação de agentes e mudanças de status de transferência ou escalonamento.

  • noti_custom (object): representa uma notificação personalizada.

    • type (string): precisa ser noti

    • event (string): precisa ser custom

    • detail (object): detalhes do evento personalizado

    • key (string): chave que representa o detalhe do evento personalizado

    • data (object): payload de evento definido personalizado

Entradas de transcrição

• entries (array): uma matriz de objetos, em que cada objeto representa uma mensagem individual enviada no chat.

  • timestamp (string): o carimbo de data/hora de quando a mensagem foi enviada

  • type (string): o tipo de mensagem, referenciando uma das definições descritas anteriormente, por exemplo, text, photo, noti.

  • body (object): o conteúdo da mensagem, de acordo com a estrutura definida pelo tipo da mensagem. Ele usa oneOf para permitir diferentes tipos de corpo.

  • role (string): o papel do participante que enviou a mensagem. Os valores possíveis incluem end_user, agent, manager, virtual_agent, external_agent, task_virtual_agent, system.

  • user_data (object): dados do usuário que enviou a mensagem, a menos que seja uma mensagem do usuário final ou do sistema.

    • name (string): o nome do usuário

    • id (integer): o ID exclusivo do usuário

  • avatar_url (string): URL de armazenamento do avatar do usuário