VOICEBOT EXCHANGE

Esta página de ayuda es para Studio. Esta información también está disponible para Desktop Studio.

Integra un agente virtual Una aplicación de software que maneja las interacciones del cliente en lugar de un agente humano en vivo. de autoservicio con guiones de voz. Esta acción se utiliza en un bucle en el script. Un script debe contener al menos dos accionesVoiceBot Exchange . Su agente virtual debe respaldar esta acción.

El Voicebot Exchange acción es para agentes virtuales complejos o cuando necesite personalizar el comportamiento del agente virtual de turno a turno. Supervisa la conversación entre el contacto y el agente virtual, turno por turno. Envía cada expresión Lo que un contacto dice o escribe. transcrita al agente virtual. El agente virtual analiza el enunciado para detectar la intención El significado o propósito detrás de lo que dice o escribe un contacto; lo que el contacto desea comunicar o lograr. y el contexto y determina qué respuesta ofrecer. La acción transfiere la respuesta del agente virtual al contacto. Cuando la conversación ha finalizado, la acción continúa el script.

Si desea configurar interrupción o sin entrada, se requiere programación adicional.

Al hacer doble clic en esta acción, abre la Virtual Agent Hub, donde podrá gestionar todos sus agentes virtuales.

Dependencias

Un script debe contener al menos dos acciones VoiceBot Exchange conectadas en un ciclo.
Para usar esta acción, su agente virtual debe ser compatible con la personalización de conversaciones turno a turno.
Un turno conversacional se define como:
1. La expresión de contacto que se envía al agente virtual.
2. El agente virtual procesa la expresión y define cualquier información de carga útil personalizada.
3. La respuesta regresa al contacto.
4. Cualquier acción adicional que deba adoptarse (como una base de datos o una llamada API externa) que se determina en la propiedad nextPromptBehaviors. También puede configurar el ciclo conversacional para salir cuando se completa la interacción o si se transfiere el contacto a un agente en vivo.
Si incluye una carga útil personalizada con los agentes virtuales Google Dialogflow ES o Google Dialogflow CX, siga las mejores prácticas y pautas de carga útil personalizada. En esta página se presentan las pautas para CX y ES.

Tipos de script compatibles

Phone

Comparación de Acciones similares

Las siguientes acciones tienen funciones similares, pero con algunas diferencias clave:

Textbot Exchange: This action is used for complex virtual agent interactions. It allows you to include exchange parameters and to customize various aspects of the conversation between contact and virtual agent.
Voicebot Exchange: This action is used for complex virtual agent interactions. It allows you to include exchange parameters and to customize various aspects of the conversation between contact and virtual agent.
VOICEBOT STREAM: This action supports real-time audio streaming between NiCE CXone and the virtual agent provider. It does not support customization of the conversation between turns. Currently, the only supported virtual agent is Google Dialogflow CX VoiceStream.

Agentes virtuales compatibles

This action supports the following virtual agents:

Amazon Lex V1
Amazon Lex V2
Google Dialogflow CX (only for utterance-based connections)
Google Dialogflow ES

Before you can assign a virtual agent to this action, you must add and configure an app for the virtual agent in Virtual Agent Hub. You only need one app for each virtual agent you use. You can assign the same app to multiple virtual agent actions in your scripts. Refer to the help page for the virtual agent provider you're using for configuration details.

Other virtual agent providers may be supported, but require custom integrations. These include DEVone and custom endpoints integrations. Custom integrations are not set up using Virtual Agent Hub.

Propiedades de Entrada

Estas propiedades definen los datos que utiliza la acción al ejecutarse.

Una o más de las propiedades de esta acción requiere una acción Snippet con el siguiente código personalizado.

