Fulfillments

No turno de conversas do agente, ele precisa responder ao usuário final com uma resposta a uma pergunta, uma consulta de informações ou o encerramento da sessão. O agente também pode precisar entrar em contato com seu serviço para gerar respostas dinâmicas ou realizar ações por uma volta. O fulfillment é usado para fazer tudo isso.

Um fulfillment pode conter:

• Mensagens de resposta estática.
• Chamadas de webhook para respostas dinâmicas e/ou para realizar ações.
• Predefinições de parâmetros para definir ou substituir valores de parâmetros.

Durante a rodada de um agente, é possível (e às vezes desejável) chamar vários fulfillments, e cada um deles pode gerar uma mensagem de resposta. O Dialogflow CX mantém essas respostas em uma fila de respostas. Depois que a rodada do agente terminar, o Dialogflow CX enviará as respostas ordenadas ao usuário final.

Casos de uso de fulfillment

O fulfillment é usado em qualquer lugar em que uma mensagem de resposta é necessária:

• Fulfillment de entrada de página
• Rotas
• Manipuladores de eventos
• Solicitações iniciais para formulários
• Gerenciadores de prompts para formulários

Para cada um desses casos de uso, o console abrirá um painel de edição de fulfillment.

Respostas do agente (opções de diálogo)

As mensagens de resposta do agente são respostas que você define no momento do projeto. Você as define ao criar o fulfillment. No ambiente de execução, essas respostas são adicionadas à fila de respostas.

Há vários tipos de mensagens de resposta, que são descritos nas subseções a seguir. Ao usar o console, um painel de fulfillment tem um cartão inicial de Diálogo do agente, mas é possível clicar em + Adicionar resposta de diálogo para adicionar mais cartões para outros tipos de mensagens de resposta.

Resposta de texto estático

As mensagens de resposta de texto estático enviam a caixa de diálogo para o usuário final. Se as chamadas de API de intent de detecção ou de integração usarem a síntese de fala, esse texto será usado para gerar conteúdo de áudio. Nesse caso, o texto fornecido pode usar a Linguagem de marcação de síntese de fala (SSML, na sigla em inglês).

É possível definir vários cards de resposta de texto e várias respostas de texto dentro de cada card. Se você definir vários cards, eles serão concatenados para uma única resposta no ambiente de execução. Se você definir várias respostas dentro de um cartão, uma das mensagens no cartão será escolhida aleatoriamente no tempo de execução.

Essas mensagens de texto podem conter referências de parâmetro e funções do sistema in-line.

Payload personalizado

Algumas integrações são compatíveis com uma resposta de payload personalizada para lidar com respostas avançadas. Esses payloads personalizados precisam ser fornecidos no formato JSON definido na documentação da integração. Por exemplo, consulte o formato de payload personalizado do Dialogflow CX Messenger.

É possível incluir referências de parâmetros no seu JSON de payload personalizado. Eles precisam ser tratados como valores de string JSON. Portanto, coloque-os entre aspas duplas. Exemplo:

{
  "someField": "$session.params.date"
}

Observação: o JSON de payload personalizado precisa ter no máximo 24 níveis de profundidade.

Também é possível enviar um payload personalizado para as integrações que você desenvolve. Por não ser processado pelo Dialogflow CX, ele precisará ser manipulado na sua própria lógica de negócios.

Consulte também a seção a seguir sobre modelos de payload personalizados.

Transferência de agente ao vivo

Essa resposta sinaliza ao autor da chamada da API de intent de detecção que a conversa precisa ser enviada a um agente humano. O Dialogflow CX usa esse sinal apenas para identificar conversas entregues para fins de medição, sem alterar o estado da sessão. Seu sistema ou integração pode usar esse sinal para executar as ações necessárias para entregar a conversa. O Dialogflow CX não impõe nenhuma estrutura nesses dados. Assim, é possível escolher qualquer estrutura que se encaixe no seu sistema.

Metadados de conversação bem-sucedida

Essa resposta sinaliza ao autor da chamada da API de intent de detecção que a conversa com o agente do Dialogflow CX foi bem-sucedida. O Dialogflow CX usa esse sinal apenas para identificar conversas que foram bem-sucedidas para fins de medição e não muda o estado da sessão de forma alguma. Seu sistema ou integração pode usar esse sinal para realizar as ações necessárias. O Dialogflow CX não impõe nenhuma estrutura nesses dados. Assim, é possível escolher qualquer estrutura que se encaixe no seu sistema.

