Class: Twilio::REST::Intelligence::V2::TranscriptContext::OperatorResultInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, transcript_sid: nil, operator_sid: nil) ⇒ OperatorResultInstance

Initialize the OperatorResultInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this OperatorResult resource.

  • sid (String) —

    The SID of the Call resource to fetch.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 234

def initialize(version, payload , transcript_sid: nil, operator_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'operator_type' => payload['operator_type'],
        'name' => payload['name'],
        'operator_sid' => payload['operator_sid'],
        'extract_match' => payload['extract_match'],
        'match_probability' => payload['match_probability'],
        'normalized_result' => payload['normalized_result'],
        'utterance_results' => payload['utterance_results'],
        'utterance_match' => payload['utterance_match'],
        'predicted_label' => payload['predicted_label'],
        'predicted_probability' => payload['predicted_probability'],
        'label_probabilities' => payload['label_probabilities'],
        'extract_results' => payload['extract_results'],
        'text_generation_results' => payload['text_generation_results'],
        'json_results' => payload['json_results'],
        'transcript_sid' => payload['transcript_sid'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'transcript_sid' => transcript_sid  || @properties['transcript_sid']  ,'operator_sid' => operator_sid  || @properties['operator_sid']  , }
end

Instance Method Details

#context ⇒ OperatorResultContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



266
267
268
269
270
271
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 266

def context
    unless @instance_context
        @instance_context = OperatorResultContext.new(@version , @params['transcript_sid'], @params['operator_sid'])
    end
    @instance_context
end

#extract_match ⇒ Boolean

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

Returns:

  • (Boolean) —

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



293
294
295
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 293

def extract_match
    @properties['extract_match']
end

#extract_results ⇒ Hash

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

Returns:

  • (Hash) —

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



341
342
343
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 341

def extract_results
    @properties['extract_results']
end

#fetch(redacted: :unset) ⇒ OperatorResultInstance

Fetch the OperatorResultInstance

Parameters:

  • redacted (Boolean) (defaults to: :unset) —

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

Returns:



373
374
375
376
377
378
379
380
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 373

def fetch(
    redacted: :unset
)

    context.fetch(
        redacted: redacted, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



391
392
393
394
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 391

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Intelligence.V2.OperatorResultInstance #{values}>"
end

#json_results ⇒ Hash

Returns:

  • (Hash) 


353
354
355
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 353

def json_results
    @properties['json_results']
end

#label_probabilities ⇒ Hash

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

Returns:

  • (Hash) —

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



335
336
337
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 335

def label_probabilities
    @properties['label_probabilities']
end

#match_probability ⇒ Float

Returns Percentage of ‘matching’ class needed to consider a sentence matches.

Returns:

  • (Float) —

    Percentage of ‘matching’ class needed to consider a sentence matches



299
300
301
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 299

def match_probability
    @properties['match_probability']
end

#name ⇒ String

Returns The name of the applied Language Understanding.

Returns:

  • (String) —

    The name of the applied Language Understanding.



281
282
283
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 281

def name
    @properties['name']
end

#normalized_result ⇒ String

Returns Normalized output of extraction stage which matches Label.

Returns:

  • (String) —

    Normalized output of extraction stage which matches Label.



305
306
307
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 305

def normalized_result
    @properties['normalized_result']
end

#operator_sid ⇒ String

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

Returns:

  • (String) —

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



287
288
289
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 287

def operator_sid
    @properties['operator_sid']
end

#operator_type ⇒ OperatorType

Returns:

  • (OperatorType) 


275
276
277
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 275

def operator_type
    @properties['operator_type']
end

#predicted_label ⇒ String

Returns The ‘matching’ class. This might be available on conversation classify model outputs.

Returns:

  • (String) —

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



323
324
325
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 323

def predicted_label
    @properties['predicted_label']
end

#predicted_probability ⇒ Float

Returns Percentage of ‘matching’ class needed to consider a sentence matches.

Returns:

  • (Float) —

    Percentage of ‘matching’ class needed to consider a sentence matches.



329
330
331
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 329

def predicted_probability
    @properties['predicted_probability']
end

#text_generation_results ⇒ Hash

Returns Output of a text generation operator for example Conversation Sumamary.

Returns:

  • (Hash) —

    Output of a text generation operator for example Conversation Sumamary.



347
348
349
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 347

def text_generation_results
    @properties['text_generation_results']
end

#to_s ⇒ Object

Provide a user friendly representation



384
385
386
387
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 384

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Intelligence.V2.OperatorResultInstance #{values}>"
end

#transcript_sid ⇒ String

Returns A 34 character string that uniquely identifies this Transcript.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Transcript.



359
360
361
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 359

def transcript_sid
    @properties['transcript_sid']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



365
366
367
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 365

def url
    @properties['url']
end

#utterance_match ⇒ Boolean

Returns Boolean to tell if Utterance matches results.

Returns:

  • (Boolean) —

    Boolean to tell if Utterance matches results.



317
318
319
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 317

def utterance_match
    @properties['utterance_match']
end

#utterance_results ⇒ Array<Hash>

Returns List of mapped utterance object which matches sentences.

Returns:

  • (Array<Hash>) —

    List of mapped utterance object which matches sentences.



311
312
313
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 311

def utterance_results
    @properties['utterance_results']
end