Fragmento de carga útil personalizada

La información de esta página de ayuda aplica tanto a Studio como a Desktop Studio.

El fragmentoCarga útil personalizada es necesario en su secuencia de comandos cuando se utilizan acciones que tienen la propiedad customPayload, como Voicebot Exchange o Textbot Conversation. Se usa para transmitir datos desde CXone Mpower a su proveedor de agentes virtuales Una aplicación de software que maneja las interacciones del cliente en lugar de un agente humano en vivo.. Si necesita recibir datos personalizados de su agente virtual, use la variable customPayloadVarName (out). Utilice la información de esta página para crear el fragmento de carga útil personalizada que cumpla con los requisitos de la implementación del agente virtual de su organización.

Este fragmento es necesario para los siguientes agentes virtuales:

Amazon Lex V1 y Amazon Lex V2: Se requiere el snippet de Carga Personalizada para Lex V1 y Lex V2 incluso si no requiere transferir datos al agente virtual. El agente virtual utiliza los datos que se transfieren mediante la propiedad customPayload para completar la propiedad SessionAttributes en el lado Amazon.
Google Dialogflow ES: la Carga útil personalizada transmite información contextual que utiliza el agente virtual ES de Dialogflow para determinar la intención El significado o propósito detrás de lo que dice/escribe un contacto; lo que el contacto quiere comunicar o lograr.. Siga los mejores prácticas recomendadas para integrar datos de carga útil personalizados con Google Dialogflow ES.

Para todos los demás agentes virtuales, solo debe incluir el fragmento si tiene datos de carga útil personalizada que necesita transmitir al bot. Si está usando Dialogflow CX, siga las prácticas recomendadas para incluir la carga útil personalizada. Si no incluye un fragmento de carga útil personalizado, asegúrese de pasar un parámetro de marcador de posición.

Transmitir un marcador de posición

Si utiliza un agente virtual que no necesita que se le pase información, como Amazon Lex V2 o Amazon Lex V1, siga este ejemplo:

DYNAMIC customPayload 
 customPayload.placeholder=""

Transmitir datos

Para todos los proveedores de agentes virtuales que deben pasar información al agente virtual, siga este ejemplo. Reemplace los parámetros del ejemplo con la información que necesite transmitir.

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 CX no usa contextos para pasar datos a Dialogflowintenciones El significado o propósito detrás de lo que dice/escribe un contacto; lo que el contacto quiere comunicar o lograr. como Dialogflow ES lo hace.
Puede pasar datos personalizados aDialogflow CX usando pares clave-valor JSON. En una acción de Snippet action en su script, cree un objeto dinámico customPayload y agréguele los pares clave-valor. Por ejemplo:
```
DYNAMIC customPayload
customPayload.ani = ani
customPayload.contactID = contactId
customPayload.masterContactId = masterId
customPayloadJSON = "{customPayload.asJSON()}"	
```
En la acción Exchange de su script, configure la propiedad customPayload con la variable que tiene la función asJSON() en su valor. Puede encontrar esta variable en el objeto customPayload.
Transmita el JSON de customPayload al agente virtual usando la propiedad Payload de QueryParameters. Consulte la documentación de Google sobre QueryParameters para Google Dialogflow CX.
Los datos transmitidos a través de QueryParameters son recibidos por un webhook en Dialogflow CX. Puede escribir código en la Dialogflow Consola CX para manejar los datos pasados.
No inserte un objeto dentro del objeto customPayload. Los objetos insertados se envían como cadenas literales.
Para transmitir datos personalizados desde su agente virtual Dialogflow CX devuelta al l script, usa el campo Carga útil personalizada en la consola Dialogflow CX. Asegúrese de estar en la consola del agente virtual que está usando con CXone Mpower. Asigne esto a su script usando la variable customPayloadVarName (out) en la acción VOICEBOT EXCHANGE o TEXTBOT EXCHANGE Studio en su script. Por ejemplo, puede usar esto para configurar los Comportamientos del siguiente indicador.
Para pasar datos personalizados a Dialogflow CX desde el script, utilice session_params en el objeto customPayload en una acción Snippet. Por ejemplo:
```
DYNAMIC customPayload
customPayload.session_params.name = "Winnie le Pooh" 
customPayload.session_params.job = "Food critic" 
customPayload.session_params.location = "Hundred Acre Wood"	
```
Accede a los parámetros de la sesión en la DialogflowIntención del agente CX con la siguiente sintaxis:
```
$session.params.name = Winnie Le Pooh
$session.params.job = Food critic
$session.params.location = 100 Acre Wood
                
```
Los parámetros de sesión solo se utilizan con los agentes virtuales Dialogflow CX. Para lograr un resultado similar con Dialogflow ES, use contextos.
Configure sugerencias de contexto de voz y un ID de conversación personalizadopara transferir la conversación a un Dialogflow agente virtual CX diferente en el fragmento de Carga útil personalizada.
Al usar VOICEBOT EXCHANGE: Para configurar cuánto tiempo debe esperar el agente virtual cuando el contacto hace una pausa al hablar, agregue el maxPostEnergySilenceMSparámetro a la acción de Next Prompt Behaviors Default Next Prompt Behaviorso Snippet.

Consejos para el contexto del habla paraDialogflow CX

Las sugerencias de contexto de voz se pueden pasar en el fragmento Carga útil personalizada en el parámetro speechContexts. El valor de speechContexts.phrases debe ser un token de clase de Google Un cuadrado con una flecha que apunta desde el centro hacia la esquina superior derecha. para la sugerencia que desea ofrecer. El token debe coincidir con el idioma y la configuración regional de sus contactos. Por ejemplo:

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