Las propiedad	Descripción
Add Caption	Ingrese una frase corta que identifique de forma única esta acción en el script. La leyenda aparece en el lienzo del script debajo del ícono de acción.
ID de agente virtual	El nombre del agente virtual seleccionado en el Virtual Agent Hub. Cuando asigna una aplicación de agente virtual a una acción Studio en Virtual Agent Hub, esta propiedad se rellena de forma automática. El nombre es el valor utilizado en el campo Virtual Agent (Bot) Name de la aplicación Virtual Agent Hub. Puede utilizar la sustitución de variables en esta propiedad.
Carga útil personalizada	Configure this property only if you need to pass custom payload data to the virtual agent. The custom payload object is populated from the Studio script. You can use it to pass information such as the contact's name from a CRM sistemas de Terceros que administran cosas como contactos, información de ventas, detalles de soporte e historiales de casos. to be used in a Welcome message. Enter the name of the JSON object that passes data from the script to the virtual agent. You must define the custom payload object in a Snippet action. The object must be converted to JSON, either in the snippet or in the customPayload property. Requirements for specific virtual agent providers: Amazon Lex V1: This property is required even if you don't need to pass data to the virtual agent. Add a snippet with a placeholder value. Google Dialogflow ES: This property is used to pass the context for an intent El significado o propósito detrás de lo que dice o escribe un contacto; lo que el contacto desea comunicar o lograr.. Review the best practices for custom payload with Google Dialogflow ES to ensure you handle it appropriately. Google Dialogflow CX: Review the best practices for custom payload with Google Dialogflow CX to ensure you handle it appropriately. Don't use this property if you need to process data that the virtual agent returns to the script. Instead, use the customPayloadVarName (out) variable.
Secuencia del siguiente mensaje	La respuesta recibida desde el agente virtual que se reproducirá para que escuche el contacto. Configure esta propiedad con la variable que se especifica en nextPromptSequenceVarName (out) con la función asJSON(). También puede convertir el contenido de nextPromptSequenceVarName (out) a JSON en una acción Snippet y configurar esta propiedad con la variable que contenga el JSON.
Comportamientos del siguiente aviso	Especifica la configuración y el comportamiento del siguiente aviso en una conversación. Defina los comportamientos que desee ver usando una acción Snippet y siguiendo el ejemplo del fragmento Comportamientos predeterminados del siguiente aviso o Comportamientos del siguiente aviso. Este ejemplo describe las propiedades que puede usar para configurar el ruido de confort, la recopilación de DTMF y permitir que el contacto hable sobre el audio mientras se reproduce (barcaza). Configurar la propiedad nextPromptBehavior con el nombre del objeto que usó en el código del snippet. Esto transfiere la configuración a esta propiedad y a su acción. Por ejemplo, usando el ejemplo del snippet de Comportamiento del Siguiente Mensaje, ingresaría {nextPromptBehaviorsOutjson} para esta propiedad. Únicamente necesita configurar esta propiedad si usa esta acción para permitir que un agente virtual de textos gestione las interacciones de voz.
Estado de la sesión del bot	Configure con la variable que contiene el identificador único para la conversación entre el contacto y el agente virtual. El proveedor de agentes virtuales la asigna automáticamente. El identificador evita que se cree una sesión nueva con cada turno de la conversación y ayuda al agente virtual a mantener el contexto entre los turnos. El proveedor crea el identificador cuando comienza la conversación y lo pasa al script con la primera respuesta. El script almacena el identificador en la variable nombrada en la propiedad botSessionStateVarName (out) de esta acción. Por último, el script transmite el identificador de la propiedad botSessionStateVarName (out) del turno anterior a la propiedad botSessionState. Sus scripts nunca se deben escribir en esta propiedad ni en su variable. Se debe configurar su script correctamente para usar el identificador de estado de la sesión del bot.
Intención automatizada	Ingrese por nombre una intención específica a la que responda el agente virtual, en lugar de que el agente virtual interprete la entrada del usuario. Un caso de uso común de esto es obtener el mensaje de Bienvenida inicial del Agente virtual. Welcome es la cadena estándar para los saludos iniciales.

Propiedades de Salida

Estas propiedades contienen variables que incluyen datos que se evuelven al ejecutar la acción. Están disponibles como referencia y para usarse cuando se completa la acción.

