Snippet de carga útil personalizada

As informações nesta página de ajuda são aplicáveis tanto ao Studio quanto ao Desktop Studio.

O snippet Carga útil personalizada é exigido no seu script ao usar ações que têm a propriedade customPayload, como Voicebot Exchange ou Textbot Conversation. É usado para passar dados do CXone Mpower para o seu fornecedor de agente virtual Um aplicativo de software que interage com os clientes no lugar de um agente humano ao vivo.. Caso precise receber dados personalizados do seu agente virtual, use a variável customPayloadVarName (out). Use as informações desta página para criar o Carga útil personalizada snippet que atenda aos requisitos da implementação do agente virtual da sua organização.

Este snippet é necessário para os seguintes agentes virtuais:

Amazon Lex V1 e Amazon Lex V2: o snippet Carga útil personalizada é necessário para Lex V1 e Lex V2 mesmo que você não precise passar dados para o agente virtual. O agente virtual usa os dados passados pela propriedade customPayload para preencher a propriedade SessionAttributes na parte da Amazon.
Google Dialogflow ES: A carga útil personalizada passa informação de contexto que o agente virtual Dialogflow ES usa para determinar a intenção O significado ou propósito por trás do que um contato diz/digita; o que o contato quer comunicar ou alcançar.. Siga as práticas recomendadas para integrar dados de carga útil personalizados com Google Dialogflow ES.

Para todos os outros agentes virtuais, você precisa apenas incluir o snippet se tiver dados de carga útil personalizada para passar ao bot. Se estiver usando o Dialogflow CX, siga as práticas recomendadas para incluir carga útil personalizada. Se você não estiver incluindo um snippet de carga útil personalizado, certifique-se de passar um parâmetro de posição reservado.

Passar um espaço reservado

Se você usa um agente virtual que não precisa de informações passadas a ele, como Amazon Lex V2 ou Amazon Lex V1, siga este exemplo:

DYNAMIC customPayload 
 customPayload.placeholder=""

Passar dados

Para todos os provedores de agente virtual que devem passar informações para o agente virtual, siga este exemplo. Substitua os parâmetros no exemplo com a informação que precisa passar.

DYNAMIC customPayload
ASSIGN customPayload.context.id="information"
ASSIGN customPayload.context.lifespan=1
ASSIGN customPayload.context.parameters.name="Fenrir"
ASSIGN customPayload.context.parameters.age="19"
ASSIGN customPayload.context.parameters.date="20201020"

Google Dialogflow CX Carga útil personalizada

Dialogflow O CX não usa contextos para passar dados para Dialogflowintents O significado ou propósito por trás do que um contato diz/digita; o que o contato quer comunicar ou alcançar. como o DialogflowES faz.
Você pode passar dados personalizados para o CX Dialogflowusando pares de valores-chave JSON. Em uma action ação Snippet no seu script, crie um objeto customPayload dinâmico e adicione os pares de chave-valor a ele. Por exemplo:
```
DYNAMIC customPayload
customPayload.ani = ani
customPayload.contactID = contactId
customPayload.masterContactId = masterId
customPayloadJSON = "{customPayload.asJSON()}"	
```
Na ação Exchange no script, configure a propriedade customPayload com a variável que tem a função asJSON() em seu valor. Você pode encontrar essa variável no objeto customPayload.
Passe o JSON customPayload para o agente virtual usando a propriedade Payload de QueryParameters. Consulte a documentação do Google sobre QueryParameters para Google Dialogflow CX.
Os dados passados por QueryParameters são recebidos por um webhook no Dialogflow CX. Você pode escrever código no console CX Dialogflowpara manipular os dados passados.
Não aninhe um objeto dentro do objeto customPayload. Os objetos são enviados como strings literais.
Para passar dados personalizados do agente virtual Dialogflow CX de volta ao script, use o campo Carga útil personalizada no console Dialogflow CX. Verifique se você está no console do agente virtual que está usando CXone Mpower. Mapeie isso para o seu script usando a variável customPayloadVarName (out) na ação VOICEBOT EXCHANGE ou TEXTBOT EXCHANGE Studio do seu script. Por exemplo, você pode usar isso para definir os comportamentos do próximo prompt.
Para passar dados personalizados para Dialogflow CX a partir do script, use session_params no objeto customPayload em uma ação Snippet. Por exemplo:
```
DYNAMIC customPayload
customPayload.session_params.name = "Winnie le Pooh" 
customPayload.session_params.job = "Food critic" 
customPayload.session_params.location = "Hundred Acre Wood"	
```
Acesse os parâmetros de sessão no intent do agente CX Dialogflow usando a seguinte sintaxe:
```
$session.params.name = Winnie Le Pooh
$session.params.job = Food critic
$session.params.location = 100 Acre Wood
                
```
Os parâmetros de sessão são usados apenas com agentes virtuais Dialogflow CX. Para obter um resultado semelhante com Dialogflow ES, use contextos.
Configure dicas de contexto de fala e um ID de conversa personalizadopara transferir a conversa para um agente virtual Dialogflow CX diferente no Carga útil personalizada snippet.
Quando estiver usando VOICEBOT EXCHANGE: Para configurar quanto tempo o agente virtual espera quando o contato pausa enquanto fala, adicione o parâmetromaxPostEnergySilenceMS à ação Next Prompt Behaviors ou Default Next Prompt Behaviors Snippet.

Dicas de Contexto de fala paraDialogflow CX

