Class: Twilio::REST::Assistants::V1::AssistantContext::AssistantsKnowledgeInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, assistant_id: nil, id: nil) ⇒ AssistantsKnowledgeInstance

Initialize the AssistantsKnowledgeInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 412

def initialize(version, payload , assistant_id: nil, id: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'description' => payload['description'],
        'id' => payload['id'],
        'account_sid' => payload['account_sid'],
        'knowledge_source_details' => payload['knowledge_source_details'],
        'name' => payload['name'],
        'status' => payload['status'],
        'type' => payload['type'],
        'url' => payload['url'],
        'embedding_model' => payload['embedding_model'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
    }

    # Context
    @instance_context = nil
    @params = { 'assistant_id' => assistant_id  || @properties['assistant_id']  ,'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 Knowledge resource.

Returns:



461
462
463
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 461

def 
    @properties['account_sid']
end

#context ⇒ AssistantsKnowledgeContext

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

Returns:



440
441
442
443
444
445
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 440

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

#create ⇒ AssistantsKnowledgeInstance

Create the AssistantsKnowledgeInstance

Returns:



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

def create

    context.create
end

#date_created ⇒ Time

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

Returns:



503
504
505
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 503

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:



509
510
511
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 509

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the AssistantsKnowledgeInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#description ⇒ String

Returns The type of knowledge source.

Returns:

  • (String) —

    The type of knowledge source.



449
450
451
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 449

def description
    @properties['description']
end

#embedding_model ⇒ String

Returns The embedding model to be used for the knowledge source.

Returns:

  • (String) —

    The embedding model to be used for the knowledge source.



497
498
499
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 497

def embedding_model
    @properties['embedding_model']
end

#id ⇒ String

Returns The description of knowledge.

Returns:

  • (String) —

    The description of knowledge.



455
456
457
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 455

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#knowledge_source_details ⇒ Hash

Returns The details of the knowledge source based on the type.

Returns:

  • (Hash) —

    The details of the knowledge source based on the type.



467
468
469
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 467

def knowledge_source_details
    @properties['knowledge_source_details']
end

#name ⇒ String

Returns The name of the knowledge source.

Returns:

  • (String) —

    The name of the knowledge source.



473
474
475
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 473

def name
    @properties['name']
end

#status ⇒ String

Returns The status of processing the knowledge source (‘QUEUED’, ‘PROCESSING’, ‘COMPLETED’, ‘FAILED’).

Returns:

  • (String) —

    The status of processing the knowledge source (‘QUEUED’, ‘PROCESSING’, ‘COMPLETED’, ‘FAILED’)



479
480
481
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 479

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#type ⇒ String

Returns The type of knowledge source (‘Web’, ‘Database’, ‘Text’, ‘File’).

Returns:

  • (String) —

    The type of knowledge source (‘Web’, ‘Database’, ‘Text’, ‘File’)



485
486
487
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 485

def type
    @properties['type']
end

#url ⇒ String

Returns The url of the knowledge resource.

Returns:

  • (String) —

    The url of the knowledge resource.



491
492
493
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 491

def url
    @properties['url']
end