Class: Twilio::REST::Autopilot::V1::AssistantContext::QueryInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, assistant_sid: nil, sid: nil) ⇒ QueryInstance

Initialize the QueryInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Query resource.

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

    The SID of the Call resource to fetch.



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 304

def initialize(version, payload , assistant_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'results' => payload['results'],
        'language' => payload['language'],
        'model_build_sid' => payload['model_build_sid'],
        'query' => payload['query'],
        'sample_sid' => payload['sample_sid'],
        'assistant_sid' => payload['assistant_sid'],
        'sid' => payload['sid'],
        'status' => payload['status'],
        'url' => payload['url'],
        'source_channel' => payload['source_channel'],
        'dialogue_sid' => payload['dialogue_sid'],
    }

    # Context
    @instance_context = nil
    @params = { 'assistant_sid' => assistant_sid  || @properties['assistant_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Query resource.

Returns:



343
344
345
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 343

def 
    @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The SID of the [Assistant](www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource.

Returns:



391
392
393
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 391

def assistant_sid
    @properties['assistant_sid']
end

#context ⇒ QueryContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



334
335
336
337
338
339
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 334

def context
    unless @instance_context
        @instance_context = QueryContext.new(@version , @params['assistant_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



349
350
351
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 349

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



355
356
357
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 355

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the QueryInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



428
429
430
431
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 428

def delete

    context.delete
end

#dialogue_sid ⇒ String

Returns The SID of the [Dialogue](www.twilio.com/docs/autopilot/api/dialogue).

Returns:



421
422
423
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 421

def dialogue_sid
    @properties['dialogue_sid']
end

#fetch ⇒ QueryInstance

Fetch the QueryInstance

Returns:



436
437
438
439
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 436

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



466
467
468
469
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 466

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Autopilot.V1.QueryInstance #{values}>"
end

#language ⇒ String

Returns The [ISO language-country](docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used by the Query. For example: ‘en-US`.

Returns:



367
368
369
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 367

def language
    @properties['language']
end

#model_build_sid ⇒ String

Returns The SID of the [Model Build](www.twilio.com/docs/autopilot/api/model-build) queried.

Returns:



373
374
375
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 373

def model_build_sid
    @properties['model_build_sid']
end

#query ⇒ String

Returns The end-user’s natural language input.

Returns:

  • (String) —

    The end-user’s natural language input.



379
380
381
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 379

def query
    @properties['query']
end

#results ⇒ Hash

Returns The natural language analysis results that include the [Task](www.twilio.com/docs/autopilot/api/task) recognized and a list of identified [Fields](www.twilio.com/docs/autopilot/api/task-field).

Returns:



361
362
363
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 361

def results
    @properties['results']
end

#sample_sid ⇒ String

Returns The SID of an optional reference to the [Sample](www.twilio.com/docs/autopilot/api/task-sample) created from the query.

Returns:



385
386
387
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 385

def sample_sid
    @properties['sample_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Query resource.

Returns:

  • (String) —

    The unique string that we created to identify the Query resource.



397
398
399
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 397

def sid
    @properties['sid']
end

#source_channel ⇒ String

Returns The communication channel from where the end-user input came.

Returns:

  • (String) —

    The communication channel from where the end-user input came.



415
416
417
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 415

def source_channel
    @properties['source_channel']
end

#status ⇒ String

Returns The status of the Query. Can be: ‘pending-review`, `reviewed`, or `discarded`.

Returns:

  • (String) —

    The status of the Query. Can be: ‘pending-review`, `reviewed`, or `discarded`



403
404
405
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 403

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



459
460
461
462
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 459

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Autopilot.V1.QueryInstance #{values}>"
end

#update(sample_sid: :unset, status: :unset) ⇒ QueryInstance

Update the QueryInstance

Parameters:

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

    The SID of an optional reference to the [Sample](www.twilio.com/docs/autopilot/api/task-sample) created from the query.

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

    The new status of the resource. Can be: ‘pending-review`, `reviewed`, or `discarded`

Returns:



446
447
448
449
450
451
452
453
454
455
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 446

def update(
    sample_sid: :unset, 
    status: :unset
)

    context.update(
        sample_sid: sample_sid, 
        status: status, 
    )
end

#url ⇒ String

Returns The absolute URL of the Query resource.

Returns:

  • (String) —

    The absolute URL of the Query resource.



409
410
411
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 409

def url
    @properties['url']
end