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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant.rb,
lib/twilio-ruby/rest/preview/understand/assistant/query.rb,
lib/twilio-ruby/rest/preview/understand/assistant/intent.rb,
lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb,
lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb,
lib/twilio-ruby/rest/preview/understand/assistant/model_build.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_actions.rb,
lib/twilio-ruby/rest/preview/understand/assistant/field_type/field_value.rb,
lib/twilio-ruby/rest/preview/understand/assistant/intent/intent_statistics.rb,
lib/twilio-ruby/rest/preview/understand/assistant/assistant_fallback_actions.rb,
lib/twilio-ruby/rest/preview/understand/assistant/assistant_initiation_actions.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: AssistantFallbackActionsContext, AssistantFallbackActionsInstance, AssistantFallbackActionsList, AssistantFallbackActionsPage, AssistantInitiationActionsContext, AssistantInitiationActionsInstance, AssistantInitiationActionsList, AssistantInitiationActionsPage, DialogueContext, DialogueInstance, DialogueList, DialoguePage, FieldTypeContext, FieldTypeInstance, FieldTypeList, FieldTypePage, IntentContext, IntentInstance, IntentList, IntentPage, ModelBuildContext, ModelBuildInstance, ModelBuildList, ModelBuildPage, QueryContext, QueryInstance, QueryList, QueryPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ AssistantContext

Initialize the AssistantContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The sid



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

def initialize(version, sid)
  super(version)

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

  # Dependents
  @field_types = nil
  @intents = nil
  @model_builds = nil
  @queries = nil
  @assistant_fallback_actions = nil
  @assistant_initiation_actions = nil
  @dialogues = nil
end

Instance Method Details

#assistant_fallback_actions ⇒ AssistantFallbackActionsList, AssistantFallbackActionsContext

Access the assistant_fallback_actions

Returns:



346
347
348
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 346

def assistant_fallback_actions
  AssistantFallbackActionsContext.new(@version, @solution[:sid], )
end

#assistant_initiation_actions ⇒ AssistantInitiationActionsList, AssistantInitiationActionsContext

Access the assistant_initiation_actions

Returns:



354
355
356
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 354

def assistant_initiation_actions
  AssistantInitiationActionsContext.new(@version, @solution[:sid], )
end

#delete ⇒ Boolean

Deletes the AssistantInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



266
267
268
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 266

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

#dialogues(sid = :unset) ⇒ DialogueList, DialogueContext

Access the dialogues

Returns:

Raises:

  • (ArgumentError) 


362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 362

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

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

  unless @dialogues
    @dialogues = DialogueList.new(@version, assistant_sid: @solution[:sid], )
  end

  @dialogues
end

#fetch ⇒ AssistantInstance

Fetch a AssistantInstance

Returns:



214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 214

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

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

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

#field_types(sid = :unset) ⇒ FieldTypeList, FieldTypeContext

Access the field_types

Returns:

Raises:

  • (ArgumentError) 


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

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

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

  unless @field_types
    @field_types = FieldTypeList.new(@version, assistant_sid: @solution[:sid], )
  end

  @field_types
end

#intents(sid = :unset) ⇒ IntentList, IntentContext

Access the intents

Returns:

Raises:

  • (ArgumentError) 


292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 292

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

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

  unless @intents
    @intents = IntentList.new(@version, assistant_sid: @solution[:sid], )
  end

  @intents
end

#model_builds(sid = :unset) ⇒ ModelBuildList, ModelBuildContext

Access the model_builds

Returns:

Raises:

  • (ArgumentError) 


310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 310

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

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

  unless @model_builds
    @model_builds = ModelBuildList.new(@version, assistant_sid: @solution[:sid], )
  end

  @model_builds
end

#queries(sid = :unset) ⇒ QueryList, QueryContext

Access the queries

Returns:

Raises:

  • (ArgumentError) 


328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 328

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

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

  unless @queries
    @queries = QueryList.new(@version, assistant_sid: @solution[:sid], )
  end

  @queries
end

#to_s ⇒ Object

Provide a user friendly representation



378
379
380
381
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant.rb', line 378

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

#update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset) ⇒ AssistantInstance

Update the AssistantInstance

Parameters:

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

    A text description for the Assistant. It is non-unique and can up to 255 characters long.

  • log_queries (Boolean) (defaults to: :unset) —

    A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.

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

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

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

    The callback_url

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

    The callback_events

  • fallback_actions (Hash) (defaults to: :unset) —

    The JSON actions to be executed when the user’s input is not recognized as matching any Intent.

  • initiation_actions (Hash) (defaults to: :unset) —

    The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.

Returns:



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

def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'LogQueries' => log_queries,
      'UniqueName' => unique_name,
      'CallbackUrl' => callback_url,
      'CallbackEvents' => callback_events,
      'FallbackActions' => Twilio.serialize_object(fallback_actions),
      'InitiationActions' => Twilio.serialize_object(initiation_actions),
  })

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

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