Class: Twilio::REST::Assistants::V1::KnowledgeList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/assistants/v1/knowledge.rb

Defined Under Namespace

Classes: AssistantsV1ServiceCreateKnowledgeRequest, AssistantsV1ServiceCreatePolicyRequest, AssistantsV1ServiceUpdateKnowledgeRequest

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ KnowledgeList

Initialize the KnowledgeList



196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 196

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Knowledge"
    
end

Instance Method Details

#create(assistants_v1_service_create_knowledge_request: nil) ⇒ KnowledgeInstance

Create the KnowledgeInstance



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 208

def create(assistants_v1_service_create_knowledge_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.create('POST', @uri, headers: headers, data: assistants_v1_service_create_knowledge_request.to_json)
    KnowledgeInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(assistants_v1_service_create_knowledge_request: nil) ⇒ KnowledgeInstance

Create the KnowledgeInstanceMetadata



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 228

def create_with_metadata(assistants_v1_service_create_knowledge_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, headers: headers, data: assistants_v1_service_create_knowledge_request.to_json)
    knowledge_instance = KnowledgeInstance.new(
        @version,
        response.body,
    )
    KnowledgeInstanceMetadata.new(
        @version,
        knowledge_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

When passed a block, yields KnowledgeInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



321
322
323
324
325
326
327
328
329
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 321

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of KnowledgeInstance records from the API. Request is executed immediately.



360
361
362
363
364
365
366
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 360

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
KnowledgePage.new(@version, response, @solution)
end

#list(assistant_id: :unset, limit: nil, page_size: nil) ⇒ Array

Lists KnowledgeInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.



263
264
265
266
267
268
269
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 263

def list(assistant_id: :unset, limit: nil, page_size: nil)
    self.stream(
        assistant_id: assistant_id,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(assistant_id: :unset, limit: nil, page_size: nil) ⇒ Array 



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 303

def list_with_metadata(assistant_id: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'AssistantId' => assistant_id,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    KnowledgePageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(assistant_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of KnowledgeInstance records from the API. Request is executed immediately.



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 339

def page(assistant_id: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'AssistantId' => assistant_id,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    KnowledgePage.new(@version, response, @solution)
end

#stream(assistant_id: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



283
284
285
286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 283

def stream(assistant_id: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        assistant_id: assistant_id,
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



371
372
373
 
# File 'lib/twilio-ruby/rest/assistants/v1/knowledge.rb', line 371

def to_s
    '#<Twilio.Assistants.V1.KnowledgeList>'
end