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.



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

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



256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 256

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.



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

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.



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

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. The default is True.

Returns:



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

def fetch(
    redacted: :unset
)

    context.fetch(
        redacted: redacted, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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



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

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.



271
272
273
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 271

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.



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

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.



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

def operator_sid
    @properties['operator_sid']
end

#operator_type ⇒ OperatorType

Returns:

  • (OperatorType) 


265
266
267
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 265

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.



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

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.



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

def predicted_probability
    @properties['predicted_probability']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def transcript_sid
    @properties['transcript_sid']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

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.



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

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.



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

def utterance_results
    @properties['utterance_results']
end