Class: Twilio::REST::Preview::Understand::AssistantContext::IntentContext::SampleList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.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, assistant_sid: nil, intent_sid: nil) ⇒ SampleList

Initialize the SampleList



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 25

def initialize(version, assistant_sid: nil, intent_sid: nil)
  super(version)

  # Path Solution
  @solution = {assistant_sid: assistant_sid, intent_sid: intent_sid}
  @uri = "/Assistants/#{@solution[:assistant_sid]}/Intents/#{@solution[:intent_sid]}/Samples"
end

Instance Method Details

#create(language: nil, tagged_text: nil, source_channel: :unset) ⇒ SampleInstance

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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 129

def create(language: nil, tagged_text: nil, source_channel: :unset)
  data = Twilio::Values.of({
      'Language' => language,
      'TaggedText' => tagged_text,
      'SourceChannel' => source_channel,
  })

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

  SampleInstance.new(
      @version,
      payload,
      assistant_sid: @solution[:assistant_sid],
      intent_sid: @solution[:intent_sid],
  )
end

#each ⇒ Object

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



73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 73

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 SampleInstance records from the API. Request is executed immediately.



111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 111

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

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

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



45
46
47
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 45

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

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

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 91

def page(language: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Language' => language,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  SamplePage.new(@version, response, @solution)
end

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

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



61
62
63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 61

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

  page = self.page(language: language, 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



152
153
154
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb', line 152

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