Class: Twilio::REST::Preview::Understand::ServiceContext::QueryList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/service/query.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ QueryList

Initialize the QueryList

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) (defaults to: nil) —

    The service_sid



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/preview/understand/service/query.rb', line 20

def initialize(version, service_sid: nil)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Queries"
end

Instance Method Details

#create(language: nil, query: nil, intent: :unset, model_build: :unset, field: :unset, named_entity: :unset) ⇒ QueryInstance

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

Parameters:

  • language (String) (defaults to: nil) —

    The language

  • query (String) (defaults to: nil) —

    The query

  • intent (String) (defaults to: :unset) —

    The intent

  • model_build (String) (defaults to: :unset) —

    The model_build

  • field (String) (defaults to: :unset) —

    The field

  • named_entity (String) (defaults to: :unset) —

    The named_entity

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/preview/understand/service/query.rb', line 143

def create(language: nil, query: nil, intent: :unset, model_build: :unset, field: :unset, named_entity: :unset)
  data = Twilio::Values.of({
      'Language' => language,
      'Query' => query,
      'Intent' => intent,
      'ModelBuild' => model_build,
      'Field' => field,
      'NamedEntity' => named_entity,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  QueryInstance.new(@version, payload, service_sid: @solution[:service_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.



83
84
85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/preview/understand/service/query.rb', line 83

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of QueryInstance



125
126
127
128
129
130
131
 
# File 'lib/twilio-ruby/rest/preview/understand/service/query.rb', line 125

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.

Parameters:

  • language (String) (defaults to: :unset) —

    The language

  • model_build (String) (defaults to: :unset) —

    The model_build

  • status (String) (defaults to: :unset) —

    The status

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



42
43
44
45
46
47
48
49
50
 
# File 'lib/twilio-ruby/rest/preview/understand/service/query.rb', line 42

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.

Parameters:

  • language (String) (defaults to: :unset) —

    The language

  • model_build (String) (defaults to: :unset) —

    The model_build

  • status (String) (defaults to: :unset) —

    The status

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of QueryInstance



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/preview/understand/service/query.rb', line 103

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
  )
  QueryPage.new(@version, response, @solution)
end

#stream(language: :unset, model_build: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • language (String) (defaults to: :unset) —

    The language

  • model_build (String) (defaults to: :unset) —

    The model_build

  • status (String) (defaults to: :unset) —

    The status

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/preview/understand/service/query.rb', line 66

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



164
165
166
 
# File 'lib/twilio-ruby/rest/preview/understand/service/query.rb', line 164

def to_s
  '#<Twilio.Preview.Understand.QueryList>'
end