Dicas de contexto de fala podem ser passadas no snippet Carga útil personalizada no parâmetro speechContexts. O valor de speechContexts.phrases deve ser um token da classe Google Um quadrado com uma seta apontando do centro para o canto superior direito. para a dica que você quer dar. O token deve corresponder ao idioma e à localidade dos seus contatos. Por exemplo:

DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10

Configure esses parâmetros da seguinte maneira:

speechContexts.phrases: O token da classe Google para a dica que você quer dar. O token deve corresponder ao idioma e à localidade dos seus contatos. Se quiser adicionar vários tokens, adicione um parâmetro speechContexts.phrases para cada token.
speechContexts.boost: Um valor numérico ponderado entre 1 e 20 para o phrase especificado. O serviço de transcrição usa esse valor ao selecionar uma possível transcrição para palavras nos dados de áudio. Quanto maior o valor, maior a probabilidade de o serviço de transcrição escolher aquela palavra ou frase dentre as alternativas.

Você pode ver o conteúdo desse parâmetro em rastreios do Studio e logs do aplicativo.

Transferir contatos entre Dialogflow CX Agentes virtuais

Para configurar a transferência de um contato de um agente virtual CX Dialogflow para outro Dialogflow agente virtual CX, inclua a seguinte linha no snippet Carga útil personalizada. Substitua custom_value pelo nome da variável que contém o ID da conversa:

{
  “cxone_override_conversation“: {custom_value} 
}

Certifique-se de configurar seu script para preencher a variável que você usa com este parâmetro.

Seu script deve ser configurado com cuidado para que o

O parâmetro cxone_override_conversation é semelhante ao ID de estado da sessão do bot definido no Bot Session State snippet. Ambos ajudam o agente virtual a manter o contexto da conversa entre os turnos. Seu script deve ser configurado com cuidado para que os valores de ID de estado da sessão do bot e ID da conversa apareçam nos locais corretos. O estado da sessão do bot sempre tem precedência sobre o parâmetro cxone_override_conversation. Configure seu script da seguinte maneira:

Agente virtual #	Virar #	Configuração
1	1	A propriedade botSessionState da ação Voicebot EXCHANGEou Textbot EXCHANGE está vazia. O turno retorna um ID de estado de sessão de bot e preenche botSessionStateVarName (out). Este é o ID de estado da sessão do bot #1.
1	2 e posteriores turnos com este agente virtual	O script envia o ID #1 do estado da sessão do bot para o agente virtual Dialogflow CX #1. O mesmo ID é retornado ao script.
2	3 (primeiro com este agente virtual)	A propriedade botSessionState da ação Voicebot EXCHANGEou Textbot EXCHANGE está vazia. O snippet de carga útil personalizada para esse turno contém cxone_override_conversation = [variable]. O turno retorna um ID de estado de sessão de bot exclusivo e preenche botSessionStateVarName (out), substituindo qualquer valor que ele já contenha. Este é o ID #2 do estado da sessão do bot.
2	4 (segundo turno com este agente virtual)	O script envia o ID #2 do estado da sessão do bot para o agente virtual Dialogflow CX #2. O mesmo ID é retornado ao script.

Se você usar mais de duas instâncias do Dialogflow CX, o padrão continuará conforme estabelecido na tabela anterior.

Este método de transferência entre agentes virtuais só é necessário ao transferir entre dois ou mais agentes virtuais Dialogflow CX. Se estiver transferindo entre outros provedores de agente virtual, você pode usar oBot Session ID do estado.

Google Dialogflow ES Carga útil personalizada

CustomPayload é usado para passar contexto para uma intenção O significado ou propósito por trás do que um contato diz/digita; o que o contato quer comunicar ou alcançar.. O contexto ajuda o agente virtual a entender a intenção do usuário. Os contextos não são obrigatórios, mas ajudam o agente virtual corresponder um enunciado O que um contato diz ou digita. a uma intenção.
Em uma ação Snippet em seu script, crie um objeto customPayload que segue o formato descrito na documentação do Google Dialogflow ES para o recurso REST: projects.agent.sessions.context. A ajuda online do Studio fornece informações adicionais sobre objetos de dados dinâmicos.
Você também pode passar dados personalizados com customPayload sem contextos. Para fazer isso, inclua pares de chave-valor JSON padrão em um objeto de dados dinâmicos.
Os contextos de fala são passados na carga útil personalizada no parâmetro speech_contact. Você pode ver o conteúdo desse parâmetro em rastreios do Studio e logs do aplicativo.
O objeto dinâmico customPayload é passado como um parâmetro de agente virtual como JSON, conforme mostrado no script de exemplo.
Configure dicas de contexto de fala no Carga útil personalizada snippet.

Dicas de Contexto de fala para DialogflowES

DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10

Configure esses parâmetros da seguinte maneira:

speechContexts.phrases: O token da classe Google para a dica que você quer dar. O token deve corresponder ao idioma e à localidade dos seus contatos. Se quiser adicionar vários tokens, adicione um parâmetro speechContexts.phrases para cada token.
speechContexts.boost: Um valor numérico ponderado entre 1 e 20 para o phrase especificado. O serviço de transcrição usa esse valor ao selecionar uma possível transcrição para palavras nos dados de áudio. Quanto maior o valor, maior a probabilidade de o serviço de transcrição escolher aquela palavra ou frase dentre as alternativas.

Você pode ver o conteúdo desse parâmetro em rastreios do Studio e logs do aplicativo.