Configure estos parámetros de la siguiente manera:

speechContexts.phrases: El token de clase de Google para la sugerencia que desea ofrecer. El token debe coincidir con el idioma y la configuración regional de sus contactos. Si desea agregar varios tokens, añada un parámetro de speechContexts.phrases para cada uno.
speechContexts.boost: Un valor numérico ponderado entre 1 y 20 para la phrase especificada. El servicio de transcripción utiliza este valor al seleccionar una transcripción posible para las palabras en los datos de audio. Cuanto mayor sea el valor, mayor será la probabilidad de que el servicio de transcripción elija esa palabra o frase antes que las alternativas.

Puede ver el contenido de este parámetro en los seguimientos y registros de aplicación de Studio.

Transferir contactos entre Dialogflow agentes virtuales de CX

Para configurar la transferencia de un contacto de un Dialogflow agente virtual CX a otro Dialogflow agente virtual CX, incluya la siguiente línea en el fragmento Carga útil personalizada. Reemplace custom_value con el nombre de la variable que contiene el ID de la conversación:

{
  “cxone_override_conversation“: {custom_value} 
}

Asegúrese de configurar su script para completar la variable que utiliza con este parámetro.

Su guión debe configurarse con cuidado para que

El parámetro cxone_override_conversation es similar al ID del estado de sesión del bot establecido en el fragmento Estado de sesión del bot . Ambos ayudan al agente virtual a mantener el contexto de la conversación entre turnos. Su script debe configurarse con cuidado para que los valores de ID de estado de sesión y de ID de conversación del bot aparezcan en las ubicaciones correctas. El estado de la sesión del bot siempre tiene prioridad sobre el parámetro cxone_override_conversation. Configure su script de la siguiente manera:

Agente virtual n.°	Doblar #	Configuración
1	1	La propiedad botSessionState de la acción Voicebot EXCHANGEo Textbot EXCHANGE está vacía. El turno devuelve un ID de estado de sesión de bot y completa botSessionStateVarName (out). Este es el ID de estado de sesión del bot n.° 1.
1	2 y posteriores turnos con este agente virtual	El script envía el ID de estado de sesión de bot n.° 1 al agente virtual CX n.° 1 Dialogflow. Se devuelve el mismo ID al script.
2	3 (primero con este agente virtual)	La propiedad botSessionState de la acción Voicebot EXCHANGEo Textbot EXCHANGE está vacía. El fragmento de carga útil personalizado para este turno contiene cxone_override_conversation = [variable]. El turno devuelve un ID de estado de sesión de bot único y completa botSessionStateVarName (out), anulando cualquier valor que ya contenga. Este es el ID de estado de sesión del bot n.° 2.
2	4 (segundo turno con este agente virtual)	El script envía el ID de estado de sesión de bot n.° 2 al agente virtual CX n.° 2 Dialogflow. Se devuelve el mismo ID al script.

Si utiliza más de dos instancias de Dialogflow CX, el patrón continúa como se establece en la tabla anterior.

Este método de transferencia entre agentes virtuales solo es necesario cuando se transfiere entre dos o más agentes virtuales CX Dialogflow. Si está transfiriendo entre otros proveedores de agentes virtuales, puede utilizar elID de estado de sesión de bot.

Google Dialogflow ES Carga útil personalizada

CustomPayload se utiliza para pasar el contexto de una intención El significado o propósito detrás de lo que dice/escribe un contacto; lo que el contacto quiere comunicar o lograr.. El contexto ayuda al agente virtual a comprender la intención del usuario. Los contextos no son obligatorios, pero ayudan al agente virtual a relacionar un enunciado Lo que dice o escribe un contacto. con una intención.
En una acción de Snippet en su script, cree un objeto customPayload que siga el formato descrito en la documentación de Google Dialogflow ES para recursos REST: projects.agent.sessions.context. La ayuda en línea de Studio ofrece más información sobre los objetos de datos dinámicos.
También puede transmitir datos personalizados con customPayload sin contextos. Para hacerlo, incluya pares clave-valor JSON estándar en un objeto dinámico de datos.
Los contextos de voz se transmiten en la carga útil personalizada del parámetro speech_contact. Puede ver el contenido de este parámetro en los seguimientos y registros de aplicación de Studio.
El objeto dinámico customPayload se transmite como un parámetro de agente virtual en formato JSON, como se observa en el script de ejemplo.
Configure las sugerencias de contexto de voz en el fragmento Carga útil personalizada.

Consejos para el contexto del habla para DialogflowES

Sugerencias de contexto de voz se pueden pasar en el fragmento Carga útil personalizada en el parámetro speechContexts. El valor de speechContexts.phrases debe ser un token de clase de Google Un cuadrado con una flecha que apunta desde el centro hacia la esquina superior derecha. para la sugerencia que desea ofrecer. El token debe coincidir con el idioma y la configuración regional de sus contactos. Por ejemplo:

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

Configure estos parámetros de la siguiente manera:

speechContexts.phrases: El token de clase de Google para la sugerencia que desea ofrecer. El token debe coincidir con el idioma y la configuración regional de sus contactos. Si desea agregar varios tokens, añada un parámetro de speechContexts.phrases para cada uno.
speechContexts.boost: Un valor numérico ponderado entre 1 y 20 para la phrase especificada. El servicio de transcripción utiliza este valor al seleccionar una transcripción posible para las palabras en los datos de audio. Cuanto mayor sea el valor, mayor será la probabilidad de que el servicio de transcripción elija esa palabra o frase antes que las alternativas.

Puede ver el contenido de este parámetro en los seguimientos y registros de aplicación de Studio.