Class: Twilio::REST::Assistants::V1::AssistantInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the AssistantInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 488

def initialize(version, payload , id: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'customer_ai' => payload['customer_ai'],
        'id' => payload['id'],
        'model' => payload['model'],
        'name' => payload['name'],
        'owner' => payload['owner'],
        'url' => payload['url'],
        'personality_prompt' => payload['personality_prompt'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'knowledge' => payload['knowledge'],
        'tools' => payload['tools'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Assistant resource.

Returns:



525
526
527
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 525

def 
    @properties['account_sid']
end

#assistants_knowledge ⇒ assistants_knowledge

Access the assistants_knowledge

Returns:



646
647
648
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 646

def assistants_knowledge
    context.assistants_knowledge
end

#assistants_tools ⇒ assistants_tools

Access the assistants_tools

Returns:



639
640
641
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 639

def assistants_tools
    context.assistants_tools
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:



516
517
518
519
520
521
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 516

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

#customer_ai ⇒ Hash

Returns The Personalization and Perception Engine settings.

Returns:

  • (Hash) —

    The Personalization and Perception Engine settings.



531
532
533
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 531

def customer_ai
    @properties['customer_ai']
end

#date_created ⇒ Time

Returns The date and time in GMT when the Assistant was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



573
574
575
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 573

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the Assistant was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



579
580
581
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 579

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the AssistantInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



598
599
600
601
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 598

def delete

    context.delete
end

#feedbacks ⇒ feedbacks

Access the feedbacks

Returns:



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

def feedbacks
    context.feedbacks
end

#fetch ⇒ AssistantInstance

Fetch the AssistantInstance

Returns:



606
607
608
609
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 606

def fetch

    context.fetch
end

#id ⇒ String

Returns The Assistant ID.

Returns:

  • (String) —

    The Assistant ID.



537
538
539
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 537

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



659
660
661
662
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 659

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

#knowledge ⇒ Array<AssistantsV1ServiceKnowledge>

Returns The list of knowledge sources associated with the assistant.

Returns:

  • (Array<AssistantsV1ServiceKnowledge>) —

    The list of knowledge sources associated with the assistant.



585
586
587
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 585

def knowledge
    @properties['knowledge']
end

#messages ⇒ messages

Access the messages

Returns:



632
633
634
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 632

def messages
    context.messages
end

#model ⇒ String

Returns The default model used by the assistant.

Returns:

  • (String) —

    The default model used by the assistant.



543
544
545
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 543

def model
    @properties['model']
end

#name ⇒ String

Returns The name of the assistant.

Returns:

  • (String) —

    The name of the assistant.



549
550
551
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 549

def name
    @properties['name']
end

#owner ⇒ String

Returns The owner/company of the assistant.

Returns:

  • (String) —

    The owner/company of the assistant.



555
556
557
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 555

def owner
    @properties['owner']
end

#personality_prompt ⇒ String

Returns The personality prompt to be used for assistant.

Returns:

  • (String) —

    The personality prompt to be used for assistant.



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

def personality_prompt
    @properties['personality_prompt']
end

#to_s ⇒ Object

Provide a user friendly representation



652
653
654
655
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 652

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

#tools ⇒ Array<AssistantsV1ServiceTool>

Returns The list of tools associated with the assistant.

Returns:

  • (Array<AssistantsV1ServiceTool>) —

    The list of tools associated with the assistant.



591
592
593
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 591

def tools
    @properties['tools']
end

#update(assistants_v1_service_update_assistant_request: :unset) ⇒ AssistantInstance

Update the AssistantInstance

Parameters:

  • assistants_v1_service_update_assistant_request (AssistantsV1ServiceUpdateAssistantRequest) (defaults to: :unset)

Returns:



615
616
617
618
619
620
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 615

def update(assistants_v1_service_update_assistant_request: :unset
)

    context.update(
    )
end

#url ⇒ String

Returns The url of the assistant resource.

Returns:

  • (String) —

    The url of the assistant resource.



561
562
563
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant.rb', line 561

def url
    @properties['url']
end