Process Transcript (Transcripts) v0.0.11 Help ​

Saves transcript and its source to the Transcripts service.

How can I use the Step? ​

You can use the Step to upload a conversation transcript and its audio track into the Transcribe service for collection and further analysis. This Step works together with the Transcribe Media File (AWS Transcribe) Step.

How does the Step work? ​

You provide previously transcribed conversation, its audio source, and participants phone numbers. Also, you can set some additional options, such as extracting text keywords or a summary. The Step processes input and uploads it to the Transcripts service.

Prerequisites ​

For this Step to work, ensure that the transcript file is created with a defined Merge field AWS transcribe job parameters in the Transcribe Media File (AWS Transcribe) Step:

json
{
"Settings": {
      "ShowAlternatives": true,
      "ShowSpeakerLabels": true,
   } 
}
{
"Settings": {
      "ShowAlternatives": true,
      "ShowSpeakerLabels": true,
   } 
}

Transcript data ​

In this section, you must fill in the following parameters:

  • Media file URL: link to the source of the transcript. It is expected to be a conversation audio or video file stored in the Files. The link must begin with http:\\ or https:\\ and end with the filename and extension.
  • Transcription file URL: link to a JSON file with the text generated by the Transcribe Media File (AWS Transcribe) Step. Retrieve this link by copying it from the Files or selecting the transcriptionUrl property from the Transcribe Media File (AWS Transcribe) Step merge field.
  • Client phone number: recipient phone that must begin with + and contain from 4 to 20 characters.
  • OneReach phone number: bot phone that must begin with + and contain from 4 to 20 characters.
  • Metadata: field for providing additional information about the transcripted file in the JSON object format.

Additional settings ​

This section provides access to the following options:

  • Generate 10 main keywords for the transcript.
  • Get a summary of the conversation.
  • Detect speakers' sentiments and evaluate them based on the friendliness of each participant.

Merge field settings ​

The Step returns the result as a JSON object and stores it under the Merge field name. To learn more about Merge fields and how to work with them, see our Merge fields guide.

Output example ​

The output includes the properties you set when configuring the Step and has the following structure:

json
{
    "audioUrl": "https://files.staging.api.onereach.ai/public/e00dfc55-7a60-467f-ae5a-cf2f/IMG_8562.MOV",
    "transcriptionUrl": "https://files.staging.api.onereach.ai/public/e00dfc55-7a60-467f-ae5a-cf2f/Transcribe/zVD-Vrz-Qz6VtZMLhlhAVw.json",
    "clientPhone": "+14085550175",
    "orPhone": "+14085550199",
    "sessionId": "33361537-2d35-41c9-aee9-7a6def904a",
    "createdAt": 1701788446240,
    "metadata": {},
    "processing": {
        "keywords": true,
        "summary": true,
        "sentiments": true
    }
}
{
    "audioUrl": "https://files.staging.api.onereach.ai/public/e00dfc55-7a60-467f-ae5a-cf2f/IMG_8562.MOV",
    "transcriptionUrl": "https://files.staging.api.onereach.ai/public/e00dfc55-7a60-467f-ae5a-cf2f/Transcribe/zVD-Vrz-Qz6VtZMLhlhAVw.json",
    "clientPhone": "+14085550175",
    "orPhone": "+14085550199",
    "sessionId": "33361537-2d35-41c9-aee9-7a6def904a",
    "createdAt": 1701788446240,
    "metadata": {},
    "processing": {
        "keywords": true,
        "summary": true,
        "sentiments": true
    }
}

Error handling ​

By default, the Step handles errors using a separate exit. If any error occurs during the Step execution, the Flow proceeds down the error exit. For more information, see Error and timeout handling.

Reporting ​

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. You can specify tags to organize the collected data. To learn more, see Reporting events.

Services dependencies ​

  • transcripts api v1.1.2
  • bot deployer v3.2.0
  • library v4.0.11
  • sdk api v2.21.1
  • studio v4.6.37

Release notes ​

v0.0.11 ​

  • Initial release