On this page

OperatorResults Resource

The OperatorResults resource returns a list of operator inferences for a Transcript.

The returned Language Operators are the ones that were deployed to the Service at the time of the creation of the Transcript.

OperatorResults Properties

Property nameTypeRequiredDescriptionChild properties

operator_typeenum<string>

Optional

Not PII

The type of the applied Language Understanding Operator. One of conversation-classify, utterance-classify, extract, extract-normalize, or pii-extract

Possible values:

conversation_classifyutterance_classifyextractextract_normalizepii_extract

namestring

Optional

Not PII

The name of the applied Language Understanding.

operator_sidSID<LY>

Optional

Not PII

A 34 character string that identifies this Language Understanding operator sid.

Pattern: ^LY[0-9a-fA-F]{32}$Min length: 34Max length: 34

extract_matchboolean

Optional

Not PII

Boolean to tell if extract Language Understanding Processing model matches results.

match_probabilitynumber

Optional

Not PII

Percentage of 'matching' class needed to consider a sentence matches

normalized_resultstring

Optional

Not PII

Normalized output of extraction stage which matches Label.

utterance_resultsarray

Optional

Not PII

List of mapped utterance object which matches sentences.

utterance_matchboolean

Optional

Not PII

Boolean to tell if Utterance matches results.

predicted_labelstring

Optional

Not PII

The 'matching' class. This might be available on conversation classify model outputs.

predicted_probabilitynumber

Optional

Not PII

Percentage of 'matching' class needed to consider a sentence matches.

label_probabilitiesobject

Optional

Not PII

The labels probabilities. This might be available on conversation classify model outputs.

extract_resultsobject

Optional

Not PII

List of text extraction results. This might be available on classify-extract model outputs.

text_generation_resultsobject

Optional

Not PII

Output of a text generation operator for example Conversation Sumamary.

transcript_sidSID<GT>

Optional

Not PII

A 34 character string that uniquely identifies this Transcript.

Pattern: ^GT[0-9a-fA-F]{32}$Min length: 34Max length: 34

urlstring<uri>

Optional

Not PII

The URL of this resource.

Get OperatorResults

GET https://intelligence.twilio.com/v2/Transcripts/{TranscriptSid}/OperatorResults

Path parameters

Property nameTypeRequiredPIIDescription

TranscriptSidSID<GT>required

Not PII

A 34 character string that uniquely identifies this Transcript.

Pattern: ^GT[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

Redactedboolean

Optional

Not PII

Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.

PageSizeinteger

Optional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

Pageinteger

Optional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageTokenstring

Optional

Not PII

The page token. This is provided by the API.

List multiple OperatorResults

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async 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
18listOperatorResult();

Output

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}