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.



11223
11224
11225
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11223

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:



11036
11037
11038
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11036

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) 


11042
11043
11044
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11042

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:



11058
11059
11060
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11058

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:



11074
11075
11076
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11074

def current_page
  @current_page
end

#data_store_connection_signals ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals

Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... Corresponds to the JSON property dataStoreConnectionSignals

Returns:



11082
11083
11084
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11082

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


11098
11099
11100
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11098

def diagnostic_info
  @diagnostic_info
end

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

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

Returns:



11103
11104
11105
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11103

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:



11108
11109
11110
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11108

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:



11116
11117
11118
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11116

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) 


11126
11127
11128
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11126

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) 


11133
11134
11135
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11133

def language_code
  @language_code
end

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

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

Returns:



11138
11139
11140
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11138

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


11151
11152
11153
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11151

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:



11158
11159
11160
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11158

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:



11165
11166
11167
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11165

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) 


11171
11172
11173
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11171

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) 


11177
11178
11179
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11177

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) 


11183
11184
11185
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11183

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) 


11189
11190
11191
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11189

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


11194
11195
11196
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11194

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


11199
11200
11201
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11199

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


11204
11205
11206
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11204

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


11211
11212
11213
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11211

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:



11216
11217
11218
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11216

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


11221
11222
11223
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11221

def webhook_tags
  @webhook_tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 11228

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