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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/intent.rb,
lib/twilio-ruby/rest/preview/understand/assistant/intent/field.rb,
lib/twilio-ruby/rest/preview/understand/assistant/intent/sample.rb,
lib/twilio-ruby/rest/preview/understand/assistant/intent/intent_statistics.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].

Defined Under Namespace

Classes: FieldContext, FieldInstance, FieldList, FieldPage, IntentStatisticsContext, IntentStatisticsInstance, IntentStatisticsList, IntentStatisticsPage, SampleContext, SampleInstance, SampleList, SamplePage

Instance Method Summary collapse

Constructor Details

#initialize(version, assistant_sid, sid) ⇒ IntentContext

Initialize the IntentContext



179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 179

def initialize(version, assistant_sid, sid)
  super(version)

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

  # Dependents
  @fields = nil
  @samples = nil
  @statistics = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the IntentInstance



239
240
241
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 239

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ IntentInstance

Fetch a IntentInstance



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 195

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  IntentInstance.new(
      @version,
      payload,
      assistant_sid: @solution[:assistant_sid],
      sid: @solution[:sid],
  )
end

#fields(sid = :unset) ⇒ FieldList, FieldContext

Access the fields

Raises:

  • (ArgumentError) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 247

def fields(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return FieldContext.new(@version, @solution[:assistant_sid], @solution[:sid], sid, )
  end

  unless @fields
    @fields = FieldList.new(
        @version,
        assistant_sid: @solution[:assistant_sid],
        intent_sid: @solution[:sid],
    )
  end

  @fields
end

#samples(sid = :unset) ⇒ SampleList, SampleContext

Access the samples

Raises:

  • (ArgumentError) 


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 269

def samples(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return SampleContext.new(@version, @solution[:assistant_sid], @solution[:sid], sid, )
  end

  unless @samples
    @samples = SampleList.new(
        @version,
        assistant_sid: @solution[:assistant_sid],
        intent_sid: @solution[:sid],
    )
  end

  @samples
end

#statistics ⇒ IntentStatisticsList, IntentStatisticsContext

Access the statistics



291
292
293
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 291

def statistics
  IntentStatisticsContext.new(@version, @solution[:assistant_sid], @solution[:sid], )
end

#to_s ⇒ Object

Provide a user friendly representation



297
298
299
300
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 297

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.Understand.IntentContext #{context}>"
end

#update(friendly_name: :unset, unique_name: :unset) ⇒ IntentInstance

Update the IntentInstance



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/intent.rb', line 219

def update(friendly_name: :unset, unique_name: :unset)
  data = Twilio::Values.of({'FriendlyName' => friendly_name, 'UniqueName' => unique_name, })

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

  IntentInstance.new(
      @version,
      payload,
      assistant_sid: @solution[:assistant_sid],
      sid: @solution[:sid],
  )
end