Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1QueryResult

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

Returns a new instance of GoogleCloudDialogflowV2beta1QueryResult



4167
4168
4169
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4167

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) 


4058
4059
4060
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4058

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) 


4067
4068
4069
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4067

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


4074
4075
4076
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4074

def diagnostic_info
  @diagnostic_info
end

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

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

Returns:



4079
4080
4081
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4079

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) 


4084
4085
4086
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4084

def fulfillment_text
  @fulfillment_text
end

#intent ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent

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:



4091
4092
4093
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4091

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) 


4099
4100
4101
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4099

def intent_detection_confidence
  @intent_detection_confidence
end

#knowledge_answers ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeAnswers

Represents the result of querying a Knowledge base. Corresponds to the JSON property knowledgeAnswers

Returns:



4104
4105
4106
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4104

def knowledge_answers
  @knowledge_answers
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) 


4111
4112
4113
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4111

def language_code
  @language_code
end

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

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:



4119
4120
4121
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4119

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


4124
4125
4126
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4124

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) 


4135
4136
4137
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4135

def query_text
  @query_text
end

#sentiment_analysis_result ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SentimentAnalysisResult

The result of sentiment analysis as configured by sentiment_analysis_request_config. Corresponds to the JSON property sentimentAnalysisResult

Returns:



4141
4142
4143
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4141

def sentiment_analysis_result
  @sentiment_analysis_result
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) 


4153
4154
4155
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4153

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


4159
4160
4161
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4159

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) 


4165
4166
4167
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4165

def webhook_source
  @webhook_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 4172

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)
  @knowledge_answers = args[:knowledge_answers] if args.key?(:knowledge_answers)
  @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)
  @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result)
  @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