Changes between Version 26 and Version 27 of dialogmanager

Timestamp:

01/04/24 14:48:53 (10 months ago)

Author:

wouter

Comment:

--

dialogmanager

@@ -48 +48 @@
 It contains two main components:
 1. The DialogSpecification which is the map of the possible dialogs (see below)
-2. The current Parameters containing all processed information given by the user (see below)
+2. The current Parameters which are variables that can be used to build messages and do computations  (see below)
 
-This can be saved and later restored to pick up a dialog.
+The DialogState can be saved and later restored to resume up a dialog.
 
 
 == Parameters
-* The user's answers, current dialog state label, and other parameters relevant for the dialog are stored in a set of parameters. This is just a map with keys and values both strings. The keys are called the "variable name" and the values the "variable value". 
-* Distance between two parameters is the euclidean distance (sqrt of the sum of squares) of the difference between the two parameter values, on a per-key basis. Only values for which both parameters have the key are compared. For non-numeric values, the difference is usually 0 if the values are equal, or else 1. The exact definition differes per implementation.
+'Parameters' is a map of key-value pairs. The keys are a simple name String, the value is a ParameterValue, with various subtypes like BooleanValue, StringValue, VectorValue, DoubleValue.
+
+A Parameter can be used in various ways
+* Contain the user's answers, 
+* Contain the current dialog state label, 
+* Contain input and output values of computations
+
+The distance between two parameters (the set of key-values) is the euclidean distance (sqrt of the sum of squares) of the difference between the two parameter values, on a per-parameter basis. Only values for which both parameters have the same key are compared. For non-numeric values, the difference is usually 0 if the values are equal, or else 1. The exact definition differes per implementation.
 * The parameter values are BoolValue ("bool"), DoubleValue ("num"), KeywordsValue ("keywords"), StringValue ("txt") and VectorValue ("vector"). Check the javadocs for more details. 
-* The Keywords parameters is useful if you want to do keyword matching. It contains a list of (case-insensitive) keywords. The distance to a list of words (eg another Keywords parameter or the words in a StringParameter) is the minimu distance of any of the words to any of the keywords. Here the Levenshtein distance is used to determine the distance between a word and a keyword.
+* KeywordsValue is useful if you want to do keyword matching. It contains a list of (case-insensitive) keywords. The distance to a list of words (eg another Keywords parameter or the words in a StringParameter) is the [https://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein distance] of any of the words to any of the keywords.
 * The parameter named "phase" is special, it refers to the name of the current phase. If this variable is changed, the dialog jumps to the phase with the given name.