...
Tip |
---|
Create an agent and Read about How to Make Intents and Entities: |
Tip |
---|
Before you start |
...
: make sure your MARBEL agent is connected to Dialogflow: |
...
Note |
---|
Make sure |
...
the labels (names of intents and entities |
...
) you use in your MARBEL agent code are exactly the same as the intents and entity entry names that you have specified in your Dialogflow agent! Small spelling mistakes (e.g., using capitals or not, other misspellings) will cause issues later on! We advise to use https://en.wikipedia.org/wiki/Camel_case starting with a lowercase letter everywhere (except for the Training phrases that you add). |
Greeting Intent
Make an intent called ‘greeting’.
Under ‘Training Phrases’ add a number of expressions (at least 10) by which a user may greet - try and be thorough. For inspiration, do a https://www.google.com/ search for ‘greeting phrases’. You may find, for example, useful phrases here: https://www.tandem.net/blog/20-greetings-in-english.
Under ‘Action and parameters’ make sure the box above the table is filled in with the name of your intent as shown in the image below.
...
Note |
---|
Don’t forget to SAVE! |
Tip |
---|
Check that your ‘greeting’ intent is working by using the microphone button in the test console. |
Appreciation, Confirmation, Disconfirmation, Farewell Intents
Add the following intents, following the same procedure as you did for the ‘greeting’ intent and using . Use the same intent names as specified below:
appreciation
If a user expresses appreciation or gratitude (, for example: , ‘thanks’).
confirmation
If a user wants to agree or say ‘yes’.
disconfirmation
If a user wants to disagree or say ‘no’.
farewell
If a user wants to say 'goodbye'.
checkCapability
the intent that represents a user querying what your agent can do. An example phrase would be “What can you do?”.
Fallback Intent
The Default fallback intent Fallback Intent is one of the more important intents and it . It is already present available when creating you create your Dialogflow agent. Fallback intents are A fallback intent is triggered if a user's input is not matched by any of the other intents known by the agent, or if it matches the training phrases you input for this intent.
It is unnecessary not necessary to input add phrases that are completely unrelated to the topic of our recipe recommendation agent, as that these would definitely come back as an unknown intent. Thus, what you should do is think of related phrases that would be close to an intent but should not match with it. For example, one could argue “I do not like mushrooms” is food related and has refers to an ingredient entity inside‘mushroom’. Yet, you might argue that it should not be matched to any other intent, because of the intents you specify because you do not want users to discuss their likes and dislikes are not directly discussed with your botagent. Of courseAlternatively, one you could also argue you could to include ‘I like’ and ‘I dislike’ as training phrases for filtering by something - . But that is a design decision for you to make. This fallback intent ! The Fallback Intent should be updated as you add more intents throughout the project.
Entities
Before you can continue creating intents, you have to create the entities you need, since these will be part of the intent specification for certain entities (e.g.: , the presence of an entity type is used as a feature by the Dialogflow classifier model to recognize certain intents by). Some of these entities are have already given been provided to you. For information on how to upload and create entities, you should have please read this page: DialogFlow: Create an Agent, Intents and Entities.
Some entities were have not provided by us, and you been provided with the agent project. You have to add them yourself (see the list below). We provide an example for most to make sure you have at least a few entries for each entity. They may not be that intuitive at first, so make sure to extend the entity specification with more synonyms as you develop your agent evolvesfurther.
Note |
---|
If the word you enter for an entity entry has synonyms, |
...
enter these as synonyms rather than |
...
adding these as |
...
different entity entries! |
timeKeyWord - words that refer to measurements of time (hour, minutes, etc.)
shortTimeKeyWord - for example ‘fast’, ‘quick’ etc.
negationKeyword - to specify that something needs to be omitted (for example ‘without’ or ‘don’t’)
easyKeyWord - to specify recipes that are not hard to make (for example ‘simple’)
When you are done your entities Entities page should look as followshave the following entities:
...
...
The ‘addFilter’ Intent
Add filter The intent for filtering recipes is one of the most important intents. It is used to filter recipes for the user based on a variety of criteria. This is the first intent that employs all the entities we have created. In the user expressions, where the user is asking to filter, all different entities need to occur and be tagged in the set of examples. For example, for a training phrase like “I want a Chinese recipe”, ‘Chinese' needs to be tagged as ‘cuisine’, so this phrase can be parsed by Dialogflow in order to apply the filter Chinese ‘cuisine’ to the recipes in our database. The addFilter ‘addFilter’ intent can be found in the folder project provided to you , to start with and should be uploaded in Dialogflow by you.
Recipe Filtering
...
Helper
...
Predicates
To filter the recipes for the user in the way they intend, we parse their utterances with are mapped onto the intents and entities we made you specified in Dialogflow. This then returns the identified intent (for example, ‘addFilter’) and entity information (for example, cuisine - ‘Chinese’). We must now take this information and The MARBEL agent must be able to use this information. In order to make this happen, you need to create Prolog rules to access and gather filter the filtered available recipes in the Prolog database. This is can be done via by introducing the following functions. The Prolog predicates. We have already specified the heads of all rules can be seen in the recipe_selection.pl
and that file. That is where you still need to add the bodies should be addedfor these rules. We need a few helper functions before we can start implementing code for filtering these, which are described belownext. For each rule, you first need to uncomment it.
nrOfIngredients
We will start off easy.
Code Block |
---|
nrOfIngredients(RecipeID, N) :- |
Create a rule to return N
, the length of the list of ingredients for a certain RecipeID
. HINT Hint: your Visual Support groupmates team members should have made an ingredients function that could help.
nrSteps
Code Block |
---|
nrSteps(RecipeID, N) :- |
Create a rule to return N
, the number of steps for a certain RecipeID. HINT: your groupmates should have made a recipeSteps function that could help.
diet
Code Block |
---|
diet(RecipeID, DietaryRestriction) :- |
In the diet rule, we need to find all the ingredients that a certain recipe has and then input them into a new function we shall create below diet, called ‘ingredientsMeetDiet’. This function should return a diet should work if the list of ingredients that fit of the inputted RecipeID fits the dietary restriction . This list should be returned with the name inputted DietaryRestriction.
Code Block |
---|
ingredientsMeetDiet([ Ingredient | Rest ], DietaryRestriction) :- |
The ingredientsMeetDiet predicate is our stop clause, which should take a list of ingredients and check if each one meets a dietary restriction. It has a stop clause that is in the file already and will recursively check each ingredient and return ‘false’ when an ingredient does not meet the given dietary restriction. The predicate ‘typeIngredient’ can be used to check if an ingredient meets a dietary restriction. Fill in the body of the rule for ingredientsMeetDiet.
easyRecipe
Code Block |
---|
easyRecipe(RecipeID) :- |
...
it can be made within 45 minutes,
it has less than 18 steps, and
it has less than 15 ingredients
Recipe Filtering
...
Predicate
You will now introduce a predicate applyFilter/4
for filtering recipes that returns a list of filtered recipes in the form of their RecipeIDs. The Again, the heads of the rules that you need to define are in the recipe_selection.pl
file.
There are a number of different variants rules that you need to implement of the ‘applyFilter’ rulefor the applyFilter/4
predicate, depending on the specific filter that needs to be applied - . For example, filtering recipes for a cuisine asks for a different function rule than filtering for the duration of a recipe. These variants are specified in the table below. For each rule, you first need to uncomment it.
applyFilter
Code Block |
---|
applyFilter(+ParamName, +Value, +RecipeIDs, -FilteredRecipes) |
Filters the recipes provided as input using the (Key) feature with associated value and returns the recipes that satisfy the feature as output.
...
Predicate Description | Rule Head | Notes/Instructions |
---|---|---|
The predicate to filter recipes on cuisines (e.g., Italian recipes) | applyFilter('cuisine', Value, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter recipes that meet the dietary restrictions (such as ‘vegetarian’). | applyFilter('dietaryrestriction', Value, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter recipes on the max amount of time | applyFilter('duration', Minutes, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter easy recipes | applyFilter('easykeyword', _, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter recipes on the exclusion of a specific ingredient | applyFilter('excludeingredient', Ingredient, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter recipes on the exclusion of a specific ingredient type (for example: ‘beef’) | applyFilter('excludeingredienttype', Ingredient, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicates to filter recipes on a specific ingredient inclusion | applyFilter('ingredient', Ingredient, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter by including an ingredient type | applyFilter('ingredienttype', Ingredient, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter recipes on meal type (for example: breakfast) | applyFilter('mealType', Value, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter recipes on a maximum number of ingredients | applyFilter('nrOfIngredients', Value, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter recipes on a maximum number of steps | applyFilter('nrSteps', Value, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter recipes and return fast recipes. A recipe is fast if it takes less than 30 minutes | applyFilter('shorttimekeyword', _, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter on the number of servings | applyFilter('servings', Value, RecipeIDsIn, RecipeIDsOut) :- |
|
Predicate to filter recipes on a tag (for example: pizza) | applyFilter('tag', Value, RecipeIDsIn, RecipeIDsOut) :- |
|
Further Necessary Intents
deleteFilterValue
‘deleteFilterValue’ is useful to deal with a scenario where the user requests to remove a filter that they have already put on specifically. For example, “I wish to remove the onion filter”, “Forget about excluding broccoli”, and “Can you delete the Chinese cuisine”. Add some training phrases with all the different filters that could be deleted.
It is thus important that in your training phrases, you include a variety of all filter-related entities and that these entities are also given specific values and parameter names in the Action and Parameters tables. These entities are given new parameters and value names in order to identify them as a filter to be deleted. Specifically, you tag the entity in your training phrases as normal and then you change the parameter name and value name to “entitynameDel”. Your entity table under Action and Parameters should look like this when you are done.
...
deleteParameter
The ‘deleteParameter’ intent is identified when the user requests to remove a kind of constraint. For example, “I wish to remove the ingredient constraint”, and “Please drop the step constraint”. This intent requires the use of a certain entity. Make sure to include it in your action and parameters section.
noMoreFilters
The ‘noMoreFilters’ intent is used when the user does not want to add any more filters to their recipes list and wishes to see the available recipes.
recipeRequest
‘recipeRequest’ is used to confirm the user's choice of recipes (“I want this specific recipe name here”). Under Entities, you can find an entity for the recipe names in our database.
In the end, your Intent page should look like this:
...
This marks You have reached the end of the basic implementation of the Natural Language Understanding of your and recipe filtering code for your recipe recommendation agent. Make sure to properly test each intent, entity and rule that you have implemented (further detailed in the System testing section). For how to do this check out the Agent Testing section.