Snippet de carga útil personalizada

As informações desta página de ajuda se aplicam tanto a Studio quanto a Desktop Studio.

O snippet Carga útil personalizada é necessário no seu script ao usar ações que têm a propriedade customPayload, como Voicebot Exchange ou Textbot Conversation. É usado para passar dados de NiCE CXone para o seu provedor de agente virtualClosed Um aplicativo de software que gerencia as interações com 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 Snippet Carga útil personalizada que atenda aos requisitos da implementação do agente virtual da sua organização.

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

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

Passar um espaço reservado

Se você usar um agente virtual que não precisa que informações sejam transmitidas 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 precisam passar informações ao 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

  • Você pode passar dados personalizados para Dialogflow CX usando pares de chave-valor JSON. Em uma Snippet ação no seu script, crie um objeto dinâmico customPayload 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()}"	
  • Transmita a customPayload JSON para o agente virtual usando a propriedade Payload de QueryParameters. Consulte a documentação de Google sobre QueryParameters A square with an arrow pointing from the center out from the top right corner. para Google Dialogflow CX.
  • Dados transmitidos por meio de QueryParameters são recebidos por um webhook em 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 para o 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.

  • Configurar dicas de contexto de fala e um ID de conversa personalizado para transferir a conversa para um agente virtual Dialogflow CX diferente no snippet Carga útil personalizada .

Dicas de Contexto de fala para Dialogflow 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 de classe Google A square with an arrow pointing from the center to the upper right corner. para a dica que você deseja fornecer. O token deve corresponder ao idioma e ao local de seus contatos. Por exemplo:

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

Configure estes parâmetros da seguinte forma:

  • speechContexts.phrases: O token de classe Google Um quadrado com uma seta apontando do centro para o canto superior direito. para a dica que você deseja fornecer. O token deve corresponder ao idioma e local dos seus contatos. Se você quiser adicionar vários tokens, adicione um parâmetro speechContexts.phrases para cada token.
  • speechContexts.boost: Um valor numérico ponderado entre 1-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 essa palavra ou frase entre as alternativas.

Você pode ver o conteúdo deste parâmetro em Studio rastreamentos e nos registros de aplicativos.

Transferência de contatos entre Agentes virtuais de CX do Dialogflow

Para configurar a transferência de um contato de um agente virtual Dialogflow CX para outro agente virtual Dialogflow CX, inclua a seguinte linha no snippet de 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 esse parâmetro.

O seu script deve ser configurado cuidadosamente para que o

O parâmetro cxone_override_conversation é semelhante ao id do estado da sessão do bot definido no Bot Session State Snippet. Ambos ajudam o agente virtual a manter o contexto da conversa entre turnos. O seu script deve ser configurado com cuidado para que os valores do id do estado da sessão do bot e do 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 o seu script da seguinte forma:

Agente virtual # Turno nº Configuração
1 1 A propriedade botSessionState da ação Voicebot EXCHANGE ou Textbot EXCHANGE está vazia. O turno retorna um ID de estado de sessão do bot e preenche botSessionStateVarName (out). Este é o id do estado de sessão do bot nº 1.

1

2 e turnos posteriores com este agente virtual O script envia o id do estado da sessão do bot #1 para o agente virtual CX Dialogflow nº 1. O mesmo ID é retornado ao script.
2 3 (primeiro com este agente virtual)

A propriedade botSessionState da ação Voicebot EXCHANGE ou Textbot EXCHANGE está vazia.

A Snippet de carga útil personalizada para esta interação 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 já contenha. Este é o id do estado de sessão de bot nº 2.

2 4 (segundo turno com este agente virtual) O script envia o id do estado da sessão do bot #2 para o agente virtual CX Dialogflow #2. O mesmo ID é retornado ao script.

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

Esse método de transferência entre agentes virtuais é necessário somente ao transferir entre dois ou mais agentes virtuais Dialogflow CX. Se você estiver transferindo entre outros provedores de agentes virtuais, você pode usar o Id do estado de sessão do bot.

Google Dialogflow ES Carga útil personalizada

  • CustomPayload é usado para passar contexto para uma intençãoClosed O significado ou a finalidade por trás do que um contato diz/digita; o que o contato deseja comunicar ou realizar.. 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 enunciadoClosed O que um contato diz ou digita. a uma intenção.
  • Em uma ação de Snippet no seu script, crie um objeto customPayload que segue o formato descrito na documentação do Google Dialogflow ES Ícone indicando que o link leva a um site externo para REST Resource: 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 rastreamentos de Studio e logs de aplicativo.
  • O objeto dinâmico customPayload é passado como um parâmetro de agente virtual como JSON, conforme mostrado no script de exemplo.
  • Configure as dicas de contexto de fala no snippet Carga útil personalizada .

Dicas de Contexto de fala para Dialogflow ES

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 de classe Google A square with an arrow pointing from the center to the upper right corner. para a dica que você deseja fornecer. O token deve corresponder ao idioma e ao local de seus contatos. Por exemplo:

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

Configure estes parâmetros da seguinte forma:

  • speechContexts.phrases: O token de classe Google Um quadrado com uma seta apontando do centro para o canto superior direito. para a dica que você deseja fornecer. O token deve corresponder ao idioma e local dos seus contatos. Se você quiser adicionar vários tokens, adicione um parâmetro speechContexts.phrases para cada token.
  • speechContexts.boost: Um valor numérico ponderado entre 1-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 essa palavra ou frase entre as alternativas.

Você pode ver o conteúdo deste parâmetro em Studio rastreamentos e nos registros de aplicativos.