Voice Intelligence Onboarding Guide

A Voice Intelligence Transcript resource represents a transcribed voice conversation. Creating a new Transcript resource initiates the transcription process for a specific recording's audio. In addition to call recordings, Real-Time Transcriptions can now be persisted in Voice Intelligence. You can transcribe recordings made via Twilio and recordings stored outside Twilio.

The following table lists the current language support for Voice Intelligence Transcriptions.

• PII redaction from Transcripts is available for all supported Transcription languages.
• PII redaction from media recordings is available only in en-US.
• For Operator language support, see the Multilanguage support section of the Language Operators page.

Language Operators use artificial intelligence and machine learning technologies to provide additional analysis and insights on your Transcripts.

Voice Intelligence supports two types of Language Operators:

• Pre-built Language Operators: Operators created by Twilio or trained using third-party AI models.
• Custom Operators: Operators you create on your account.

You can add and configure Language Operators to a Service using the Twilio Console or the Voice Intelligence API. For more detailed information, see Language Operators.

A Voice Intelligence Service represents an individual configuration for Transcripts and Language Operators. Services help you organize and centralize the resources needed to efficiently manage transcription and analysis tasks.

Twilio's Voice Intelligence Service allows you to:

• Transcribe a recorded call in the language set for your Service.
• Control and configure the processing of recordings into Transcripts.
• Add one or more Language Operators to your Transcripts to gain insights.

You can create multiple Services within a single Account to suit your needs. To learn more about the different configuration options for a Voice Intelligence Service, see Identify your Service configuration settings.

You must create at least one Service before you can transcribe a recording or add Language Operators to your Transcripts.

Now that you've learned the key concepts of Voice Intelligence, let's start setting it up for your Twilio account.

• Account setup: If you don't already have a Twilio account, create one on the Twilio Sign Up page.
• Sign in: Access your Twilio account through the Twilio Console.
• Note your credentials: If you're planning on using the Voice Intelligence API, note your Account SID and Auth Token because you will need them in future steps.

Determine the following before creating your Service:

• Whether you need automatic transcription for all Voice recordings on your Twilio Account.
• Whether you need to redact Personally Identifiable Information (PII) from the recording media, not just the Transcript text.
• The language you want to use for transcriptions.

Enabling automatic transcription lets you transcribe Voice call recordings without needing to call the Create Transcript Resource endpoint. Enable auto_transcribe through the Service Resource or via the Console by navigating to Voice Intelligence > Services > Settings. You can enable this option at any time during and after the initial Service creation.

The auto_transcribe property doesn't function as expected under these conditions:

• If the Account is PCI-compliant.
• If the recordings are encrypted with a client key.
• If the recordings use external storage.

PII redaction removes personally identifiable information from text transcriptions or media recordings to help protect sensitive data.

Voice Intelligence allows you to redact PII from your voice call recordings and Transcripts. PII redaction utilizes artificial intelligence and machine learning technologies.

Update your Service with auto_redaction = true to automatically redact PII from all Transcripts made on this Service. To automatically redact PII from all recording media sent to the Service, set media_redaction = true.

The LanguageCode set during Service creation determines the Transcription language for all voice call recordings processed by that Service. The default is en-US if no LanguageCode is set.

1. Log in to the Twilio Console.
2. Navigate to Voice Intelligence > Services.
3. Click Create new Service. A pop-up window will appear asking you to:
   • Provide a UniqueName for your Service, such as CustomerSupportTranscription.
   • Add a FriendlyName, a brief description of your Service.
   • Select the language that best fits your needs.
   • Accept the Predictive and Generative AI/ML Features Addendum.
   • (Optional) Select one or more of the following options:
     • PII redaction: Redacts Personally Identifiable Information from your data.
     • Auto Transcribe: Automatically transcribes the recorded voice data.
     • Enable data use (optional): Allows the usage of captured data.
4. Click Create to complete the setup. Your new Service is ready for use.

Next, you can choose between two methods for handling transcriptions:

• Auto Transcribe: Configure your Voice Intelligence Service to automatically transcribe all new Voice call recordings. While this option offers convenience by processing recordings automatically, it doesn't provide fine-grained control over transcript attributes.
• Create Transcripts via API: Use the Transcript REST API to trigger transcription for specific recordings. This method allows for more detailed configuration of transcript attributes by referencing the Twilio Recording SID.

Navigate to Voice Intelligence > Transcripts to view and manage Transcripts. On this page, you can:

• Search for phrases within Transcripts.
• Select the Service(s) to display.
• Select a date range for the Transcripts.
• Review recently processed recordings.

Use the Transcript Resource API to retrieve a list of Transcripts.

1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3

4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9

