Conector de entrada de XM Discover Link

Acerca del conector de entrada de XM Discover Link

Puede utilizar el conector de entrada de XM Discover Link para enviar datos XM a XM Discover mediante un punto final de API REST mientras aprovecha todas las capacidades que ofrece el framework Conectores, como la asignación de campos, las transformaciones, los filtros, la vigilancia de jobs, etc.

Formatos de datos admitidos

Los siguientes tipos de datos solo se admiten en formato JSON:

• Opinión individual
• Interacciones digitales
• Transcripciones de llamadas

Antes de configurar el conector, cree un archivo de muestra que represente los campos que desea importar a XM Discover. Consulte las páginas de los enlaces anteriores para obtener más información sobre los campos necesarios y los formatos de archivo.

También hay archivos de plantilla disponibles para descargar en el conector para formatos de datos específicos:

• Chat
  • Chat (predeterminado): se utiliza para datos de interacciones digitales estándar.
  • Amazon Connect: se utiliza para interacciones digitales específicas del chat de Amazon Connect.
• Llamada
  • Llamada (por defecto): uso para datos de transcripciones de llamada estándar.
  • Verint: Uso para transcripciones de llamadas específicas de Verint.
• Opiniones
  • Dynamics 365: Uso para datos de Microsoft Dynamics.

Creación de un job de conector de entrada de XM Discover Link

1. En la ficha Jobs, haga clic en Job nuevo.
   
2. Haga clic en el job XM Discover Link.
   
3. Asigne un nombre a su trabajo para que pueda identificarlo.
   
4. Seleccione el proyecto en el que desea cargar los datos.
5. Dele una descripción a su trabajo para que conozca su propósito.
6. Haga clic en Siguiente.
7. Elija su modo de autorización o cómo se conectará a XM Discover:
   
   • Clave API: Conectar con un token de API XM Discover.
   • OAuth 2.0: Conéctese con un ID de cliente y un secreto de cliente proporcionados por el servicio de autenticación XM Discover. Póngase en contacto con su XM Success Manager para solicitar este método.
8. Haga clic en Siguiente.
9. Elija su formato de datos: chat (digital), llamada o feedback.
   
10. Si lo desea, seleccione una plantilla y, a continuación, haga clic en el enlace aquí para descargar el archivo de plantilla.
11. Introduzca la vía de acceso JSON a un subconjunto de JSON que contenga nodos de documento. Deje este campo vacío si los documentos se encuentran en el nivel de nodo raíz.
12. Haga clic en el botón Haga clic en Seleccionar archivo para cargar y seleccione el archivo de muestra en su ordenador.
13. Aparecerá una vista previa del archivo. Si ve un mensaje de error o el contenido del archivo sin procesar en lugar de la vista previa, puede haber un problema con las opciones de formato de datos que seleccionó. Consulte Errores de archivo de muestra para obtener ayuda sobre la resolución de problemas de su archivo.
14. Haga clic en Siguiente.
15. Si es necesario, ajuste sus asignaciones de datos. Consulte la página de soporte Asignación de datos para obtener información detallada sobre los campos de asignación en XM Discover. La sección Asignación de datos predeterminada contiene orientación específica para este conector.
    
16. Haga clic en Siguiente.
17. Si lo desea, puede añadir reglas de sustitución y edición de datos para ocultar datos confidenciales o sustituir automáticamente determinadas palabras y frases en los comentarios y las interacciones del cliente. Consulte la página de soporte Sustitución de datos y Redacción para obtener más información.
    
18. Haga clic en Siguiente.
19. Si lo desea, puede añadir un filtro de conector para filtrar los datos entrantes para limitar los datos que se importan.
    
20. Haga clic en Siguiente.
21. Seleccione cómo se gestionan los documentos duplicados. Consulte Tratamiento de duplicados para obtener más información.
    
22. Haga clic en Siguiente.
23. Revise su configuración. Si necesita cambiar una configuración específica, haga clic en el botón Editar para ir a ese paso en la configuración del conector.
    
24. El enlace Documentación de API contiene su punto de acceso de API, que se utilizará para enviar datos a XM Discover. Consulte Acceso al punto final de API para obtener más información.
25. Haga clic en Finalizar para guardar la configuración.

