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.



10376
10377
10378
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10376

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:



10209
10210
10211
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10209

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) 


10215
10216
10217
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10215

def allow_answer_feedback
  @allow_answer_feedback
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:



10232
10233
10234
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10232

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:



10240
10241
10242
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10240

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


10256
10257
10258
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10256

def diagnostic_info
  @diagnostic_info
end

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

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

Returns:



10261
10262
10263
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10261

def dtmf
  @dtmf
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:



10269
10270
10271
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10269

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) 


10279
10280
10281
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10279

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) 


10286
10287
10288
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10286

def language_code
  @language_code
end

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

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

Returns:



10291
10292
10293
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10291

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


10304
10305
10306
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10304

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:



10311
10312
10313
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10311

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:



10318
10319
10320
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10318

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) 


10324
10325
10326
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10324

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) 


10330
10331
10332
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10330

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) 


10336
10337
10338
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10336

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) 


10342
10343
10344
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10342

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


10347
10348
10349
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10347

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


10352
10353
10354
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10352

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


10357
10358
10359
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10357

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


10364
10365
10366
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10364

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:



10369
10370
10371
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10369

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


10374
10375
10376
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10374

def webhook_tags
  @webhook_tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 10381

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