10
async function listTranscript() {
11
  const transcripts = await client.intelligence.v2.transcripts.list({
12
    limit: 20,
13
  });
14

15
  transcripts.forEach((t) => console.log(t.accountSid));
16
}
17

18
listTranscript();

1
{
2
  "transcripts": [
3
    {
4
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5
      "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6
      "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7
      "date_created": "2010-08-31T20:36:28Z",
8
      "date_updated": "2010-08-31T20:36:28Z",
9
      "status": "queued",
10
      "channel": {},
11
      "data_logging": false,
12
      "language_code": "en-US",
13
      "media_start_time": null,
14
      "duration": 0,
15
      "customer_key": null,
16
      "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17
      "redaction": true,
18
      "links": {
19
        "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences",
20
        "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media",
21
        "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults"
22
      }
23
    }
24
  ],
25
  "meta": {
26
    "key": "transcripts",
27
    "page": 0,
28
    "page_size": 50,
29
    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0",
30
    "next_page_url": null,
31
    "previous_page_url": null,
32
    "url": "https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0"
33
  }
34
}

In addition, you can be notified every time that a new Transcript is ready by setting up a Webhook. This is useful if you'd like to take immediate action in your system when a new Transcript is ready. The Webhook is configured at the Voice Intelligence Service level.

You can configure this in Console by navigating to Services > select your Service > click the "Webhooks" tab.

Here, you can provide a Callback URL (where you want to send the request) and an HTTP Method (POST or GET) for the Webhook. To see the signature of the Webhook request body, please see here.

The Webhook payload will contain the transcript_sid, which can then be used to send a follow-up request to fetch transcript sentences.

Note: The transcript_sid from the Webhook payload can also be used to fetch Language Operator results, covered later in this guide.

Pre-built Language Operators are maintained by Twilio and offered for common language analysis use cases. Refer to Pre-built Language Operators for a complete list of available pre-built Operators.

1. Navigate to Voice Intelligence > Services and select your Service.
2. To add a Pre-built Language Operator, click Add next to the Operator entry or click the Operator name and select Add to service. A confirmation message appears upon successful addition.

When creating a Custom Operator, choose between Generative and Phrase Matching Operator Types. Use the following table to determine which option best fits your needs:

1. Navigate to Voice Intelligence > Services and select your Service.
2. Click Create Custom Operator to be redirected to the Select operator type page.
3. Enter an Operator name and select the desired Custom Operator Type: Generative or Phrase Matching.
4. Follow the instructions in the Console to configure your new Custom Operator.
5. Once created, add the Custom Operator to your Service by clicking Add to service on the Operator page.

1. Navigate to Voice Intelligence > Transcripts.
2. Select a Transcript to view its details.
3. In the Transcript details, review the results of the Language Operators applied to the Transcript.

Use the OperatorResults Resource API to retrieve analyzed data from a Transcript after applying specific Operators.

1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3

4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9

10
async function listOperatorResult() {
11
  const operatorResults = await client.intelligence.v2
12
    .transcripts("GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13
    .operatorResults.list({ limit: 20 });
14

15
  operatorResults.forEach((o) => console.log(o.operatorType));
16
}
17

18
listOperatorResult();

1
{
2
  "operator_results": [],
3
  "meta": {
4
    "page": 0,
5
    "page_size": 50,
6
    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0",
7
    "previous_page_url": null,
8
    "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0",
9
    "next_page_url": null,
10
    "key": "operator_results"
11
  }
12
}

In addition, you can be notified every time that new Operator Results is ready by setting up a Webhook. To do this, you'll use the same Webhook used for notification of new Transcript availability.

If you haven't already done so, you can configure this in Console by navigating to Services > select your Service > click the "Webhooks" tab.

Here, you can provide a Callback URL (where you want to send the request) and an HTTP Method (POST or GET) for the Webhook. To see the signature of the Webhook request body, please see here.

The Webhook payload will contain the transcript_sid, which can then be used to send a follow-up request to fetch Operator Results.

Note: A recommended architecture is to consume the single Webhook in your application, and use the trancription_sid to fetch both the Transcript sentences and Operator Results at the same time.

You can integrate Voice Intelligence Transcript and Language Operator Results into your system in two ways:

• Voice Intelligence API and Webhooks: Set up Webhooks to notify your application when new Transcripts or Operator Results are ready. Your application can then make a REST API request to fetch the results.
  • Set up a Webhook for new Transcripts
  • Set up a Webhook for new Operator Results
• Single-page applications: Embed pre-built web applications in your application UI to view Voice Intelligence Transcripts and Language Operator Results.
  • Transcripts single-page application: View and filter the list of Transcripts.
  • Transcription Viewer single-page application: View the content of individual Transcripts and Language Operator Results.