Fragmento de carga útil personalizada

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

Use este snippet con acciones que tengan la propiedad customPayload, como Voicebot Exchange o Textbot Conversation. Se usa para transmitir datos desde CXone 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).

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.

Transmitir un marcador de posición

Si usa Amazon Lex V1 o Amazon Lex V2 y no requiere transferir información del agente virtual, siga este ejemplo:

DYNAMIC customPayload 
 customPayload.placeholder=""

Si requiere transferir información al agente virtual, siga el ejemplo en la siguiente sección.

Transmitir datos

Con cualquier proveedor de agentes virtuales, siga este ejemplo para transmitir información al agente virtual. Reemplace los parámetros del ejemplo con la información que necesite transmitir.


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

Práctica recomendada para la carga útil personalizada de Google Dialogflow CX

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 o Conversation de su script, configure la propiedad customPayload con una variable que tenga 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. Asigne esto a su script usando la variable customPayloadVarName (out) en la acción Studio de voz o chat en su script. Por ejemplo, puede usar esto para configurar los Comportamientos del siguiente indicador.
Los parámetros definidos con customPayload solo se pueden usar en el webhook externo. Si desea establecer parámetros para usar fuera del webhook externo, configúrelos en una acción Snippet con el campo session_params. Por ejemplo:
```
{
	"session_params":
	{ 
		"name": "Winnie Le Pooh"
		"job": "Food critic"
		"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.
Es posible transmitir Sugerencias de contexto de voz con carga útil personalizada en el parámetro speechContexts. El valor de speechContexts.phrases debe ser un 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. Por ejemplo:
```
DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10		
```
Al usar VOICEBOT EXCHANGE: Para configurar cuánto tiempo debe esperar el agente virtual cuando el contacto hace una pausa al hablar, agregue el parámetro maxPostEnergySilenceMS a la acción de Snippet Next Prompt Behaviorso Default Next Prompt Behaviors.

Práctica recomendada para la carga útil personalizada de Google Dialogflow ES

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.
Es posible transmitir Sugerencias de contexto de voz con carga útil personalizada en el parámetro speechContexts. El valor de speechContexts.phrases debe ser un 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. Por ejemplo:
```
DYNAMIC customPayload
customPayload.speechContexts.phrases="$OOV_CLASS_ALPHANUMERIC_SEQUENCE"
customPayload.speechContexts.boost=10		
```