Asignación de datos predeterminados

Esta sección contiene información sobre los campos predeterminados para los trabajos de XM Discover Inbound Link.

Al asignar sus campos, están disponibles los siguientes campos predeterminados:

• feedback_type: el tipo de feedback le ayuda a identificar datos en función de su tipo. Esto es útil para la generación de informes cuando su proyecto contiene diferentes tipos de datos (por ejemplo, encuestas y opiniones de medios sociales). Este campo se puede editar. De forma predeterminada, el valor de este atributo se fija en:
  • “llamada” para transcripciones de llamadas
  • “chat” para interacciones digitales
  • “feedback” para feedback individual
  • Puede utilizar transformaciones personalizadas para fijar un valor personalizado.
• source: la fuente le ayuda a identificar los datos obtenidos de una fuente específica. Puede ser cualquier cosa que describa el origen de los datos, como el nombre de una encuesta o una campaña de marketing móvil. Este campo se puede editar. De forma predeterminada, el valor de este atributo se establece en “XM Discover Link”. Puede utilizar la transformación personalizada para fijar un valor personalizado.
• richVerbatim: Este campo se utiliza para datos conversacionales (como transcripciones de llamadas y chat) y no se puede editar. XM Discover utiliza un formato conversacional textual para el campo richVerbatim. Este formato admite la ingestión de metadatos específicos de diálogo necesarios para desbloquear la visualización conversacional (turnos de altavoces, silencio, eventos conversacionales, etc.) y enriquecimientos (hora de inicio, duración, etc.). Este campo textual incluye campos “secundarios” para realizar un seguimiento del lado del cliente y del representante de la conversación:
  • clientVerbatim realiza un seguimiento del lado del cliente de la conversación.
  • agentVerbatim realiza un seguimiento del lado del representante (agente) de la conversación.
  • desconocido rastrea el lado desconocido de la conversación.
• Consejo Q: Las transformaciones no son compatibles con los campos textuales conversacionales. No se puede utilizar el mismo textual para diferentes tipos de datos conversacionales. Si desea que su proyecto aloje varios tipos de conversación, utilice pares separados de textualidades conversacionales por tipo de conversación.
• clientVerbatim: Este campo se utiliza para datos conversacionales y se puede editar. Este campo realiza un seguimiento del lado del cliente de la conversación en las interacciones de llamada y chat. De forma predeterminada, este campo está asignado a:
  • clientVerbatimChat para interacciones digitales.
  • clientVerbatimCall para interacciones de llamada.
• agentVerbatim: Este campo se utiliza para datos conversacionales y se puede editar. Este campo realiza un seguimiento del lado del representante de la conversación en las interacciones de llamada y chat. De forma predeterminada, este campo está asignado a:
  • agentVerbatimChat para interacciones digitales.
  • agentVerbatimCall para interacciones de llamadas.
• Desconocido: Este campo se utiliza para datos conversacionales y se puede editar. Este campo realiza un seguimiento del lado desconocido de la conversación en las interacciones de llamada y chat. Por defecto, este campo está asignado a:
  • unknownVerbatimChat para interacciones digitales.
  • unknownVerbatimCall para interacciones de llamadas.
• document_date: La fecha del documento es el campo de fecha principal asociado a un documento. Esta fecha se utiliza en informes, tendencias, alertas, etc. de XM Discover. Para la fecha de documento, seleccione una de las siguientes opciones:
  • conversationTimestamp (para datos conversacionales): fecha y hora de toda la conversación.
  • Si los datos de origen contienen otros campos de fecha, puede fijar uno de ellos como fecha de documento seleccionándolo en el menú desplegable en el Nombre de campo.
  • También puede fijar una fecha específica añadiendo un campo personalizado.
• natural_id: el ID natural sirve como identificador único de un documento y permite procesar duplicados correctamente. Para el ID natural, seleccione una de las siguientes opciones:
  • conversationId (para datos conversacionales): un ID único para toda la conversación.
  • Seleccione cualquier texto o campo numérico de sus datos en el Nombre de campo.
  • Generar ID automáticamente añadiendo un campo personalizado.
