Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1QueryResult

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

Overview

Represents the result of conversational query or event processing.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1QueryResult

Returns a new instance of GoogleCloudDialogflowV2beta1QueryResult.



11179
11180
11181
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11179

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

Instance Attribute Details

#actionString

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

Returns:

  • (String)


11051
11052
11053
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11051

def action
  @action
end

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


11059
11060
11061
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11059

def all_required_params_present
  @all_required_params_present
end

#diagnostic_infoHash<String,Object>

Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors Corresponds to the JSON property diagnosticInfo

Returns:

  • (Hash<String,Object>)


11068
11069
11070
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11068

def diagnostic_info
  @diagnostic_info
end

#fulfillment_messagesArray<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1IntentMessage>

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



11073
11074
11075
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11073

def fulfillment_messages
  @fulfillment_messages
end

#fulfillment_textString

The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, fulfillment_messages should be preferred. Corresponds to the JSON property fulfillmentText

Returns:

  • (String)


11079
11080
11081
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11079

def fulfillment_text
  @fulfillment_text
end

#intentGoogle::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1Intent

An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the intent guide. Corresponds to the JSON property intent



11090
11091
11092
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11090

def intent
  @intent
end

#intent_detection_confidenceFloat

The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. 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)


11101
11102
11103
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11101

def intent_detection_confidence
  @intent_detection_confidence
end

#knowledge_answersGoogle::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1KnowledgeAnswers

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



11106
11107
11108
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11106

def knowledge_answers
  @knowledge_answers
end

#language_codeString

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)


11113
11114
11115
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11113

def language_code
  @language_code
end

#output_contextsArray<Google::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1Context>

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



11120
11121
11122
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11120

def output_contexts
  @output_contexts
end

#parametersHash<String,Object>

The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value Corresponds to the JSON property parameters

Returns:

  • (Hash<String,Object>)


11132
11133
11134
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11132

def parameters
  @parameters
end

#query_textString

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 automatic spell correction is enabled, query_text will contain the corrected user input. Corresponds to the JSON property queryText

Returns:

  • (String)


11142
11143
11144
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11142

def query_text
  @query_text
end

#sentiment_analysis_resultGoogle::Apis::DialogflowV3::GoogleCloudDialogflowV2beta1SentimentAnalysisResult

The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants. StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config Corresponds to the JSON property sentimentAnalysisResult



11154
11155
11156
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11154

def sentiment_analysis_result
  @sentiment_analysis_result
end

#speech_recognition_confidenceFloat

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)


11165
11166
11167
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11165

def speech_recognition_confidence
  @speech_recognition_confidence
end

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


11171
11172
11173
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11171

def webhook_payload
  @webhook_payload
end

#webhook_sourceString

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)


11177
11178
11179
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11177

def webhook_source
  @webhook_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 11184

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