Connettore XM Discover Link Inbound
Informazioni su XM Discover Link Inbound Connector
È possibile utilizzare XM Discover Link Inbound Connector per inviare i dati XM in XM Discover tramite un endpoint API REST sfruttando al contempo tutte le funzionalità offerte dal framework Connettori, quali mappatura dei campi, trasformazioni, filtri, monitoraggio di job e così via.
Formati di dati supportati
I seguenti tipi di dati sono supportati solo in formato JSON:
Prima di configurare il connettore, crea un file di esempio che rappresenti i campi che desideri importare in XM Discover. Consulta le pagine collegate sopra per maggiori informazioni sui campi richiesti e sui formati di file.
Sono disponibili anche file modello da scaricare all’interno del connettore per formati di dati specifici:
- Chat
- Chat (predefinito): utilizzare per i dati delle interazioni digitali standard.
- Amazon Connect: utilizzare per interazioni digitali specifiche per Amazon Connect Chat.
- Chiamata
- Chiamata (default): utilizzo per dati trascrizioni chiamate standard.
- Versione: utilizzare per trascrizioni di chiamata specifiche di Verint.
- Feedback
- Dynamics 365: utilizzare per i dati di Microsoft Dynamics.
Creazione di un processo XM Discover Link Inbound Connector
- Nel tab Processi, fare clic su Nuovo job.
- Fai clic sul processo XM Discover Link.
- Assegnare un nome al job in modo da poterlo identificare.
- Selezionare il progetto in cui caricare i dati.
- Fornisci una descrizione del tuo lavoro in modo da conoscerne lo scopo.
- Fare clic su Successivo.
- Scegliere la modalità di autorizzazione o la modalità di connessione a XM Discover:
- Chiave API: connettiti utilizzando un token API XM Discover.
- OAuth 2.0: Connetti utilizzando un ID client e una chiave client segreta forniti dal servizio di autenticazione XM Discover. Contatta il tuo XM Success Manager per richiedere questo metodo.
- Fare clic su Successivo.
- Scegli il tuo formato dati: chat (digitale), chiamata o feedback.
- Se lo si desidera, selezionare un modello e fare clic sul collegamento qui per scaricare il file del modello.
- Inserire il percorso JSON per un sottoinsieme di JSON che contiene nodi documento. Lasciare vuoto questo campo se i documenti si trovano a livello di nodo radice.
- Fare clic sul pulsante Fare clic per selezionare il file da caricare e selezionare il file di esempio sul computer.
- Verrà visualizzata un’anteprima del file. Se al posto dell’anteprima viene visualizzato un messaggio di errore o contenuti di file grezzi, potrebbe verificarsi un problema con le opzioni di formato dei dati selezionate. Vedere Errori file di esempio per assistenza nella risoluzione dei problemi del file.
- Fare clic su Successivo.
- Se necessario, adattare le mappature dei dati. Consulta la pagina di supporto Mappaggio dati per informazioni dettagliate sui campi di mappatura in XM Discover. La sezione Mappaggio dati predefinito contiene linee guida specifiche per questo connettore.
- Fare clic su Successivo.
- Se lo si desidera, è possibile aggiungere regole di sostituzione e oscuramento dei dati per nascondere i dati sensibili o sostituire automaticamente determinate parole e frasi nel feedback e nelle interazioni dei clienti. Per ulteriori informazioni, consulta la pagina di supporto Sostituzione e riduzione dei dati.
- Fare clic su Successivo.
- Se lo si desidera, è possibile aggiungere un filtro connettore per filtrare i dati in entrata e limitare i dati importati.
- Fare clic su Successivo.
- Scegliere la modalità di gestione dei documenti duplicati. Consultare Gestione duplicati per ulteriori informazioni.
- Fare clic su Successivo.
- Rivedere la configurazione. Se è necessario modificare un’impostazione specifica, fare clic sul pulsante Modifica per passare a quella fase nella configurazione del connettore.
- Il collegamento Documentazione API contiene il punto finale API che verrà utilizzato per inviare i dati a XM Discover. Vedere Accesso all’endpoint API per ulteriori informazioni.
- Fare clic su Fine per salvare la configurazione.
Mappaggio dati predefinito
Questa sezione contiene informazioni sui campi predefiniti per i job XM Discover Inbound Link.
Quando si mappano i campi, sono disponibili i seguenti campi predefiniti:
- feedback_type: Il tipo di feedback ti aiuta a identificare i dati in base al suo tipo. Ciò è utile per il reporting quando il progetto contiene diversi tipi di dati (ad esempio, questionari e feedback sui social media). Questo campo è modificabile. Per impostazione predefinita, il valore di questo attributo è impostato su:
- “chiamata” per trascrizioni di chiamate
- “chat” per interazioni digitali
- “feedback” per feedback individuale
- È possibile utilizzare trasformazioni personalizzate per impostare un valore personalizzato.
- Origine: consente di identificare i dati ottenuti da un’origine specifica. Può trattarsi di qualsiasi elemento che descriva l’origine dei dati, ad esempio il nome di un’indagine o di una campagna di marketing mobile. Questo campo è modificabile. Per impostazione predefinita, il valore di questo attributo è impostato su “XM Discover Link”. È possibile utilizzare la trasformazione personalizzata per impostare un valore personalizzato.
- richVerbatim: questo campo viene utilizzato per i dati conversazionali (come le trascrizioni di chiamate e chat) e non è modificabile. XM Discover utilizza un formato testuale conversazionale per il campo richVerbatim. Questo formato supporta l’inserimento di metadati specifici della finestra di dialogo necessari per sbloccare la visualizzazione conversazionale (giri di oratori, silenzio, eventi conversazionali e così via) e arricchimenti (ora di inizio, durata e così via). Questo campo testuale include campi “secondari” per tracciare il lato della conversazione del cliente e del rappresentante:
- clientVerbatim traccia il lato del cliente della conversazione.
- agentVerbatim traccia il lato della conversazione del rappresentante (agente).
- Traccia il lato sconosciuto della conversazione.
-
Consiglio Q: le trasformazioni non sono supportate per i campi verbatim conversazionali. Lo stesso verbale non può essere utilizzato per diversi tipi di dati conversazionali. Se si desidera che il progetto ospiti diversi tipi di conversazione, utilizzare coppie separate di verbatim conversazionali per tipo di conversazione.
- clientVerbatim: questo campo viene utilizzato per i dati di conversione ed è modificabile. Questo campo tiene traccia del lato cliente della conversazione nelle interazioni di chiamata e chat. Per impostazione predefinita, questo campo è mappato a:
- clientVerbatimChat per le interazioni digitali.
- clientVerbatimCall per interazioni chiamata.
- agentVerbatim: questo campo viene utilizzato per i dati di conversazione ed è modificabile. Questo campo tiene traccia del lato rappresentante della conversazione nelle interazioni di chiamata e chat. Per impostazione predefinita, questo campo è mappato a:
- agentVerbatimChat per interazioni digitali.
- agentVerbatimCall per le interazioni di chiamata.
- sconosciuto: questo campo viene utilizzato per i dati di conversazione ed è modificabile. Questo campo tiene traccia del lato sconosciuto della conversazione nelle interazioni di chiamata e chat. Per impostazione predefinita, questo campo è mappato a:
- unknown nVerbatimChat per interazioni digitali.
- Unknown VerbatimCall per le interazioni di chiamata.
- document_date: la data del documento è il campo data principale associato a un documento. Questa data viene utilizzata in XM Discover per report, tendenze, avvisi e così via. Per la data del documento, selezionare una delle seguenti opzioni:
- conversationTimestamp (per i dati conversazionali): data e ora dell’intera conversazione.
- Se i dati sorgente contengono altri campi data, è possibile impostarne uno come data documento selezionandolo dal menu di riepilogo a discesa in Nome campo.
- È anche possibile impostare una data specifica aggiungendo un campo personalizzato.
- natural_id: l’ID naturale funge da identificatore univoco di un documento e consente l’elaborazione corretta dei duplicati. Per l’ID naturale, selezionare una delle seguenti opzioni:
- conversationId (per dati conversazionali): ID univoco per l’intera conversazione.
- Selezionare qualsiasi campo di testo o numerico dai dati in Nome campo.
- Genera automaticamente gli ID aggiungendo un campo personalizzato.
- feedback_provider: il provider di feedback ti aiuta a identificare i dati ottenuti da uno specifico provider. Per i caricamenti XM Discover Link, il valore di questo attributo è impostato su “XM Discover Link” e non può essere modificato.
- job_name: il nome del job consente di identificare i dati in base al nome del processo utilizzato per caricarlo. È possibile modificare il valore di questo attributo nella casella Nome processo nella parte superiore della pagina o utilizzando il menu delle opzioni del processo.
- loadDate: la data di caricamento indica quando un documento è stato caricato in XM Discover. Questo campo viene impostato automaticamente e non può essere elaborato.
Oltre ai campi di cui sopra, puoi anche mappare tutti i campi personalizzati che desideri importare. Consulta la pagina di supporto Mappaggio dati per maggiori informazioni sui campi personalizzati.
Accesso all’endpoint API
L’endpoint API viene utilizzato per caricare i dati in XM Discover inviando i dati tramite una richiesta API REST in formato JSON.
È possibile accedere all’endpoint dalla pagina Processi:
- Selezionare Riepilogo nel menu delle opzioni del processo per il processo.
- Fare clic sul collegamento Documentazione API.
- Fare clic sul pulsante Stampa per scaricare tutte le informazioni contenute in questa finestra come PDF stampabile.
- Le informazioni sull’endpoint includono:
- URL API: l’URL utilizzato per la richiesta API.
- Metodo: utilizza il metodo POST per caricare i dati in XM Discover.
- ID processo: l’ID del processo attualmente selezionato.
- Un payload JSON di esempio è incluso nella sezione Corpo della richiesta. Una richiesta API deve contenere solo 1 documento e includere solo i campi nell’esempio di payload.
- La sezione Risposte elenca le possibili risposte di corretta esecuzione e di errore della richiesta API.
- La sezione Schema visualizza lo schema di dati. I campi obbligatori sono nella matrice richiesta.
Monitoraggio di un processo di collegamento XM Discover tramite API
Puoi monitorare lo stato dei job XM Discover Link senza accedere a XM Discover chiamando il punto finale API di stato. Ciò consente di ottenere lo stato di esecuzione del job più recente, le metriche per una specifica esecuzione del job o le metriche accumulate per un periodo di tempo specifico.
Informazioni punto finale stato
Per chiamare il punto finale di stato, sarà necessario quanto segue:
- URL API: https://na-data.clarabridge.net/v1/public/job/status/ <jobID> ?apiKey=<apiKey>
- <jobId> è l’ID del processo XM Discover Link che desideri monitorare.
- <apiKey> è il token API.
- Tipo: utilizzare REST HTTP
- Metodo HTTP: utilizzare il metodo GET per recuperare i dati.
Elementi di input
I seguenti elementi di input facoltativi possono essere utilizzati per recuperare metriche supplementari sul proprio job:
- historicalRunId: l’ID della sessione di upload specifica. Se questo elemento viene omesso e non viene fornito alcun intervallo di date, la chiamata API restituisce l’ultimo stato di esecuzione del job. Se questo elemento viene omesso e viene fornito un intervallo di date, la chiamata API restituisce metriche accumulate per il periodo di tempo specificato.
- startDate: definire la data di inizio a partire dalla quale restituire i dati.
- endDate: definire la data di fine per la restituzione dei dati in base all’ultimo caricamento. Se questo elemento viene omesso e viene fornita la data di inizio, la data di fine viene impostata automaticamente sulla data corrente.
Elementi di output
Vengono restituiti i seguenti elementi di output, a condizione che siano stati inseriti gli elementi di input richiesti:
- job_status: lo stato del job.
- job_failure_Reason: se il processo non è riuscito, il motivo dell’errore.
- run_metrics: informazioni sui documenti elaborati dal job. Sono incluse le seguenti metriche:
- SUCCESSFULLY_CREATED: numero di documenti creati correttamente.
- SUCCESSFULLY_AGGIORNATO: numero di documenti aggiornati correttamente.
- SKIPPED_AS_DUPLICATES: il numero di documenti ignorati come duplicati.
- FILTERED_OUT: il numero di documenti filtrati da un filtro specifico della sorgente o da un filtro connettore.
- BAD_RECORD: il numero di interazioni digitali inviate per l’elaborazione che non corrispondono al formato conversazionale Qualtrics.
- SKIPPED_NO_ACTION: il numero di documenti ignorati come non duplicati.
- FAILED_TO_LOAD: il numero di documenti che non è stato possibile caricare.
- TOTALE: il numero totale di documenti elaborati durante l’esecuzione di questo job.
Messaggi di errore
Per la richiesta API di stato sono possibili i seguenti messaggi di errore:
- 401 Non autorizzato: autenticazione non riuscita. Utilizzare una chiave API diversa.
- 404 Non trovato: un processo con l’ID specificato non esiste. Utilizzare un altro ID job.
Richiesta campione
Di seguito è riportato un esempio di richiesta per ottenere lo stato per un lavoro:
curl --location --request GET 'https://na-data.clarabridge.net/v1/public/job/status/62da736987c9788b830918e0?apiKey=02e7a0e26b592632dd50f623e974fff6'
Risposta campione
Di seguito è riportata una risposta esemplificativa di un processo non riuscito:
{
"job_status": "Fallito",
"job_failure_Reason": "{\"problem\":[{\"requestId":"RQ-MOB-f339aa58-71b6-4a1d-a67c-12b8d3439321","severity":"ERROR","description":"Fallimento di 900 caratteri per l'attributo supportenceresp
",
la lunghezza di ERtoR
è stata superata, la lunghezza è 10
}, la lunghezza è 1043\
\”
Esempi di payload
Questa sezione contiene 1 payload JSON di esempio per ogni tipo di dati strutturati supportato (feedback, chat, chiamata).
- Fai clic qui per visualizzare il payload di esempio del 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": "226,1,0,0",
"address": "16 W L28oop 9 LubTX 4bTX LubTX"
: "226,1,1,0,0",
"address": "16 W L28oop 9 LubTX 4 LubTX" Mantenere il buon lavoro.",
"LTR": 10,
"state": "TX",
"Rewards_Member": "MyBestBuy"
}'
- Fare clic qui per visualizzare il payload esemplificativo della chat.
curl --location --request POST 'https://na-data.clarabridge.net/v1/cb_link?apiKey=887fc11663c456f9f34844a8a8bdff64&jobId=5f4d77656afa99b0396ef959' \
--header 'Content-Type: application/json' \
--data-raw '{
"conversationId": "37854",
"conversationTimestamp": "2020-07-30T12:42:15.000Z",
"participbot": {
"contentType": "CHAT",
Type" "participant:
"participbot" "contentType": "CHAT",
"Tipo": "partecipante": "partecipate": "contentType": "CHAT",
"Tipo": "partecipante": "partecipate"
"contentType": "CHAT",
"Tipo di contenuto": "partecipante bot
" "antent Type": "CHAT","Tipo": "partecipanti": "participbot": "contentType": "CHAT",2 "Tipo": "partecipante bot": "partecipate": "contentType": "CHAT",
"Tipo": "partecipante bot": "partecipate": "contentType": "CHAT",2 "Tipo": "partecipante": "partecipate": "partecipate": "contentType": "CHAT",2 "Tipo": "partecipante": "partecipate": "partecipate": "contentType": "CHAT","Tipo": "partecipante bot": "partecipate": "contentType": "CHAT",2 "Tipo": "partecipante bot": "partecipate": "contentType": "CHAT",2 "Tipo": "partecipante": "participate": "partecipate": "contentType": "CHAT",
"Tipo": "partecipate": "antent Type": "CHAT",
"Tipo": "partecipante": "partecipate"
"contentType": "CHAT",2 "Tipo": "participbot": "participbot": "partecipate" "contentType": "CHAT",
"Tipo": "partecipante bot": "antent Type": "CHAT",2 "Tipo": "participant": "participbot": {
"contentType": "CHAT",2 "Tipo": "participbot": "participbot": "contentType": "CHAT",2 "Tipo": "partecipante": "partecipate": "partecipate": "contentType": "CHAT",2 "Tipo": "partecipante": "partecipate": "partecipate"
"contentType": "CHAT",
"Tipo": "partecipante": "partecipate"
"enteTipo": "CHAT",2 "Tipo,
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785201"
},
{
"participantId": "2",
"text": "Ciao, sei aperto oggi?",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785202"
},
{
"participantId": "1",
"text": "We are open from 17:00 to 23:00.",
"timestamp": "2020-07-30T12:42 make:15.000Z",
"000id:23:42",
"timestamp": "2020-07-30T12:42 make:15.000Z",
"000id,12",
"37203 like": "2020-07-30T12:42:15.000Z",
"
"000id,12",
"3720203 like": "2020-07-30T12
:42:15.000Z",
"
"000id ,12",
"3720203" Quale nome posso usare?",
"timestamp": "2020-07-30T12:42:15.000Z",
"id": "3785205"
}
]
},
"city": "Boston",
"source": "Facebook"
}'
- Fare clic qui per visualizzare il payload di esempio della chiamata.
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.000Z",
"content": {
"conversationTimestamp": "2020-07-30T10:15:45.000Z",
"participr": {
"contentType": "Civ_1",
" type {15:45.000Z","participr": {
"contentType": "Civ_1",
" type {15:45.000Z","participr": {
"contentType 1": "Civ_1",
,
"start": 22000,
"end": 32000
},
{
"participant_id": "2",
"text": "Ciao, ho un paio di domande.",
"start": 32000,
"end": 42000
}
],
"contentSegmentType": "TURN"},
"city": "Boston"