• feedback_provider: el proveedor de feedback le ayuda a identificar los datos obtenidos de un proveedor específico. Para las cargas de XM Discover Link, el valor de este atributo se establece en “XM Discover Link” y no se puede editar.
• job_name: el nombre del trabajo le ayuda a identificar los datos según el nombre del trabajo utilizado para cargarlo. Puede modificar el valor de este atributo en el cuadro Nombre del trabajo en la parte superior de la página o mediante el menú de opciones de trabajo.
• loadDate: La fecha de carga indica cuándo se cargó un documento en XM Discover. Este campo se fija automáticamente y no se puede editar.

Además de los campos anteriores, también puede asignar cualquier campo personalizado que desee importar. Consulte la página de soporte Asignación de datos para obtener más información sobre los campos personalizados.

Acceso al punto de acceso de API

El punto de acceso de API se utiliza para cargar datos a XM Discover enviándolos a través de una solicitud de API REST en formato JSON.

Puede acceder al extremo desde la página Jobs:

1. Seleccione Resumen en el menú de opciones de job para su job.
   
2. Haga clic en el enlace Documentación de API.
   
3. Haga clic en el botón Imprimir para descargar toda la información de esta ventana como un PDF imprimible.
   
4. Su información de punto final incluye:
   • URL de API: la URL utilizada para la solicitud de API.
   • Método: Utilice el método POST para cargar datos en XM Discover.
   • ID de job: El ID del job seleccionado actualmente.
5. Se incluye un payload JSON de ejemplo en la sección Cuerpo de solicitud. Una solicitud de API debe contener solo 1 documento e incluir solo los campos en el payload de ejemplo.
6. La sección Respuestas enumera las posibles respuestas de éxito y error de la solicitud de API.
   
7. La sección Esquema muestra el esquema de datos. Los campos obligatorios están en la matriz obligatoria.

Supervisión de una tarea de XM Discover Link mediante API

Puede supervisar el estado de los jobs de XM Discover Link sin iniciar sesión en XM Discover llamando al punto final de API de estado. Esto le permite obtener el último estado de ejecución de job, métricas para una ejecución de job específica o métricas acumuladas para un período de tiempo específico.

Información de punto final de estado

Para llamar al punto final de estado, necesitará lo siguiente:

• URL de API: https://na-data.clarabridge.net/v1/public/job/status/<jobID> ?apiKey=<apiKey>
  • <jobId> es el ID del trabajo de XM Discover Link que desea supervisar.
  • <apiKey> es el token de API.
• Tipo: Utilizar el HTTP REST
• Método HTTP: Utilice el método GET para recuperar datos.

Elementos de entrada

Los siguientes elementos de entrada opcionales se pueden utilizar para recuperar métricas adicionales sobre su job:

• historicalRunId: El ID de la sesión de carga específica. Si este elemento se omite y no se proporciona ningún intervalo de fechas, la llamada API devuelve el último estado de ejecución del job. Si este elemento se omite y se proporciona un intervalo de fechas, la llamada API devuelve métricas acumuladas para el período de tiempo especificado.
• startDate: define la fecha de inicio a partir de la cual se devolverán los datos.
• endDate: defina la fecha de fin para devolver datos basados en la última carga. Si se omite este elemento y se proporciona startDate, la endDate se fija automáticamente en la fecha actual.

Elementos de salida

Se devolverán los siguientes elementos de salida, siempre que haya introducido los elementos de entrada necesarios:

• job_status: el estado del job.
• job_failure_reason: Si el job ha fallado, el motivo del error.
• run_metrics: información sobre los documentos procesados por el job. Se incluyen las siguientes métricas:
  • SUCCESSFULLY_CREATED: El número de documentos creados correctamente.
  • SUCCESSFULLY_UPDATED: Número de documentos actualizados correctamente.
  • SKIPPED_AS_DUPLICATES: El número de documentos omitidos como duplicados.
  • FILTERED_OUT: El número de documentos filtrados por un filtro específico de fuente o un filtro de conector.
  • BAD_RECORD: Número de interacciones digitales enviadas para procesamiento que no coinciden con el formato conversacional de Qualtrics.
  • SKIPPED_NO_ACTION: El número de documentos omitidos como no duplicados.
  • FAILED_TO_LOAD: el número de documentos que no se han podido cargar.
  • TOTAL: El número total de documentos procesados durante la ejecución de este trabajo.

