Class: Twilio::REST::Preview::Understand::AssistantContext::QueryInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Preview::Understand::AssistantContext::QueryInstance
- Defined in:
- lib/twilio-ruby/rest/preview/understand/assistant/query.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique ID of the Account that created this Query.
-
#assistant_sid ⇒ String
The unique ID of the parent Assistant.
-
#context ⇒ QueryContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date that this resource was created.
-
#date_updated ⇒ Time
The date that this resource was last updated.
-
#delete ⇒ Boolean
Delete the QueryInstance.
-
#fetch ⇒ QueryInstance
Fetch the QueryInstance.
-
#initialize(version, payload, assistant_sid: nil, sid: nil) ⇒ QueryInstance
constructor
Initialize the QueryInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#language ⇒ String
An ISO language-country string of the sample.
-
#model_build_sid ⇒ String
The unique ID of the Model Build queried.
-
#query ⇒ String
The end-user’s natural language input.
-
#results ⇒ Hash
The natural language analysis results which include the Task recognized, the confidence score and a list of identified Fields.
-
#sample_sid ⇒ String
An optional reference to the Sample created from this query.
-
#sid ⇒ String
A 34 character string that uniquely identifies this resource.
-
#source_channel ⇒ String
The communication channel where this end-user input came from.
-
#status ⇒ String
A string that described the query status.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(sample_sid: :unset, status: :unset) ⇒ QueryInstance
Update the QueryInstance.
- #url ⇒ String
Constructor Details
#initialize(version, payload, assistant_sid: nil, sid: nil) ⇒ QueryInstance
Initialize the QueryInstance
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 296 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 || @properties['assistant_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The unique ID of the Account that created this Query.
334 335 336 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 334 def account_sid @properties['account_sid'] end |
#assistant_sid ⇒ String
Returns The unique ID of the parent Assistant.
382 383 384 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 382 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
325 326 327 328 329 330 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 325 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.
340 341 342 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 340 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date that this resource was last updated.
346 347 348 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 346 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the QueryInstance
413 414 415 416 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 413 def delete context.delete end |
#fetch ⇒ QueryInstance
Fetch the QueryInstance
421 422 423 424 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 421 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
451 452 453 454 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 451 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.
358 359 360 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 358 def language @properties['language'] end |
#model_build_sid ⇒ String
Returns The unique ID of the Model Build queried.
364 365 366 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 364 def model_build_sid @properties['model_build_sid'] end |
#query ⇒ String
Returns The end-user’s natural language input.
370 371 372 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 370 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.
352 353 354 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 352 def results @properties['results'] end |
#sample_sid ⇒ String
Returns An optional reference to the Sample created from this query.
376 377 378 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 376 def sample_sid @properties['sample_sid'] end |
#sid ⇒ String
Returns A 34 character string that uniquely identifies this resource.
388 389 390 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 388 def sid @properties['sid'] end |
#source_channel ⇒ String
Returns The communication channel where this end-user input came from.
406 407 408 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 406 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.
394 395 396 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 394 def status @properties['status'] end |
#to_s ⇒ Object
Provide a user friendly representation
444 445 446 447 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 444 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
431 432 433 434 435 436 437 438 439 440 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 431 def update( sample_sid: :unset, status: :unset ) context.update( sample_sid: sample_sid, status: status, ) end |
#url ⇒ String
400 401 402 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 400 def url @properties['url'] end |