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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/assistant/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, 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

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

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

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

    The Twilio-provided string that uniquely identifies the Query resource to fetch.



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 297

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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The SID of the Assistant that is the parent of the resource.

Returns:

  • (String) —

    The SID of the Assistant that is the parent of the resource



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

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:



327
328
329
330
331
332
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 327

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

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the QueryInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



440
441
442
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 440

def delete
  context.delete
end

#dialogue_sid ⇒ String

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

Returns:



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

def dialogue_sid
  @properties['dialogue_sid']
end

#fetch ⇒ QueryInstance

Fetch the QueryInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



453
454
455
456
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 453

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

#language ⇒ String

Returns The ISO language-country string that specifies the language used by the Query.

Returns:

  • (String) —

    The ISO language-country string that specifies the language used by the Query



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

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:



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

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



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

def query
  @properties['query']
end

#results ⇒ Hash

Returns The natural language analysis results that include the Task recognized and a list of identified Fields.

Returns:

  • (Hash) —

    The natural language analysis results that include the Task recognized and a list of identified Fields



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

def results
  @properties['results']
end

#sample_sid ⇒ String

Returns The SID of an optional reference to the Sample created from the query.

Returns:

  • (String) —

    The SID of an optional reference to the Sample created from the query



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

def sample_sid
  @properties['sample_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

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



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

def source_channel
  @properties['source_channel']
end

#status ⇒ String

Returns The status of the Query.

Returns:

  • (String) —

    The status of the Query



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



446
447
448
449
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 446

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:



433
434
435
 
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb', line 433

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



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

def url
  @properties['url']
end