Declare a Transcript

// // overview the first step in processing any interaction is to declare the interaction when the post post request successfully executes, an http status is returned to indicate the request was successful, along with a json response containing the interactionidentifier sample api response { "interactionidentifier" "46985457 fa6b 4071 a3f6 5c4858160ec9" } it is important you store the interactionidentifier as it will serve as a required parameter for all other elevateai endpoints, enabling you to post post , get get , and/or delete delete information associated with this interaction if an error occurs when requesting to declare the interaction, a standard http response code is retuned to indicate the request was unsuccessful, along with a json response containing additional details to assist in troubleshooting troubleshooting all interactions successfully declared will count towards your monthly request quota request quota , irrespective of file upload status or processing outcome only interactions successfully processed are eligible for billing once declared, you are able to confirm the processing status https //docs elevateai com/tutorials/check the processing status of the interaction as well as track impacts to usage https //docs elevateai com/tutorials/elevateai dashboards#h1qyd and spend https //docs elevateai com/tutorials/elevateai dashboards#jysvi // // request parameters & code examples details on cx ai features supported by language can be found on the overview page https //docs elevateai com/#bgq4z // // formatting a transcript for processing transcript files will be formatted according to the schema below, and included as a body parameter when declaring the transcript for processing sample transcription format sample transcription format { "allparticipants" { "phrases" \[ "i", "hope", "this", "documentation", "was", "useful", "thank", "you", ] "phrasesegments" \[ { "starttimeoffset" 870, "endtimeoffset" 1330, "phraseindex" 0, "score" 1 } ] }, "participantone" { "phrases" \[ "i","hope","this","documentation","was","useful", ] }, } schema element type description {participant} object top level for speaker label https //docs elevateai com/transcription features#fdlgr , will be " allparticipants ", or " participantone ", or " participanttwo " {participant}/ phrases array of strings ordered list of each unique phase spoken by {participant} in the interaction {participant}/ phrasesegments array of objects list of details associated with each phrase in transcript for the {participant} {participant}/phrasesegments/ starttimeoffset number start time of phrase (in milliseconds) {participant}/phrasesegments/ endtimeoffset number end time of phrase (in milliseconds) {participant}/phrasesegments/ phraseindex number index of phrase in {participant}/phrases {participant}/phrasesegments/ score float confidence score, if not available should be 1 pro tip allparticpants is a required object when providing a transcript for analysis while participantone and participanttwo objects are not required, they are highly recommended