Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1QueryResult

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

Overview

Represents the result of a conversational query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1QueryResult

Returns a new instance of GoogleCloudDialogflowCxV3beta1QueryResult.



10200
10201
10202
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10200

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

Instance Attribute Details

#advanced_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1AdvancedSettings

Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Corresponds to the JSON property advancedSettings

Returns:



10021
10022
10023
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10021

def advanced_settings
  @advanced_settings
end

#allow_answer_feedback ⇒ Boolean Also known as: allow_answer_feedback?

Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget. Corresponds to the JSON property allowAnswerFeedback

Returns:

  • (Boolean) 


10027
10028
10029
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10027

def allow_answer_feedback
  @allow_answer_feedback
end

#current_flow ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Flow

Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow. Corresponds to the JSON property currentFlow

Returns:



10043
10044
10045
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10043

def current_flow
  @current_flow
end

#current_page ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Page

A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the Page guide. Corresponds to the JSON property currentPage

Returns:



10059
10060
10061
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10059

def current_page
  @current_page
end

#diagnostic_info ⇒ Hash<String,Object>

The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called " Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of scope, are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. Corresponds to the JSON property diagnosticInfo

Returns:

  • (Hash<String,Object>) 


10075
10076
10077
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10075

def diagnostic_info
  @diagnostic_info
end

#dtmf ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DtmfInput

Represents the input for dtmf event. Corresponds to the JSON property dtmf

Returns:



10080
10081
10082
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10080

def dtmf
  @dtmf
end

#generative_info ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1GenerativeInfo

Represents the information of a query if handled by generative agent resources. Corresponds to the JSON property generativeInfo

Returns:



10085
10086
10087
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10085

def generative_info
  @generative_info
end

#intent ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Intent

An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent. Corresponds to the JSON property intent

Returns:



10093
10094
10095
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10093

def intent
  @intent
end

#intent_detection_confidence ⇒ Float

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. This field is deprecated, please use QueryResult.match instead. Corresponds to the JSON property intentDetectionConfidence

Returns:

  • (Float) 


10103
10104
10105
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10103

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) 


10110
10111
10112
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10110

def language_code
  @language_code
end

#match ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1Match

Represents one match result of MatchIntent. Corresponds to the JSON property match

Returns:



10115
10116
10117
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10115

def match
  @match
end

#parameters ⇒ Hash<String,Object>

The collected session 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. Corresponds to the JSON property parameters

Returns:

  • (Hash<String,Object>) 


10128
10129
10130
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10128

def parameters
  @parameters
end

#response_messages ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage>

The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. Corresponds to the JSON property responseMessages

Returns:



10135
10136
10137
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10135

def response_messages
  @response_messages
end

#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SentimentAnalysisResult

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. Corresponds to the JSON property sentimentAnalysisResult

Returns:



10142
10143
10144
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10142

def sentiment_analysis_result
  @sentiment_analysis_result
end

#text ⇒ String

If natural language text was provided as input, this field will contain a copy of the text. Corresponds to the JSON property text

Returns:

  • (String) 


10148
10149
10150
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10148

def text
  @text
end

#transcript ⇒ String

If natural language speech audio was provided as input, this field will contain the transcript for the audio. Corresponds to the JSON property transcript

Returns:

  • (String) 


10154
10155
10156
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10154

def transcript
  @transcript
end

#trigger_event ⇒ String

If an event was provided as input, this field will contain the name of the event. Corresponds to the JSON property triggerEvent

Returns:

  • (String) 


10160
10161
10162
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10160

def trigger_event
  @trigger_event
end

#trigger_intent ⇒ String

If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects//locations//agents//intents/. Corresponds to the JSON property triggerIntent

Returns:

  • (String) 


10166
10167
10168
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10166

def trigger_intent
  @trigger_intent
end

#webhook_display_names ⇒ Array<String>

The list of webhook display names in the order of call sequence. Corresponds to the JSON property webhookDisplayNames

Returns:

  • (Array<String>) 


10171
10172
10173
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10171

def webhook_display_names
  @webhook_display_names
end

#webhook_ids ⇒ Array<String>

The list of webhook ids in the order of call sequence. Corresponds to the JSON property webhookIds

Returns:

  • (Array<String>) 


10176
10177
10178
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10176

def webhook_ids
  @webhook_ids
end

#webhook_latencies ⇒ Array<String>

The list of webhook latencies in the order of call sequence. Corresponds to the JSON property webhookLatencies

Returns:

  • (Array<String>) 


10181
10182
10183
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10181

def webhook_latencies
  @webhook_latencies
end

#webhook_payloads ⇒ Array<Hash<String,Object>>

The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty Struct would be used instead. Corresponds to the JSON property webhookPayloads

Returns:

  • (Array<Hash<String,Object>>) 


10188
10189
10190
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10188

def webhook_payloads
  @webhook_payloads
end

#webhook_statuses ⇒ Array<Google::Apis::DialogflowV3beta1::GoogleRpcStatus>

The list of webhook call status in the order of call sequence. Corresponds to the JSON property webhookStatuses

Returns:



10193
10194
10195
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10193

def webhook_statuses
  @webhook_statuses
end

#webhook_tags ⇒ Array<String>

The list of webhook tags in the order of call sequence. Corresponds to the JSON property webhookTags

Returns:

  • (Array<String>) 


10198
10199
10200
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10198

def webhook_tags
  @webhook_tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10205

def update!(**args)
  @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings)
  @allow_answer_feedback = args[:allow_answer_feedback] if args.key?(:allow_answer_feedback)
  @current_flow = args[:current_flow] if args.key?(:current_flow)
  @current_page = args[:current_page] if args.key?(:current_page)
  @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info)
  @dtmf = args[:dtmf] if args.key?(:dtmf)
  @generative_info = args[:generative_info] if args.key?(:generative_info)
  @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)
  @match = args[:match] if args.key?(:match)
  @parameters = args[:parameters] if args.key?(:parameters)
  @response_messages = args[:response_messages] if args.key?(:response_messages)
  @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result)
  @text = args[:text] if args.key?(:text)
  @transcript = args[:transcript] if args.key?(:transcript)
  @trigger_event = args[:trigger_event] if args.key?(:trigger_event)
  @trigger_intent = args[:trigger_intent] if args.key?(:trigger_intent)
  @webhook_display_names = args[:webhook_display_names] if args.key?(:webhook_display_names)
  @webhook_ids = args[:webhook_ids] if args.key?(:webhook_ids)
  @webhook_latencies = args[:webhook_latencies] if args.key?(:webhook_latencies)
  @webhook_payloads = args[:webhook_payloads] if args.key?(:webhook_payloads)
  @webhook_statuses = args[:webhook_statuses] if args.key?(:webhook_statuses)
  @webhook_tags = args[:webhook_tags] if args.key?(:webhook_tags)
end