Class: Twilio::REST::Preview::Understand::AssistantInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

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

Initialize the AssistantInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The sid



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 393

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'latest_model_build_sid' => payload['latest_model_build_sid'],
      'links' => payload['links'],
      'log_queries' => payload['log_queries'],
      'sid' => payload['sid'],
      'unique_name' => payload['unique_name'],
      'url' => payload['url'],
      'callback_url' => payload['callback_url'],
      'callback_events' => payload['callback_events'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the Account that created this Assistant.

Returns:

  • (String) —

    The unique ID of the Account that created this Assistant.



430
431
432
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 430

def 
  @properties['account_sid']
end

#assistant_fallback_actions ⇒ assistant_fallback_actions

Access the assistant_fallback_actions

Returns:



574
575
576
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 574

def assistant_fallback_actions
  context.assistant_fallback_actions
end

#assistant_initiation_actions ⇒ assistant_initiation_actions

Access the assistant_initiation_actions

Returns:



581
582
583
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 581

def assistant_initiation_actions
  context.assistant_initiation_actions
end

#callback_events ⇒ String

Returns The callback_events.

Returns:

  • (String) —

    The callback_events



496
497
498
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 496

def callback_events
  @properties['callback_events']
end

#callback_url ⇒ String

Returns The callback_url.

Returns:

  • (String) —

    The callback_url



490
491
492
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 490

def callback_url
  @properties['callback_url']
end

#context ⇒ AssistantContext

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

Returns:



421
422
423
424
425
426
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 421

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

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created



436
437
438
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 436

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated



442
443
444
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 442

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the AssistantInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



539
540
541
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 539

def delete
  context.delete
end

#dialogues ⇒ dialogues

Access the dialogues

Returns:



588
589
590
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 588

def dialogues
  context.dialogues
end

#fetch ⇒ AssistantInstance

Fetch a AssistantInstance

Returns:



503
504
505
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 503

def fetch
  context.fetch
end

#field_types ⇒ field_types

Access the field_types

Returns:



546
547
548
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 546

def field_types
  context.field_types
end

#friendly_name ⇒ String

Returns A text description for the Assistant. It is non-unique and can up to 255 characters long.

Returns:

  • (String) —

    A text description for the Assistant. It is non-unique and can up to 255 characters long.



448
449
450
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 448

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



601
602
603
604
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 601

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

#intents ⇒ intents

Access the intents

Returns:



553
554
555
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 553

def intents
  context.intents
end

#latest_model_build_sid ⇒ String

Returns The unique ID (Sid) of the latest model build. Null if no model has been built.

Returns:

  • (String) —

    The unique ID (Sid) of the latest model build. Null if no model has been built.



454
455
456
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 454

def latest_model_build_sid
  @properties['latest_model_build_sid']
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



460
461
462
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 460

def links
  @properties['links']
end

#log_queries ⇒ Boolean

Returns A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter.

Returns:

  • (Boolean) —

    A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter.



466
467
468
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 466

def log_queries
  @properties['log_queries']
end

#model_builds ⇒ model_builds

Access the model_builds

Returns:



560
561
562
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 560

def model_builds
  context.model_builds
end

#queries ⇒ queries

Access the queries

Returns:



567
568
569
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 567

def queries
  context.queries
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



472
473
474
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 472

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



594
595
596
597
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 594

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

#unique_name ⇒ String

Returns A user-provided string that uniquely identifies this resource as an alternative to the sid. You can use the unique name in the URL path. Unique up to 64 characters long.

Returns:

  • (String) —

    A user-provided string that uniquely identifies this resource as an alternative to the sid. You can use the unique name in the URL path. Unique up to 64 characters long.



478
479
480
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 478

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset) ⇒ AssistantInstance

Update the AssistantInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A text description for the Assistant. It is non-unique and can up to 255 characters long.

  • log_queries (Boolean) (defaults to: :unset) —

    A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.

  • unique_name (String) (defaults to: :unset) —

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

  • callback_url (String) (defaults to: :unset) —

    The callback_url

  • callback_events (String) (defaults to: :unset) —

    The callback_events

  • fallback_actions (Hash) (defaults to: :unset) —

    The JSON actions to be executed when the user’s input is not recognized as matching any Intent.

  • initiation_actions (Hash) (defaults to: :unset) —

    The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.

Returns:



524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 524

def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset)
  context.update(
      friendly_name: friendly_name,
      log_queries: log_queries,
      unique_name: unique_name,
      callback_url: callback_url,
      callback_events: callback_events,
      fallback_actions: fallback_actions,
      initiation_actions: initiation_actions,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



484
485
486
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 484

def url
  @properties['url']
end