Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2QueryResult

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v2beta1/classes.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb

Overview

Represents the result of conversational query or event processing.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2QueryResult

Returns a new instance of GoogleCloudDialogflowV2QueryResult



1336
1337
1338
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1336

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#action ⇒ String

The action name from the matched intent. Corresponds to the JSON property action

Returns:

  • (String) 


1238
1239
1240
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1238

def action
  @action
end

#all_required_params_present ⇒ Boolean Also known as: all_required_params_present?

This field is set to:

  • false if the matched intent has required parameters and not all of the required parameter values have been collected.
  • true if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. Corresponds to the JSON property allRequiredParamsPresent

Returns:

  • (Boolean) 


1247
1248
1249
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1247

def all_required_params_present
  @all_required_params_present
end

#diagnostic_info ⇒ Hash<String,Object>

The free-form diagnostic info. For example, this field could contain webhook call latency. Corresponds to the JSON property diagnosticInfo

Returns:

  • (Hash<String,Object>) 


1254
1255
1256
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1254

def diagnostic_info
  @diagnostic_info
end

#fulfillment_messages ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessage>

The collection of rich messages to present to the user. Corresponds to the JSON property fulfillmentMessages

Returns:



1259
1260
1261
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1259

def fulfillment_messages
  @fulfillment_messages
end

#fulfillment_text ⇒ String

The text to be pronounced to the user or shown on the screen. Corresponds to the JSON property fulfillmentText

Returns:

  • (String) 


1264
1265
1266
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1264

def fulfillment_text
  @fulfillment_text
end

#intent ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2Intent

Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics. Corresponds to the JSON property intent

Returns:



1271
1272
1273
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1271

def intent
  @intent
end

#intent_detection_confidence ⇒ Float

The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are multiple knowledge_answers messages, this value is set to the greatest knowledgeAnswers.match_confidence value in the list. Corresponds to the JSON property intentDetectionConfidence

Returns:

  • (Float) 


1279
1280
1281
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1279

def intent_detection_confidence
  @intent_detection_confidence
end

#language_code ⇒ String

The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes. Corresponds to the JSON property languageCode

Returns:

  • (String) 


1286
1287
1288
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1286

def language_code
  @language_code
end

#output_contexts ⇒ Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2Context>

The collection of output contexts. If applicable, output_contexts.parameters contains entries with name <parameter name>.original containing the original parameter values before the query. Corresponds to the JSON property outputContexts

Returns:



1294
1295
1296
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1294

def output_contexts
  @output_contexts
end

#parameters ⇒ Hash<String,Object>

The collection of extracted parameters. Corresponds to the JSON property parameters

Returns:

  • (Hash<String,Object>) 


1299
1300
1301
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1299

def parameters
  @parameters
end

#query_text ⇒ String

The original conversational query text:

  • If natural language text was provided as input, query_text contains a copy of the input.
  • If natural language speech audio was provided as input, query_text contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked.
  • If an event was provided as input, query_text is not set. Corresponds to the JSON property queryText

Returns:

  • (String) 


1310
1311
1312
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1310

def query_text
  @query_text
end

#speech_recognition_confidence ⇒ Float

The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult. Corresponds to the JSON property speechRecognitionConfidence

Returns:

  • (Float) 


1322
1323
1324
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1322

def speech_recognition_confidence
  @speech_recognition_confidence
end

#webhook_payload ⇒ Hash<String,Object>

If the query was fulfilled by a webhook call, this field is set to the value of the payload field returned in the webhook response. Corresponds to the JSON property webhookPayload

Returns:

  • (Hash<String,Object>) 


1328
1329
1330
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1328

def webhook_payload
  @webhook_payload
end

#webhook_source ⇒ String

If the query was fulfilled by a webhook call, this field is set to the value of the source field returned in the webhook response. Corresponds to the JSON property webhookSource

Returns:

  • (String) 


1334
1335
1336
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1334

def webhook_source
  @webhook_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1341

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @all_required_params_present = args[:all_required_params_present] if args.key?(:all_required_params_present)
  @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info)
  @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages)
  @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text)
  @intent = args[:intent] if args.key?(:intent)
  @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence)
  @language_code = args[:language_code] if args.key?(:language_code)
  @output_contexts = args[:output_contexts] if args.key?(:output_contexts)
  @parameters = args[:parameters] if args.key?(:parameters)
  @query_text = args[:query_text] if args.key?(:query_text)
  @speech_recognition_confidence = args[:speech_recognition_confidence] if args.key?(:speech_recognition_confidence)
  @webhook_payload = args[:webhook_payload] if args.key?(:webhook_payload)
  @webhook_source = args[:webhook_source] if args.key?(:webhook_source)
end