Snippet de carga útil personalizada

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

Use este snippet com ações que tenham a propriedade customPayload, como Voicebot Exchange ou Textbot Conversation. É usado para passar dados do CXone 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).

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.

Passar um espaço reservado

Caso use o Amazon Lex V1 ou Amazon Lex V2 e não precise passar informações para o agente virtual, siga este exemplo:

DYNAMIC customPayload 
 customPayload.placeholder=""

Se precisar passar informações para o agente virtual, siga o exemplo na próxima seção.

Passar dados

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


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

Boas práticas para a carga útil personalizada do Google Dialogflow CX

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 ou Conversation no seu 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. Mapeie isso para o seu script usando a variável customPayloadVarName (out) na ação voice ou chat Studio no seu script. Por exemplo, você pode usar isso para definir os comportamentos do próximo prompt.
Os parâmetros definidos usando customPayload só podem ser usados no webhook externo. Se você quiser definir parâmetros para uso fora do webhook externo, defina-os em uma ação Snippet com o campo session_params. Por exemplo:
```
{
	"session_params":
	{ 
		"name": "Winnie Le Pooh"
		"job": "Food critic"
		"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.
Dicas de contexto de fala pode ser passadas com carga útil personalizada no parâmetro speechContexts. O valor de speechContexts.phrases deve ser um token da classe Google 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		
```
Quando estiver usando VOICEBOT EXCHANGE: Para configurar quanto tempo o agente virtual espera quando o contato pausa enquanto fala, adicione o parâmetro maxPostEnergySilenceMS à ação Next Prompt Behaviors ou Default Next Prompt Behaviors Snippet.

Boas práticas para a carga útil personalizada do Google Dialogflow ES

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.
Dicas de contexto de fala pode ser passadas com carga útil personalizada no parâmetro speechContexts. O valor de speechContexts.phrases deve ser um token da classe Google 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		
```