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.



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 377

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'],
        'encryption_credential_sid' => payload['encryption_credential_sid'],
        '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.



418
419
420
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 418

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



454
455
456
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 454

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:



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

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

#customer_key ⇒ String

Returns:

  • (String) 


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

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.



460
461
462
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 460

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.



436
437
438
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 436

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.



442
443
444
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 442

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#duration ⇒ String

Returns The duration of this Transcript’s source.

Returns:

  • (String) —

    The duration of this Transcript’s source



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

def duration
    @properties['duration']
end

#encrypted_operator_results ⇒ encrypted_operator_results

Access the encrypted_operator_results

Returns:



552
553
554
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 552

def encrypted_operator_results
    context.encrypted_operator_results
end

#encrypted_sentences ⇒ encrypted_sentences

Access the encrypted_sentences

Returns:



538
539
540
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 538

def encrypted_sentences
    context.encrypted_sentences
end

#encryption_credential_sid ⇒ String

Returns The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.

Returns:

  • (String) —

    The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results.



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

def encryption_credential_sid
    @properties['encryption_credential_sid']
end

#fetch ⇒ TranscriptInstance

Fetch the TranscriptInstance

Returns:



523
524
525
526
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 523

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



572
573
574
575
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 572

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.



466
467
468
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 466

def language_code
    @properties['language_code']
end

#links ⇒ Hash

Returns:

  • (Hash) 


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

def links
    @properties['links']
end

#media ⇒ media

Access the media

Returns:



545
546
547
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 545

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.



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

def media_start_time
    @properties['media_start_time']
end

#operator_results ⇒ operator_results

Access the operator_results

Returns:



559
560
561
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 559

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.



496
497
498
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 496

def redaction
    @properties['redaction']
end

#sentences ⇒ sentences

Access the sentences

Returns:



531
532
533
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 531

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.



424
425
426
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 424

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.



430
431
432
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 430

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


448
449
450
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 448

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



565
566
567
568
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 565

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.



490
491
492
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 490

def url
    @properties['url']
end