Changes between Version 21 and Version 22 of dialogmanager

Timestamp:

02/01/23 16:07:38 (22 months ago)

Author:

wouter

Comment:

--

dialogmanager

@@ -58 +58 @@
 * 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.
+* 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.
 
 
@@ -64 +65 @@
 
 * DialogSpecification. A kind of finite state machine. The nodes and edges are contained on  a per-node basis in  DialogPhases. 
-* DialogPhase. Each dialog phase represents a situation where we want the user to answer some question. Each has a unique label. The START and END label indicate the usual start and end of the dialog. 
+* DialogPhase. Each dialog phase represents a situation where we want the user to answer some question. Each has a unique label.  
 In each phase, a number of similar questions called DialogOption are available. Also the DialogPhase defines the NestPhase which can determine what is the next DialogPhase to go.
 *  A DialogOption is one of multiple ways to proceed in a given {@link DialogPhase}. It consists of a simulation (something presented to the user, eg a question) and the answer type expected from the user (eg, a number between 0 and 10).
 * Dialog state. The current state of the dialogL the DialogSpecification, a set of Parameters comprising the culmination of the user's answers so far, and the (randomly) chosen DialogOption for the current Phase. 
+* The Evaluation is a list of UpdateFunction s.
+
 
 
@@ -94 +97 @@
 
 == UpdateFunction
+An UpdateFunction is a function that changes a Parameter value. The following are available:
+||UpdateFunction||description||Additional parameters||
+||Set||Directly sets the parameter to a given value. ||value: ParameterValue||
+||BlockSubstitute||Substitutes in given value all occurences if [X] where X is a known parameter
+ with the value of parameter X. Unknown parameters are not substituted||value: ParameterValue||
+||ValueWithCondition||Sets parameter to given value , iF the condition holds.||value:ParameterValue, condition: Parameters||
+||SetBestMatch||sets a parameter to the value that has the best condition||valueconditions: List<ValueWithCondition>||
+
+
+
+== UpdateFunction
 An UpdateFunction is one of the phases of the DialogPhase. It allows computation of derived variable values. These functions can be programmed in Java. Generally these functions look like this in json