Ouvir áudio pré-gravado

Essa resposta reproduz um arquivo de áudio para integrações compatíveis com esse recurso.

Os requisitos de formato de arquivo de áudio podem variar de acordo com a integração. Por exemplo, consulte os requisitos do gateway telefônico do Dialogflow CX.

Para integrações de telefonia de parceiros, o URL do arquivo de áudio precisa estar acessível ao parceiro. Um URL disponível publicamente, como um arquivo público no Cloud Storage, está sempre acessível ao parceiro. O parceiro também pode fornecer acesso restrito a arquivos de áudio. Consulte a documentação do parceiro para mais detalhes.

Texto de saída de áudio

Essa resposta é semelhante à resposta de texto, mas só é aplicável à síntese de fala. Se o agente processar sessões de texto e voz, use respostas de texto e texto de áudio exclusivos para criar uma experiência do usuário diferente no texto. Voz. Se o texto de saída de áudio for fornecido para uma sessão de voz, as respostas de texto simples serão ignoradas.

Se o agente processar sessões de texto e voz, e você quiser as mesmas mensagens de resposta, basta usar respostas de texto para sessões de texto e de voz.

O texto de áudio de saída é concatenado de forma semelhante às respostas de texto. Se as respostas de texto de áudio de saída forem uma mistura de texto e SSML, o resultado concatenado será tratado como SSML. O ideal é que o designer do agente use texto ou SSML de maneira consistente.

Resposta condicional

Esse tipo de resposta é usado para respostas condicionais. Este é o formato geral:

if [condition]
  [response]
elif [condition]
  [response]
elif [condition]
  [response]
else
  [response]
endif

onde:

• [condition] é o mesmo formato usado para condições de rota.
• [response] é uma resposta de texto.
• Os blocos elif e else são opcionais

Exemplo:

if $session.params.user-age >= 21
  Ok, you may enter.
else
  Sorry, you cannot enter.
endif

Tanto [condition] quanto [response] podem usar funções in-line do sistema para gerar valores dinâmicos durante as conversas. Para saber mais, verifique as referências de funções do sistema e condições de rota. O [condition] é resolvido com base no estado da sessão no início do atendimento. Se o [response] depender do estado da sessão, ele será resolvido com base no estado atualizado da sessão ao final do atendimento.

Para agentes multilíngues, [condition] é comum para todos os idiomas, enquanto [response] é específico de um idioma. Quando você altera [condition] para um idioma no console, essa parte é atualizada em todos os idiomas do agente e, que se torna uma nova condição, [response] é apagado para todos os idiomas diferente do idioma selecionado ao atualizar o [condition].

Chamada de transferência de telefonia

Observação: a transferência de chamadas está disponível apenas para o gateway telefônico do Dialogflow CX.

Para algumas integrações de telefonia, é possível especificar um número de telefone dos EUA para transferência de chamadas. No ambiente de execução, quando o agente virtual do Dialogflow CX chama um fulfillment com a transferência de chamada, a chamada é transferida para o número especificado, e o processamento do agente virtual é suspenso.

Resposta da ferramenta de repositório de dados

Esse tipo de resposta configura as respostas do agente retornadas das ferramentas de repositório de dados vinculadas. Se você configurou uma ferramenta de repositório de dados nesse fulfillment, um card de resposta da ferramenta é preenchido automaticamente.

• Links de origem: permite definir o número máximo de citações que serão retornadas ao usuário após a resposta. Uma citação é um link para a fonte de informações no repositório de dados, renderizado como botões. O padrão é 1.
• Citações inline: em vez de links listados após a resposta, esse campo permite limitar o número de citações inline retornadas por frase.
• Substituição generativa: marcar essa caixa instrui o agente a tentar uma resposta gerada por IA se o repositório de dados retornar um resultado vazio. Se falhar, ele passará para respostas estáticas.
• Respostas estáticas: você pode inserir respostas de texto estáticas no campo final. Elas são enviadas ao usuário palavra por palavra.

Mensagens de resposta específicas do canal

