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.



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

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.



382
383
384
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 382

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



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

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:



373
374
375
376
377
378
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 373

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

#customer_key ⇒ String

Returns:

  • (String) 


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

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.



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

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.



400
401
402
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 400

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.



406
407
408
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 406

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TranscriptInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#duration ⇒ String

Returns The duration of this Transcript’s source.

Returns:

  • (String) —

    The duration of this Transcript’s source



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

def duration
    @properties['duration']
end

#fetch ⇒ TranscriptInstance

Fetch the TranscriptInstance

Returns:



481
482
483
484
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 481

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

def language_code
    @properties['language_code']
end

#links ⇒ Hash

Returns:

  • (Hash) 


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

def links
    @properties['links']
end

#media ⇒ media

Access the media

Returns:



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

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.



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

def media_start_time
    @properties['media_start_time']
end

#operator_results ⇒ operator_results

Access the operator_results

Returns:



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

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.



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

def redaction
    @properties['redaction']
end

#sentences ⇒ sentences

Access the sentences

Returns:



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

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.



388
389
390
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 388

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.



394
395
396
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 394

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def url
    @properties['url']
end