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.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 228

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'],
        '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:



259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 259

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.



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

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.



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

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:



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

def fetch(
    redacted: :unset
)

    context.fetch(
        redacted: redacted, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



378
379
380
381
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 378

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



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

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



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

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.



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

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.



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

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.



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

def operator_sid
    @properties['operator_sid']
end

#operator_type ⇒ OperatorType

Returns:

  • (OperatorType) 


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

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.



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

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.



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

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.



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

def text_generation_results
    @properties['text_generation_results']
end

#to_s ⇒ Object

Provide a user friendly representation



371
372
373
374
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 371

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.



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

def transcript_sid
    @properties['transcript_sid']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

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.



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

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.



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

def utterance_results
    @properties['utterance_results']
end