Class: Twilio::REST::Intelligence::V2::TranscriptInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ TranscriptInstance

Initialize the TranscriptInstance

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 Transcript resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 339

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'sid' => payload['sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'status' => payload['status'],
        'channel' => payload['channel'],
        'data_logging' => payload['data_logging'],
        'language_code' => payload['language_code'],
        'customer_key' => payload['customer_key'],
        'media_start_time' => Twilio.deserialize_iso8601_datetime(payload['media_start_time']),
        'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
        'url' => payload['url'],
        'redaction' => payload['redaction'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



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

def 
    @properties['account_sid']
end

#channel ⇒ Hash

Returns Media Channel describing Transcript Source and Participant Mapping.

Returns:

  • (Hash) —

    Media Channel describing Transcript Source and Participant Mapping



415
416
417
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 415

def channel
    @properties['channel']
end

#context ⇒ TranscriptContext

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

Returns:



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

def context
    unless @instance_context
        @instance_context = TranscriptContext.new(@version , @params['sid'])
    end
    @instance_context
end

#customer_key ⇒ String

Returns:

  • (String) 


433
434
435
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 433

def customer_key
    @properties['customer_key']
end

#data_logging ⇒ Boolean

Returns Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.

Returns:

  • (Boolean) —

    Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.



421
422
423
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 421

def data_logging
    @properties['data_logging']
end

#date_created ⇒ Time

Returns The date that this Transcript was created, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this Transcript was created, given in ISO 8601 format.



397
398
399
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 397

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this Transcript was updated, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this Transcript was updated, given in ISO 8601 format.



403
404
405
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 403

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



470
471
472
473
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 470

def delete

    context.delete
end

#duration ⇒ String

Returns The duration of this Transcript’s source.

Returns:

  • (String) —

    The duration of this Transcript’s source



445
446
447
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 445

def duration
    @properties['duration']
end

#fetch ⇒ TranscriptInstance

Fetch the TranscriptInstance

Returns:



478
479
480
481
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 478

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



513
514
515
516
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 513

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

#language_code ⇒ String

Returns The default language code of the audio.

Returns:

  • (String) —

    The default language code of the audio.



427
428
429
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 427

def language_code
    @properties['language_code']
end

#links ⇒ Hash

Returns:

  • (Hash) 


463
464
465
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 463

def links
    @properties['links']
end

#media ⇒ media

Access the media

Returns:



500
501
502
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 500

def media
    context.media
end

#media_start_time ⇒ Time

Returns The date that this Transcript’s media was started, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this Transcript’s media was started, given in ISO 8601 format.



439
440
441
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 439

def media_start_time
    @properties['media_start_time']
end

#operator_results ⇒ operator_results

Access the operator_results

Returns:



493
494
495
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 493

def operator_results
    context.operator_results
end

#redaction ⇒ Boolean

Returns If the transcript has been redacted, a redacted alternative of the transcript will be available.

Returns:

  • (Boolean) —

    If the transcript has been redacted, a redacted alternative of the transcript will be available.



457
458
459
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 457

def redaction
    @properties['redaction']
end

#sentences ⇒ sentences

Access the sentences

Returns:



486
487
488
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 486

def sentences
    context.sentences
end

#service_sid ⇒ String

Returns The unique SID identifier of the Service.

Returns:

  • (String) —

    The unique SID identifier of the Service.



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Transcript.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Transcript.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


409
410
411
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 409

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



506
507
508
509
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 506

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



451
452
453
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 451

def url
    @properties['url']
end