Ao definir o fulfillment, você pode criar mensagens de resposta específicas do canal, para criar respostas segmentadas para chat de texto, voz, SMS, integrações específicas que oferecem suporte a canais e assim por diante. As mensagens de resposta que não são específicas de um canal são chamadas de mensagens de resposta padrão.

Em tempo de execução, o Dialogflow CX seleciona a mensagem de resposta padrão ou uma mensagem específica do canal quando uma solicitação de detecção de intent especifica um canal. Como prática recomendada, defina mensagens de resposta padrão, mesmo que você esteja usando mensagens específicas do canal. As mensagens de resposta padrão podem funcionar como um substituto quando o sistema não consegue fornecer um canal válido.

O nome do canal é um campo personalizado que pode ser definido como qualquer texto. Se você estiver usando a API Dialogflow CX diretamente para chamadas de tempo de execução, poderá usar os nomes de canais que quiser. Se você estiver usando uma integração, use os nomes de canais que ela reconhece.

Definir mensagens de resposta específicas do canal no momento do projeto

Para fornecer mensagens de resposta específicas do canal para o fulfillment ao usar o console:

• Clique em Adicionar canal depois de adicionar as mensagens de resposta padrão. A interface do usuário permite adicionar mensagens de resposta específicas do canal. Clique em Adicionar canal novamente para incluir outro canal.

Para fornecer mensagens de resposta específicas do canal para atendimento ao usar a API:

• Defina o campo Fulfillment.messages[i].channel como o canal desejado para cada mensagem de resposta. Se esse campo não for definido, a resposta será uma mensagem padrão.

Usar mensagens de resposta específicas do canal durante a execução

Observação: se você estiver usando uma integração que já oferece suporte a canais, a implementação da integração vai realizar as etapas abaixo.

Para receber uma mensagem de resposta específica do canal, ele precisa ser especificado na mensagem de solicitação de detecção de intenção. Consulte o campo queryParams.channel no método detectIntent do tipo Sessions. Acessar a referência da API Session

Selecione um protocolo e uma versão para a referência de sessão:

Protocolo	V3	V3beta1
REST	Recurso da sessão	Recurso da sessão
RPC (remote procedure call)	Interface da sessão	Interface da sessão
C++	SessionsClient	Indisponível
C#	SessionsClient	Indisponível
Go	SessionsClient	Indisponível
Java	SessionsClient	SessionsClient
Node.js	SessionsClient	SessionsClient
PHP	Indisponível	Indisponível
Python	SessionsClient	SessionsClient
Ruby	Indisponível	Indisponível

Fechar

Se nenhum canal for definido em uma solicitação ou se nenhum canal correspondente for encontrado no fulfillment, a mensagem de resposta padrão será retornada pelo Dialogflow CX.

Modelos de payload personalizados

Se você usa payloads personalizados com frequência, use modelos de payload personalizados. Os payloads personalizados às vezes são grandes e complexos, então usar modelos pode facilitar o processo de criação de agentes.

Você pode fornecer esses modelos nas configurações do agente, o que os torna disponíveis para seleção sempre que você cria um fulfillment para o agente.

Por exemplo, o payload JSON dos botões "sim" e "não" pode ser definido como modelos de payload personalizados. Ao criar um fulfillment que exige esses botões, basta selecionar o modelo ao criar o fulfillment.

Quando você seleciona um modelo para um payload personalizado de atendimento, o conteúdo do modelo é inserido no payload. Depois, edite a carga útil conforme necessário.

Se você mudar um modelo, a mudança não será propagada automaticamente para todos os payloads de atendimento em que ele foi referenciado.

Para criar um modelo de payload personalizado, consulte as configurações gerais do agente.

Para selecionar um modelo de payload personalizado ao criar uma ação de atendimento, clique em Selecionar modelo ao criar um payload personalizado de atendimento.

Chamadas de webhook

Quando um fulfillment é chamado e tem um webhook, o agente envia uma solicitação ao webhook. O webhook pode realizar as ações necessárias no seu serviço, fornecer uma mensagem de resposta dinâmica, modificar os valores dos parâmetros e alterar a página atual.

A seguir, descrevemos as configurações de webhook para fulfillment:

