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

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 one match result of MatchIntent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3Match

Returns a new instance of GoogleCloudDialogflowCxV3Match.



2341
2342
2343
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2341

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

Instance Attribute Details

#confidenceFloat

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)


2302
2303
2304
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2302

def confidence
  @confidence
end

#eventString

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

Returns:

  • (String)


2307
2308
2309
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2307

def event
  @event
end

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



2315
2316
2317
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2315

def intent
  @intent
end

#match_typeString

Type of this Match. Corresponds to the JSON property matchType

Returns:

  • (String)


2320
2321
2322
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2320

def match_type
  @match_type
end

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


2332
2333
2334
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2332

def parameters
  @parameters
end

#resolved_inputString

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)


2339
2340
2341
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2339

def resolved_input
  @resolved_input
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2346
2347
2348
2349
2350
2351
2352
2353
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 2346

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