Mensajes de error

El siguiente mensaje de error es posible para la solicitud de API de estado:

• 401 No autorizado: Error de autenticación. Utilice otra clave API.
• 404 No se ha encontrado: No existe un job con el ID especificado. Utilice un ID de job diferente.

Solicitud ejemplo

A continuación se muestra una solicitud de ejemplo para obtener el estado de una tarea:

curl --location --request GET 'https://na-data.clarabridge.net/v1/public/job/status/62da736987c9788b830918e0?apiKey=02e7a0e26b592632dd50f623e974fff6'

Respuesta de muestra

A continuación se muestra una respuesta de muestra de una tarea fallida:
{
"job_status": "Fallido",
"job_failure_reason": "{\"problema\":[{\"requestId":"RQ-MOB-f339aa58-71b6-4a1d-a67c-12b8d3439321","fuerza":"ERROR","descripción":"Límite de longitud de 900 caracteres para el atributo supportenceresp",
\ ER_success":"
10
", longitud":

Ejemplos de payload

Esta sección contiene 1 payload JSON de ejemplo para cada tipo admitido de datos estructurados (feedback, chat, llamada).

Haga clic aquí para ver el payload de ejemplo de feedback.

curl --location --request POST 'https://na-data.clarabridge.net/v1/cb_link?apiKey=887fc11663c456f9f34844a8a8bdff64&jobId=5f4e583f9142ae48a1090a76' \
--header 'Content-Type: application/json' \
--data-raw '{
"dataSource": "Standard JSON",
"Row_ID": "id43682",

"store_number" "store_number": "226,1,1,0",

"address": "5916 W Woutphp" "store_number" "store_number": "226,1,1,0,0",
"address": "5916 W W outphp "ation_number" "store_number": "226,1,1,0,0",
"address": "5916 W W outphp "79p
" "store_number" "Pricone_number": "226,1,1,0,0"
"address": "5916 W Woutphp" "store_number" "Pricone_number": "226,1,1,0,0"
"address" Mantenga el buen trabajo.",
"LTR": 10,
"state": "TX",
"Rewards_Member": "MyBestBuy"
}'

Haga clic aquí para ver el payload de ejemplo del chat.

curl --location --request POST 'https://na-data.clarabridge.net/v1/cb_link?Hello Id=887fc11663c456f9f34844a8a8bdff64 -
-data-raw '{
"5f4d77656afa99b0396ef959 conversationId": "
37854",
"conversationTimestamp": "2020-07-30T12:42:15.000Z",
"content": {
] "contentType": "CHAT",
" "how" "it_bot:

"

,
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785201"
,}
{
"participantId": "2",
"text": "Hola, ¿está abierto hoy?",Id
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785202"
,} {

"participantId": "1",
"text"

:15.000Z"like "85id" "
37estamp": "2020-07-30T12:ant42:
,
"203" "85id" "
37estamp": "3720-07-30T12:ant42",
,
"85id" "85id" "
37estamp": "3720-07-30T12:ant42",
,
"85id" "85id" "37id" ¿Qué nombre puedo utilizar?",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785205"
}

},
"city": "Boston",
"source": "Facebook"
}'

Haga clic aquí para ver el payload de ejemplo de llamada.

curl --location --request POST 'https://na-data.clarabridge.net/v1/cb_link?apiKey=887fc11663c456f9f34844a8a8bdff64&jobId=5f4e564d9242ae6e6308ff04' \
--header 'Content-Type: application/json' \
--data-raw '{
"conversationId": "462896",

"conversationTimestamp": "2020-07-30T10:15:45.Z",
"content"

"contentType": "CALL",

30_id

:

,
"start": 22000,
"end": 32000
},
{
"participant_id": "2",
"text": "Hola, tengo un par de preguntas.",
"start": 32000,
"end": 42000
}
],
"contentSegmentType": "TURN"

},
"city": "Boston"