Termo	Definição
Ativar webhook	Isso ativa o webhook para o fulfillment.
Webhook	Selecione o recurso de webhook.
Tag	A tag de texto fornecida aqui será preenchida no campo WebhookRequest.fulfillmentInfo.tag da solicitação de webhook enviada ao serviço de webhook. Isso pode ser usado para controlar o comportamento do webhook de uma maneira específica para o atendimento.
Retornar resposta parcial	Permite o cancelamento de uma reprodução de resposta parcial. Consulte configurações avançadas de fala para mais detalhes.

Predefinições de parâmetros

É possível usar um fulfillment para fornecer predefinições que definem ou modifiquem os valores de parâmetros atuais. Essas predefinições serão aplicadas antes de resolver mensagens de resposta estática ou chamar um webhook.

Você também pode usar funções do sistema para predefinir o parâmetro para um valor gerado dinamicamente.

Estes são alguns exemplos:

• Como definir um parâmetro now para o horário atual:

  Parâmetro	Valor
  now	$sys.func.NOW()

• Incrementar um parâmetro atual counter em 1:

  Parâmetro	Valor
  Contador	$sys.func.ADD($session.params.counter, 1)

• Definir um parâmetro new-cost como o valor do parâmetro other-cost, mantendo o valor completo do objeto composto:

  Parâmetro	Valor
  new-cost	$sys.func.IDENTITY($session.params.other-cost)

Ferramentas de repositório de dados

Consulte a documentação das ferramentas do repositório de dados para mais informações sobre esse recurso.

Configurações avançadas de fala

Essas configurações avançadas de fala podem substituir as mesmas configurações de fala na página, configurações de fala do fluxo e configurações de fala do agente.

Fila de resposta

Durante a rodada de um agente, é possível (e às vezes desejável) chamar vários fulfillments, e cada um deles pode gerar uma mensagem de resposta. O Dialogflow CX mantém essas respostas em uma fila de respostas.

Resposta parcial para a API Streaming

Por padrão, o Dialogflow CX só envia as respostas ordenadas ao usuário final quando a vez do agente terminar. Também é possível ativar a opção Retornar resposta parcial no fulfillment para retornar respostas na fila como uma resposta parcial ao usar as APIs de streaming. Consulte Ciclo de vida de uma página para mais detalhes.

Por exemplo, se o webhook provavelmente for executado por muito tempo, adicione uma resposta estática no fulfillment e ative a resposta parcial. Isso faz o Dialogflow CX limpar a fila de respostas e enviar todas as mensagens como uma resposta parcial antes de chamar o webhook.

No momento, a resposta parcial não é compatível com o seguinte, mas será compatível posteriormente:

• Entradas de áudio no simulador.
• No momento, as integrações de telefonia de parceiros podem ou não oferecer suporte a respostas parciais. Consulte a documentação do parceiro para verificar.

Para testar esse recurso no simulador, você precisa ativar a resposta parcial.

No exemplo a seguir, considere que o webhook leva cinco segundos para ser concluído e você não ativa a resposta parcial. A vez de conversar com o agente do Dialogflow CX não é concluída até que o webhook seja concluído. Durante essa sequência de cinco segundos, as respostas são colocadas na fila enquanto aguardam o webhook e não são retornadas ao usuário final até que a conversão seja concluída. Isso leva a uma experiência negativa do usuário.

Se você ativar a resposta parcial no primeiro fulfillment, o Dialogflow CX retornará a primeira mensagem rapidamente e chamará o webhook. Depois que o webhook é concluído, o Dialogflow CX retorna a resposta final. Nesse caso, a experiência do usuário final é aprimorada porque é esperado que ele aguarde um curto período. Além disso, a chamada do webhook está sendo executada simultaneamente com a resposta enviada ao usuário final.

Linguagem de marcação de síntese de voz (SSML)

É possível usar a Linguagem de marcação de síntese de fala (SSML) em campos de texto ou de saída de áudio. Isso permite personalizar a resposta de áudio fornecendo detalhes sobre pausas e formatação de áudio para acrônimos, datas, horas, abreviações ou texto que deva ser censurado.

Para mais detalhes sobre a sintaxe, consulte a documentação de SSML do Text-to-Speech.

Observação: um campo de atendimento não pode ter mais de um par de tags <speak></speak>.