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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/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 unique ID of the parent Assistant.

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

    A 34 character string that uniquely identifies this resource.



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 290

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'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the Account that created this Query.

Returns:

  • (String) —

    The unique ID of the Account that created this Query.



328
329
330
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 328

def 
  @properties['account_sid']
end

#assistant_sid ⇒ String

Returns The unique ID of the parent Assistant.

Returns:

  • (String) —

    The unique ID of the parent Assistant.



376
377
378
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 376

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:



319
320
321
322
323
324
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 319

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 that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created



334
335
336
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 334

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated



340
341
342
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 340

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the QueryInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



425
426
427
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 425

def delete
  context.delete
end

#fetch ⇒ QueryInstance

Fetch a QueryInstance

Returns:



407
408
409
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 407

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



438
439
440
441
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 438

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

#language ⇒ String

Returns An ISO language-country string of the sample.

Returns:

  • (String) —

    An ISO language-country string of the sample.



352
353
354
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 352

def language
  @properties['language']
end

#model_build_sid ⇒ String

Returns The unique ID of the Model Build queried.

Returns:

  • (String) —

    The unique ID of the Model Build queried.



358
359
360
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 358

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.



364
365
366
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 364

def query
  @properties['query']
end

#results ⇒ Hash

Returns The natural language analysis results which include the Task recognized, the confidence score and a list of identified Fields.

Returns:

  • (Hash) —

    The natural language analysis results which include the Task recognized, the confidence score and a list of identified Fields.



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

def results
  @properties['results']
end

#sample_sid ⇒ String

Returns An optional reference to the Sample created from this query.

Returns:

  • (String) —

    An optional reference to the Sample created from this query.



370
371
372
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 370

def sample_sid
  @properties['sample_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



382
383
384
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 382

def sid
  @properties['sid']
end

#source_channel ⇒ String

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

Returns:

  • (String) —

    The communication channel where this end-user input came from



400
401
402
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 400

def source_channel
  @properties['source_channel']
end

#status ⇒ String

Returns A string that described the query status. The values can be: pending_review, reviewed, discarded.

Returns:

  • (String) —

    A string that described the query status. The values can be: pending_review, reviewed, discarded



388
389
390
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 388

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



431
432
433
434
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 431

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

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

Update the QueryInstance

Parameters:

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

    An optional reference to the Sample created from this query.

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

    A string that described the query status. The values can be: pending_review, reviewed, discarded

Returns:



418
419
420
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 418

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



394
395
396
 
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 394

def url
  @properties['url']
end