Class: Twilio::REST::Preview::Understand::AssistantContext::QueryList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Preview::Understand::AssistantContext::QueryList
- Defined in:
- lib/twilio-ruby/rest/preview/understand/assistant/query.rb
Instance Method Summary collapse
-
#create(language: nil, query: nil, tasks: :unset, model_build: :unset, field: :unset) ⇒ QueryInstance
Create the QueryInstance.
-
#each ⇒ Object
When passed a block, yields QueryInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of QueryInstance records from the API.
-
#initialize(version, assistant_sid: nil) ⇒ QueryList
constructor
Initialize the QueryList.
-
#list(language: :unset, model_build: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array
Lists QueryInstance records from the API as a list.
-
#page(language: :unset, model_build: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of QueryInstance records from the API.
-
#stream(language: :unset, model_build: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, assistant_sid: nil) ⇒ QueryList
Initialize the QueryList
27 28 29 30 31 32 33 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 27 def initialize(version, assistant_sid: nil) super(version) # Path Solution @solution = { assistant_sid: assistant_sid } @uri = "/Assistants/#{@solution[:assistant_sid]}/Queries" end |
Instance Method Details
#create(language: nil, query: nil, tasks: :unset, model_build: :unset, field: :unset) ⇒ QueryInstance
Create the QueryInstance
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 42 def create( language: nil, query: nil, tasks: :unset, model_build: :unset, field: :unset ) data = Twilio::Values.of({ 'Language' => language, 'Query' => query, 'Tasks' => tasks, 'ModelBuild' => model_build, 'Field' => field, }) payload = @version.create('POST', @uri, data: data) QueryInstance.new( @version, payload, assistant_sid: @solution[:assistant_sid], ) end |
#each ⇒ Object
When passed a block, yields QueryInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
121 122 123 124 125 126 127 128 129 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 121 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 QueryInstance records from the API. Request is executed immediately.
161 162 163 164 165 166 167 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 161 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) QueryPage.new(@version, response, @solution) end |
#list(language: :unset, model_build: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array
Lists QueryInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
81 82 83 84 85 86 87 88 89 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 81 def list(language: :unset, model_build: :unset, status: :unset, limit: nil, page_size: nil) self.stream( language: language, model_build: model_build, status: status, limit: limit, page_size: page_size ).entries end |
#page(language: :unset, model_build: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of QueryInstance records from the API. Request is executed immediately.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 141 def page(language: :unset, model_build: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Language' => language, 'ModelBuild' => model_build, 'Status' => status, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) QueryPage.new(@version, response, @solution) end |
#stream(language: :unset, model_build: :unset, status: :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.
105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 105 def stream(language: :unset, model_build: :unset, status: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( language: language, model_build: model_build, status: status, 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
172 173 174 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 172 def to_s '#<Twilio.Preview.Understand.QueryList>' end |