Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3Match

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

Overview

Represents one match result of MatchIntent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Match

Returns a new instance of GoogleCloudDialogflowCxV3Match.



2952
2953
2954
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2952

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

Instance Attribute Details

#confidence ⇒ Float

The confidence of this match. 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. Corresponds to the JSON property confidence

Returns:

  • (Float) 


2912
2913
2914
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2912

def confidence
  @confidence
end

#event ⇒ String

The event that matched the query. Only filled for EVENT match type. Corresponds to the JSON property event

Returns:

  • (String) 


2917
2918
2919
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2917

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



2925
2926
2927
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2925

def intent
  @intent
end

#match_type ⇒ String

Type of this Match. Corresponds to the JSON property matchType

Returns:

  • (String) 


2930
2931
2932
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2930

def match_type
  @match_type
end

#parameters ⇒ Hash<String,Object>

The collection of parameters extracted from the query. 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: depending on parameter value type, could be one of string, number, boolean, null, list or map - 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>) 


2943
2944
2945
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2943

def parameters
  @parameters
end

#resolved_input ⇒ String

Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing. Corresponds to the JSON property resolvedInput

Returns:

  • (String) 


2950
2951
2952
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2950

def resolved_input
  @resolved_input
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2957
2958
2959
2960
2961
2962
2963
2964
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2957

def update!(**args)
  @confidence = args[:confidence] if args.key?(:confidence)
  @event = args[:event] if args.key?(:event)
  @intent = args[:intent] if args.key?(:intent)
  @match_type = args[:match_type] if args.key?(:match_type)
  @parameters = args[:parameters] if args.key?(:parameters)
  @resolved_input = args[:resolved_input] if args.key?(:resolved_input)
end