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.



7310
7311
7312
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7310

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

Instance Attribute Details

#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:



7194
7195
7196
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7194

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


7210
7211
7212
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7210

def diagnostic_info
  @diagnostic_info
end

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

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

Returns:



7215
7216
7217
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7215

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:



7223
7224
7225
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7223

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) 


7233
7234
7235
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7233

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) 


7240
7241
7242
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7240

def language_code
  @language_code
end

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

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

Returns:



7245
7246
7247
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7245

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


7258
7259
7260
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7258

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:



7265
7266
7267
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7265

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:



7272
7273
7274
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7272

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) 


7278
7279
7280
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7278

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) 


7284
7285
7286
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7284

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) 


7290
7291
7292
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7290

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) 


7296
7297
7298
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7296

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


7303
7304
7305
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7303

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:



7308
7309
7310
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7308

def webhook_statuses
  @webhook_statuses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 7315

def update!(**args)
  @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)
  @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_payloads = args[:webhook_payloads] if args.key?(:webhook_payloads)
  @webhook_statuses = args[:webhook_statuses] if args.key?(:webhook_statuses)
end