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) —

    A 34 character string that uniquely identifies this resource.



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 419

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.



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

def 
  @properties['account_sid']
end

#assistant_fallback_actions ⇒ assistant_fallback_actions

Access the assistant_fallback_actions

Returns:



604
605
606
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 604

def assistant_fallback_actions
  context.assistant_fallback_actions
end

#assistant_initiation_actions ⇒ assistant_initiation_actions

Access the assistant_initiation_actions

Returns:



611
612
613
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 611

def assistant_initiation_actions
  context.assistant_initiation_actions
end

#callback_events ⇒ String

Returns Space-separated list of callback events that will trigger callbacks.

Returns:

  • (String) —

    Space-separated list of callback events that will trigger callbacks.



522
523
524
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 522

def callback_events
  @properties['callback_events']
end

#callback_url ⇒ String

Returns A user-provided URL to send event callbacks to.

Returns:

  • (String) —

    A user-provided URL to send event callbacks to.



516
517
518
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 516

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:



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the AssistantInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#dialogues ⇒ dialogues

Access the dialogues

Returns:



618
619
620
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 618

def dialogues
  context.dialogues
end

#fetch ⇒ AssistantInstance

Fetch a AssistantInstance

Returns:



529
530
531
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 529

def fetch
  context.fetch
end

#field_types ⇒ field_types

Access the field_types

Returns:



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

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.



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



638
639
640
641
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 638

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



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

def latest_model_build_sid
  @properties['latest_model_build_sid']
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

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.



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

def log_queries
  @properties['log_queries']
end

#model_builds ⇒ model_builds

Access the model_builds

Returns:



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

def model_builds
  context.model_builds
end

#queries ⇒ queries

Access the queries

Returns:



597
598
599
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 597

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.



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

def sid
  @properties['sid']
end

#style_sheet ⇒ style_sheet

Access the style_sheet

Returns:



625
626
627
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 625

def style_sheet
  context.style_sheet
end

#tasks ⇒ tasks

Access the tasks

Returns:



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

def tasks
  context.tasks
end

#to_s ⇒ Object

Provide a user friendly representation



631
632
633
634
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 631

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.



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

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, style_sheet: :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) —

    A user-provided URL to send event callbacks to.

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

    Space-separated list of callback events that will trigger callbacks.

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

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

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

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

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

    The JSON object that holds the style sheet for the assistant

Returns:



553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 553

def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset, style_sheet: :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,
      style_sheet: style_sheet,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



510
511
512
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 510

def url
  @properties['url']
end