Las propiedad	Descripción
Nombre de variable de Comportamientos del siguiente aviso	Define los comportamientos para incitar al usuario en el siguiente turno de conversación.
Nombre de variable de la siguiente Secuencia rápida	Retiene la respuesta del agente virtual y la transfiere a la propiedad nextPromptSequence .
Nombre de variable de carga útil personalizada	Devuelve datos JSON personalizados del agente virtual al script. Utilice esta variable cuando desee que el script procese los datos que proporciona el agente virtual. Puede contener datos de cumplimiento. Si desea proporcionar datos al agente virtual, utilice la propiedad customPayload.
Nombre de variable de Detalles del Error	Solicita la secuencia de intento de error; puede dar lugar a una transferencia a un agente activo.
Nombre de variable de información de intención	Una variable que contiene los detalles del agente virtual que indica la intención actual del usuario.
Nombre de variable de estado de la sesión del bot	Guarda la variable donde el script almacena el identificador del estado de la sesión bot que envía el proveedor de agente virtual. El contenido de la variable se pasa a la propiedad botSessionState. Debe configurarse adecuadamente la propiedad para que funcione correctamente el agente virtual. Se encuentra disponible más información sobre cómo configurarla en la página de ayuda del Snippet del Estado de Sesión del Bot.

Condiciones de la rama de Resultado

Las condiciones de las ramas de resultados le permiten crear ramas en su script para manejar diferentes resultados cuando se ejecute una acción.

Condición	Descripción
Default	Recorrido a menos que el script cumple una condición que requiere uno de los otros poderes. También se considera si no están definidas las demás ramas de la acción.
PromptAndCollectNextResponse	Ruta adoptada si el agente virtual ha determinado que debe continuar la interacción y está listo para recibir más información humana del contacto. Indica el siguiente turno de la conversación.
Error	Recorrido cuando hay un problema inesperado (por ejemplo, mala conectividad, errores de sintaxis, etc.). La variable _ERR debería completarse con una explicación resumida del problema.
ReturnControlToScript	Ruta que se toma si el agente virtual indicó que la conversación finalizó y devuelve el control al script de Studio para transferir o finalizar la llamada. Puede haber datos de cumplimiento para ser procesados en el resultado customPayload.
DTMFBreakout	Ruta tomada cuando se cumplió una regla DTMF Tonos de señalización que se generan cuando un contacto presiona una tecla en el teclado telefónico. en el script.
UserInputTimeout	Ruta tomada cuando no hay respuesta por parte del usuario en el tiempo especificado en el fragmento de comportamiento del mensaje Predeterminado o Siguiente. Para google Dialogflow, puede configurar el evento que quieres que suceda en la Virtual Agent Hub Dialogflow aplicación Para ES Dialogflow, configure el campoTimeout Event . Para CX Dialogflow , configure el Timeout Event Handler. Si no se configura ningún evento, el valor predeterminado es usar la intención de reserva predeterminada como se configuró en la Dialogflow consola. Si lo desea, puede configurar esta rama para usar diferentes eventos en diferentes puntos de su script.
UserInputNotUnderstood	Ruta que se toma cuando el agente virtual no entiende la respuesta del contacto o cuando el contacto agota el tiempo de espera.

Código de Acción SNIPPET requerido

Una o más de las propiedades de esta acción requiere una Snippet acción con el siguiente código personalizado:

Prácticas recomendadas para la Carga útil personalizada con Google Dialogflow CX

Al usar esta acción conGoogle Dialogflow CX siga estas prácticas recomendadas para integrar cargas útiles personalizadas:

Dialogflow CX no utiliza contextos para pasar datos a Dialogflow intenciones El significado o propósito detrás de lo que dice o escribe un contacto; lo que el contacto desea comunicar o lograr. como lo hace Dialogflow ES.
Puede pasar datos personalizados a Dialogflow CX utilizando pares clave-valor de JSON. En un Snippet acción en su script, cree un objeto dinámico customPayload y agregue los pares clave-valor a él. 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.
Pase el JSON de customPayload al agente virtual mediante la propiedad Payload de QueryParameters. Consulte la documentación de Google sobre QueryParameters para Google Dialogflow CX.
Los datos que se pasan 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 anide 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 NiCE CXone. 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 establecer el comportamientos del siguiente aviso.
Para pasar datos personalizados a Dialogflow CX desde el script, use session_params en el objeto customPayload en una acción de 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 las sugerencias de contexto de voz y un ID de conversación personalizado para transferir la conversación a un agente virtual de Dialogflow CX diferente en el snippet Carga útil personalizada .
Para configurar cuánto tiempo espera el agente virtual cuando el contacto hace una pausa al hablar, agregue el maxPostEnergySilenceMSparámetro a la Next Prompt Behaviorso Default Next Prompt BehaviorsSnippet acción.

