Class: Twilio::REST::Knowledge::V1::KnowledgeInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the KnowledgeInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 696

def initialize(version, payload , 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 = { '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:



745
746
747
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 745

def 
    @properties['account_sid']
end

#chunks ⇒ chunks

Access the chunks

Returns:



827
828
829
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 827

def chunks
    context.chunks
end

#context ⇒ KnowledgeContext

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

Returns:



724
725
726
727
728
729
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 724

def context
    unless @instance_context
        @instance_context = KnowledgeContext.new(@version , @params['id'])
    end
    @instance_context
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:



787
788
789
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 787

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:



793
794
795
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 793

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the KnowledgeInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



800
801
802
803
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 800

def delete

    context.delete
end

#description ⇒ String

Returns The type of knowledge source.

Returns:

  • (String) —

    The type of knowledge source.



733
734
735
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 733

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.



781
782
783
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 781

def embedding_model
    @properties['embedding_model']
end

#fetch ⇒ KnowledgeInstance

Fetch the KnowledgeInstance

Returns:



808
809
810
811
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 808

def fetch

    context.fetch
end

#id ⇒ String

Returns The description of knowledge.

Returns:

  • (String) —

    The description of knowledge.



739
740
741
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 739

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



847
848
849
850
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 847

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



751
752
753
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 751

def knowledge_source_details
    @properties['knowledge_source_details']
end

#knowledge_status ⇒ knowledge_status

Access the knowledge_status

Returns:



834
835
836
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 834

def knowledge_status
    context.knowledge_status
end

#name ⇒ String

Returns The name of the knowledge source.

Returns:

  • (String) —

    The name of the knowledge source.



757
758
759
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 757

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



763
764
765
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 763

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



840
841
842
843
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 840

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Knowledge.V1.KnowledgeInstance #{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’)



769
770
771
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 769

def type
    @properties['type']
end

#update(knowledge_v1_service_update_knowledge_request: :unset) ⇒ KnowledgeInstance

Update the KnowledgeInstance

Parameters:

  • knowledge_v1_service_update_knowledge_request (KnowledgeV1ServiceUpdateKnowledgeRequest) (defaults to: :unset)

Returns:



817
818
819
820
821
822
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 817

def update(knowledge_v1_service_update_knowledge_request: :unset
)

    context.update(
    )
end

#url ⇒ String

Returns The url of the knowledge resource.

Returns:

  • (String) —

    The url of the knowledge resource.



775
776
777
 
# File 'lib/twilio-ruby/rest/knowledge/v1/knowledge.rb', line 775

def url
    @properties['url']
end