Class: Google::Apis::DialogflowV2beta1::QueryResult

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) ⇒ QueryResult

Returns a new instance of QueryResult



2206
2207
2208
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2206

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) 


2113
2114
2115
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2113

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) 


2122
2123
2124
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2122

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>) 


2129
2130
2131
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2129

def diagnostic_info
  @diagnostic_info
end

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

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

Returns:



2134
2135
2136
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2134

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) 


2139
2140
2141
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2139

def fulfillment_text
  @fulfillment_text
end

#intent ⇒ Google::Apis::DialogflowV2beta1::Intent

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:



2146
2147
2148
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2146

def intent
  @intent
end

#intent_detection_confidence ⇒ Float

The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). Corresponds to the JSON property intentDetectionConfidence

Returns:

  • (Float) 


2152
2153
2154
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2152

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) 


2159
2160
2161
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2159

def language_code
  @language_code
end

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

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:



2167
2168
2169
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2167

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>) 


2172
2173
2174
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2172

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) 


2183
2184
2185
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2183

def query_text
  @query_text
end

#speech_recognition_confidence ⇒ Float

The confidence estimate 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 populated if natural speech audio was provided as input. Corresponds to the JSON property speechRecognitionConfidence

Returns:

  • (Float) 


2192
2193
2194
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2192

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>) 


2198
2199
2200
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2198

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) 


2204
2205
2206
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2204

def webhook_source
  @webhook_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2211

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