Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Rate this page:
On this page

OperatorResults Resource

(warning)

Warning

Public Beta

Voice Intelligence is currently available as a public beta release. Some features are not yet implemented and others may be changed before the product is declared as Generally Available. Beta products are not covered by a Twilio SLA.

Learn more about beta product support(link takes you to an external page).

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

operatorresults-properties page anchor
Resource properties
operator_typetype: enum<STRING>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
nametype: stringNot PII

The name of the applied Language Understanding.

operator_sidtype: SID<LY>Not PII

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

extract_matchtype: booleanNot PII

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

match_probabilitytype: numberNot PII

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

normalized_resulttype: stringNot PII

Normalized output of extraction stage which matches Label.

utterance_resultstype: arrayNot PII

List of mapped utterance object which matches sentences.

utterance_matchtype: booleanNot PII

Boolean to tell if Utterance matches results.

predicted_labeltype: stringNot PII

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

predicted_probabilitytype: numberNot PII

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

label_probabilitiestype: objectNot PII

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

extract_resultstype: objectNot PII

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

text_generation_resultstype: objectNot PII

Output of a text generation operator for example Conversation Sumamary.

transcript_sidtype: SID<GT>Not PII

A 34 character string that uniquely identifies this Transcript.

urltype: string<URI>Not PII

The URL of this resource.

Get OperatorResults

get-operatorresults page anchor
GET https://intelligence.twilio.com/v2/Transcripts/{TranscriptSid}/OperatorResults

Parameters

list-parameters page anchor
URI parameters
TranscriptSidtype: SID<GT>Not PII
Path Parameter

A 34 character string that uniquely identifies this Transcript.

Redactedtype: booleanNot PII
Query Parameter

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

PageSizetype: integerNot PII
Query Parameter

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

Pagetype: integerNot PII
Query Parameter

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

PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

List multiple OperatorResults

list-multiple-operatorresults page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.intelligence.v2.transcripts('GTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.operatorResults
_11
.list({limit: 20})
_11
.then(operatorResults => operatorResults.forEach(o => console.log(o.name)));

Output

_32
{
_32
"operator_results": [
_32
{
_32
"operator_type": "conversation_classify",
_32
"name": "name",
_32
"operator_sid": "LYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_32
"extract_match": false,
_32
"match_probability": "0.05",
_32
"normalized_result": "normalized_result",
_32
"utterance_results": [
_32
{}
_32
],
_32
"utterance_match": false,
_32
"predicted_label": "predicted_label",
_32
"predicted_probability": "0.05",
_32
"label_probabilities": {},
_32
"extract_results": {},
_32
"text_generation_results": {},
_32
"transcript_sid": "GTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_32
"url": "https://intelligence.twilio.com/v2/Transcripts/GTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/OperatorResults/LYXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_32
}
_32
],
_32
"meta": {
_32
"page": 0,
_32
"page_size": 50,
_32
"first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/OperatorResults?Redacted=True&PageSize=50&Page=0",
_32
"previous_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/OperatorResults?Redacted=True&PageSize=50&Page=0",
_32
"url": "https://intelligence.twilio.com/v2/Transcripts/GTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/OperatorResults?Redacted=True&PageSize=50&Page=0",
_32
"next_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/OperatorResults?Redacted=True&PageSize=50&Page=1",
_32
"key": "operator_results"
_32
}
_32
}

Rate this page: