Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3QueryResult

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 a conversational query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3QueryResult

Returns a new instance of GoogleCloudDialogflowCxV3QueryResult.



2967
2968
2969
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2967

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

Instance Attribute Details

#current_page ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Page

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:



2866
2867
2868
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2866

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 string keys of the Struct's fields map can change without notice. Corresponds to the JSON property diagnosticInfo

Returns:

  • (Hash<String,Object>) 


2873
2874
2875
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2873

def diagnostic_info
  @diagnostic_info
end

#intent ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Intent

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:



2881
2882
2883
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2881

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) 


2891
2892
2893
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2891

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) 


2898
2899
2900
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2898

def language_code
  @language_code
end

#match ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Match

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

Returns:



2903
2904
2905
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2903

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


2915
2916
2917
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2915

def parameters
  @parameters
end

#response_messages ⇒ Array<Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ResponseMessage>

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:



2922
2923
2924
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2922

def response_messages
  @response_messages
end

#sentiment_analysis_result ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3SentimentAnalysisResult

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:



2929
2930
2931
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2929

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) 


2935
2936
2937
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2935

def text
  @text
end

#transcript ⇒ String

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

Returns:

  • (String) 


2941
2942
2943
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2941

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) 


2947
2948
2949
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2947

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

Returns:

  • (String) 


2953
2954
2955
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2953

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


2960
2961
2962
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2960

def webhook_payloads
  @webhook_payloads
end

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

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

Returns:



2965
2966
2967
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2965

def webhook_statuses
  @webhook_statuses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2972

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