Prácticas recomendadas para la Carga útil personalizada con Google Dialogflow ES

Al usar esta acción conGoogle Dialogflow ES, siga estas prácticas recomendadas para integrar cargas útiles personalizadas:

CustomPayload se utiliza para pasar contexto para una intención El significado o propósito detrás de lo que dice o escribe un contacto; lo que el contacto desea 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 un contacto dice o escribe. 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 REST Resource: projects.agent.sessions.context. La ayuda en línea de Studio proporciona información adicional sobre los objetos de datos dinámicos.
También puede transmitir datos personalizados con customPayload sin contextos. Para hacer esto, incluya pares clave-valor JSON estándar en un objeto de datos dinámicos.
Los contextos de voz se pasan en la carga útil personalizada en el parámetro speech_contact. Puede ver el contenido de este parámetro en los seguimientos de Studio y en los registros de la aplicación.
El objeto Dinámico customPayload se pasa como un parámetro de agente virtual en formato JSON, como se muestra en el script de ejemplo.
Configure las sugerencias de contexto de voz en el Carga útil personalizada Snippet.

Consejos y trucos

Si no se puede escuchar el audio de voz entre Virtual Agent Hub y el agente virtual, revise el rastro del script para ver si hay alguna transcripción. De haberlo, requiere ajustarse el agente virtual Google Dialogflow.

Ejemplo de Script

Este es un ejemplo para demostrar cómo se puede utilizar esta acción en los scripts. No pretende ser un script completo. Es posible que se requiera programación adicional.

Las acciones de VoiceBot Exchange deben utilizarse en un bucle. Esto significa que debe utilizar al menos dos en un script. La primera acción inicia la llamada a la API del agente virtual y debe estar precedida por la acción Snippet de Comportamiento predeterminado de la siguiente indicación. La primera acción es el Saludo predeterminado, que inicia el primer bucle con script, o un «turno» conversacional.

An example of a script that uses the VoicebotExchange action.

Descargar este script.

Script de ejemplo para CustomPayload con Google Dialogflow ES

Este es un ejemplo para demostrar cómo se puede utilizar esta acción en los scripts. No pretende ser un script completo. Es posible que se requiera programación adicional.

Este script es un ejemplo de cómo integrar cargas útiles personalizadas con agentes virtuales de Google Dialogflow ES. Este script utiliza la acción Voicebot Exchange, pero también funcionará si usted usa TEXTBOT EXCHaNGE en su lugar.

Un script de ejemplo que muestra cómo manejar la carga útil personalizada con Google Dialogflow CX.

Descargar este script.

Script de ejemplo para Eventos de tiempo límite alternativo

Este es un ejemplo para demostrar cómo se puede utilizar esta acción en los scripts. No pretende ser un script completo. Es posible que se requiera programación adicional.

Puede usar diferentes eventos de tiempo de espera en diferentes puntos de su script. Por ejemplo, quizá desee utilizar diferentes eventos de tiempo de espera la primera y la segunda vez que se active la propiedadUserInputTimeout . Este script de ejemplo muestra una forma posible de hacer que esto suceda.

En este script, las acciones Snippet se utilizan para crear e incrementar un contador de tiempo límite. Después del segundo tiempo límite, se utiliza una acción Snippet para establecer un evento de tiempo límite distinto. El evento alternativo de tiempo de espera se transfiere desde la acciónSnippet a la acción del voicebot a través de la automatedIntent propiedad.

Descargue este script.