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
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
-
#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
The url.
Constructor Details
#initialize(version, payload, assistant_sid: nil, sid: nil) ⇒ QueryInstance
Initialize the QueryInstance
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 280 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.
318 319 320 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 318 def account_sid @properties['account_sid'] end |
#assistant_sid ⇒ String
Returns The unique ID of the parent Assistant.
366 367 368 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 366 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
309 310 311 312 313 314 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 309 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.
324 325 326 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 324 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date that this resource was last updated.
330 331 332 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 330 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the QueryInstance
415 416 417 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 415 def delete context.delete end |
#fetch ⇒ QueryInstance
Fetch the QueryInstance
397 398 399 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 397 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
428 429 430 431 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 428 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.
342 343 344 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 342 def language @properties['language'] end |
#model_build_sid ⇒ String
Returns The unique ID of the Model Build queried.
348 349 350 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 348 def model_build_sid @properties['model_build_sid'] end |
#query ⇒ String
Returns The end-user's natural language input.
354 355 356 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 354 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.
336 337 338 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 336 def results @properties['results'] end |
#sample_sid ⇒ String
Returns An optional reference to the Sample created from this query.
360 361 362 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 360 def sample_sid @properties['sample_sid'] end |
#sid ⇒ String
Returns A 34 character string that uniquely identifies this resource.
372 373 374 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 372 def sid @properties['sid'] end |
#source_channel ⇒ String
Returns The communication channel where this end-user input came from.
390 391 392 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 390 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.
378 379 380 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 378 def status @properties['status'] end |
#to_s ⇒ Object
Provide a user friendly representation
421 422 423 424 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 421 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
408 409 410 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 408 def update(sample_sid: :unset, status: :unset) context.update(sample_sid: sample_sid, status: status, ) end |
#url ⇒ String
Returns The url.
384 385 386 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/query.rb', line 384 def url @properties['url'] end |