Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Match (v0.8.1)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Match.

Represents one match result of [MatchIntent][].

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#confidence

def confidence() -> ::Float

Returns

(::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.

#confidence=

def confidence=(value) -> ::Float

Parameter

value (::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.

Returns

(::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.

#event

def event() -> ::String

Returns

(::String) — The event that matched the query. Filled for EVENT, NO_MATCH and NO_INPUT match types.

#event=

def event=(value) -> ::String

Parameter

value (::String) — The event that matched the query. Filled for EVENT, NO_MATCH and NO_INPUT match types.

Returns

(::String) — The event that matched the query. Filled for EVENT, NO_MATCH and NO_INPUT match types.

#intent

def intent() -> ::Google::Cloud::Dialogflow::CX::V3::Intent

Returns

(::Google::Cloud::Dialogflow::CX::V3::Intent) — The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: name and display_name. Only filled for INTENT match type.

#intent=

def intent=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Intent

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::Intent) — The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: name and display_name. Only filled for INTENT match type.

Returns

(::Google::Cloud::Dialogflow::CX::V3::Intent) — The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: name and display_name. Only filled for INTENT match type.

#match_type

def match_type() -> ::Google::Cloud::Dialogflow::CX::V3::Match::MatchType

Returns

(::Google::Cloud::Dialogflow::CX::V3::Match::MatchType) — Type of this Match.

#match_type=

def match_type=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Match::MatchType

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::Match::MatchType) — Type of this Match.

Returns

(::Google::Cloud::Dialogflow::CX::V3::Match::MatchType) — Type of this Match.

#parameters

def parameters() -> ::Google::Protobuf::Struct

Returns

(::Google::Protobuf::Struct) —
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.

#parameters=

def parameters=(value) -> ::Google::Protobuf::Struct

Parameter

value (::Google::Protobuf::Struct) —
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.

Returns

(::Google::Protobuf::Struct) —
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.

#resolved_input

def resolved_input() -> ::String

Returns

(::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.

#resolved_input=

def resolved_input=(value) -> ::String

Parameter

value (::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.

Returns

(::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.