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.



4548
4549
4550
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4548

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) 


4507
4508
4509
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4507

def confidence
  @confidence
end

#event ⇒ String

The event that matched the query. Filled for EVENT, NO_MATCH and NO_INPUT match types. Corresponds to the JSON property event

Returns:

  • (String) 


4513
4514
4515
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4513

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:



4521
4522
4523
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4521

def intent
  @intent
end

#match_type ⇒ String

Type of this Match. Corresponds to the JSON property matchType

Returns:

  • (String) 


4526
4527
4528
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4526

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


4539
4540
4541
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4539

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) 


4546
4547
4548
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4546

def resolved_input
  @resolved_input
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4553
4554
4555
4556
4557
4558
4559
4560
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 4553

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