Retrieve a list of Operator Results for the given Transcript.

GET /v2/Transcripts/{TranscriptSid}/OperatorResults

Retrieve a list of Operator Results for the given Transcript.

Path parameters

  • TranscriptSid string Required

    A 34 character string that uniquely identifies this Transcript.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^GT[0-9a-fA-F]{32}$.

Query parameters

  • Redacted boolean

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

  • PageSize integer(int64)

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

    Minimum value is 1, maximum value is 1000.

  • Page integer

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

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • X-Rate-Limit-Limit string
    • X-Rate-Limit-Remaining string
    • X-Rate-Limit-Config string
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • operator_results array[object]
      Hide operator_results attributes Show operator_results attributes object
      • operator_type string

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

        Values are conversation_classify, utterance_classify, extract, extract_normalize, pii_extract, text_generation, or json.

      • name string | null

        The name of the applied Language Understanding.

      • operator_sid string | null

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

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^LY[0-9a-fA-F]{32}$.

      • extract_match boolean | null

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

      • match_probability number | null

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

      • normalized_result string | null

        Normalized output of extraction stage which matches Label.

      • utterance_results array | null

        List of mapped utterance object which matches sentences.

      • utterance_match boolean | null

        Boolean to tell if Utterance matches results.

      • predicted_label string | null

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

      • predicted_probability number | null

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

      • label_probabilities

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

      • extract_results

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

      • text_generation_results

        Output of a text generation operator for example Conversation Sumamary.

      • json_results
      • transcript_sid string | null

        A 34 character string that uniquely identifies this Transcript.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^GT[0-9a-fA-F]{32}$.

      • url string(uri) | null

        The URL of this resource.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v2/Transcripts/{TranscriptSid}/OperatorResults
curl \
 --request GET 'https://intelligence.twilio.com/v2/Transcripts/{TranscriptSid}/OperatorResults' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "operator_results",
    "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "operator_results": []
}
{
  "meta": {
    "key": "operator_results",
    "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?Redacted=true&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?Redacted=true&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "operator_results": [
    {
      "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "name": "name",
      "json_results": {},
      "operator_sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "extract_match": false,
      "operator_type": "conversation_classify",
      "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "extract_results": {},
      "predicted_label": "predicted_label",
      "utterance_match": false,
      "match_probability": "0.05",
      "normalized_result": "normalized_result",
      "utterance_results": [
        {}
      ],
      "label_probabilities": {},
      "predicted_probability": "0.05",
      "text_generation_results": {}
    }
  ]
}