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.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 234

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:



282
283
284
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 282

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:



261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 261

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:



337
338
339
340
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 337

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:



324
325
326
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 324

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:



330
331
332
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 330

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the AssistantsKnowledgeInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



345
346
347
348
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 345

def delete

    context.delete
end

#description ⇒ String

Returns The type of knowledge source.

Returns:

  • (String) —

    The type of knowledge source.



270
271
272
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 270

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.



318
319
320
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 318

def embedding_model
    @properties['embedding_model']
end

#id ⇒ String

Returns The description of knowledge.

Returns:

  • (String) —

    The description of knowledge.



276
277
278
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 276

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



359
360
361
362
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 359

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.



288
289
290
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 288

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.



294
295
296
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 294

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



300
301
302
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 300

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



352
353
354
355
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 352

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



306
307
308
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 306

def type
    @properties['type']
end

#url ⇒ String

Returns The url of the knowledge resource.

Returns:

  • (String) —

    The url of the knowledge resource.



312
313
314
 
# File 'lib/twilio-ruby/rest/assistants/v1/assistant/assistants_knowledge.rb', line 312

def url
    @properties['url']
end