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.



227
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
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 227

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:



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

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.



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

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.



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

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:



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

def fetch(
    redacted: :unset
)

    context.fetch(
        redacted: redacted, 
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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



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

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.



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

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.



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

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.



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

def operator_sid
    @properties['operator_sid']
end

#operator_type ⇒ OperatorType

Returns:

  • (OperatorType) 


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

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.



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

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.



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

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.



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

def text_generation_results
    @properties['text_generation_results']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def transcript_sid
    @properties['transcript_sid']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

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.



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

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.



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

def utterance_results
    @properties['utterance_results']
end