match With Entity property

Official Content
This documentation is valid for:
If true, the provider maps this parameter with an entity value.

Description

Through this property, the User Input can be matched with an entity. The entity has to be specified in the entity property.

This guarantees that the user input will be validated against an entity value by the provider.

Important

When a User Input has Match With Entity property = TRUE, the entity value can also be obtained from the user's initial query (which triggers the flow), if the Trigger Messages property includes a training phrase which references the Entity. See the example below.

Samples

I. 

In the following example, UserIdentification is a User Input which has the Match With entity property configured. The Entity property determines the name of the entity that will be matched. In this case, it's called "UserIdentification."

When the end user is asked to enter the user ID, the input has to match any value of the "UserIdentification" entity defined in the AI provider.

image_2018522164312_1_png

If the user fails to enter a valid value, the message specified in the On Error Messages property is displayed.

II. Obtaining the Entity value from the user's initial query

In this example, one Trigger Message of the "Get Activities Information" Flow is as follows:

"information about @Activities"

Where @Activities is a reference to the Activities Entity defined in the NLP Provider. At the same time, the Flow is as follows:

image_20181122111536_1_png

Note that the User Input (which prompts the user for the type of activity he's interested in), matches the Entity Activities.

So, if the user's initial query is "I need information about artistic activities," he won't be asked to enter the User Input because he has already included that information in his query (as "artistic" is a valid value for "Activities" entity).

At runtime:

image_20181122113845_1_png

image_20181122113820_1_png

Scope

Objects: Conversational Flows

See Also

Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.