Support for Import of Voice Cases Using Single Case Format
No tags available
Updated
3 days ago
, by [Redesign] Sprinklr Help Center
In a Single Case File Format, a zip file contains an audio recording, and a CSV file containing the Metadata of that file. Here a single row contains a unique call id pertaining to a single recording.
Note: For information on Multi-Case File format for Voice cases, refer Ingestion of Voice Cases.
Guidelines for Single Case File Format
This section provides a walkthrough on how Single-Case file format can be used, what are it's components, and the various mandatory fields, like unique_call_id.
Here are guidelines for a Single-Case file format for successful import of Voice cases.
Components
Description
File Directory
Maintain a single, consistent directory where Sprinklr configuration is searched for files.
Ensure a one-to-one mapping between a specific importer configuration and a directory. No two importer configurations can point to the same directory.
File Extension and Content
Sprinklr currently supports only zip or tar.gz files for voice data.
Each zip file should contain one metadata file and one audio call recording.
The CSV in the zip file should have exactly two lines/rows: the first for headers, and the second for values.
File Prefix
Maintain a consistent prefixfor zip files. Some examples for the configuration searches for zip files with this consistent prefix are Partner_Call_1.zip, and Partner_Call_2.zip.
Note: Inside zip/tar, if Sprinklr does not find any metadata or recording file with expected extensions, the entire zip/tar file gets ignored.
Metadata File Extension
Sprinklr currently supports three types of metadata file extensions: JSON, XML, and CSV. Customers must adhere to these extensions for all selected files.
Metadata Contents
Metadata file contains all case level details. Here are the fields present inside the file:
unique_call_id: Refers to the ID of the particular Case. (Mandatory Field)
Ensure consistency in metadata contents across all cases for a single configuration.
call_start_time: Refers to the time when the Case started. If the timestamp of voice data is not present in the metadata, the current time of upload is considered in the case creation time.
customer_id: Identifies the Customer in a Case.
Note: The system does not currently support the import of customer profiles. If the customer ID is present, a new profile is created; otherwise, the case is associated with a backend-created profile consistent across customers.
call_language: Language in which the recording is provided.
Agent_Id: Refers to the Agent handling the Case.
Note: In the absence of an agent ID in the config, the system assigns the case to the default bot user shared across customers.
call_direction: Specifies an outbound or an inbound call.
Custom fields: The user can map custom field from the source system to Sprinklr custom fields.
Note: A Case is created irresepective of whether the audio file is present or not. In case the audio recording is not present, a case is created using only the metadata.
Metadata Template
Audio Files
Here are the different supported Audio formats: Stereo, WAV, MP3, OPUS(with a frequency of 8000 Hz or more), aac, wma, ogg, m4a, and mp4.
You can choose any one of the Pulse Code Modulation(PCM)) Formats:
Pcm_s16le
PCM A-law
PCM mu-law
G.729a
Optimizing for ASR Models:
Ensure audio files are representative and mimic actual production data and use cases for optimal Automatic Speech Recognition(ASR) model performance.
Include recordings with different speakers, providing a good distribution for both male and female genders.
Include sample calls/audios for each intent/use case.
Ensure availability of different speakers from various locations or with different accents.
Processing Time
On an average, it takes around five seconds to create a case when there is a five minute conversation between a customer and an agent via SFTP.
Single Case Format Field in Source Specific Settings Screen
In Source Specific Settings screen for Voice Cases, you can select Single-Case format from the Source File Format dropdown. Using this field you can specify whether the zip file pertains to one case or multiple cases.
For information on various parameters and their description for Voice Cases in Source Specific Settings screen, refer