plan4dial.for_generating.parsers.json_config_parser

This module contains all the base functions required to convert a YAML configuration to the JSON configuration required by Hovor.

Authors: - Rebecca De Venezia

Functions

`configure_assignments`(known)	Converts the parameter known (which is either True, False, or "maybe") to the equivalent Hovor assignment ("found", "didnt-find", and "maybe-found" respectively).
`convert_yaml`(loaded_yaml)	Generates the JSON configuration required by Hovor from the provided YAML file.

_add_fallbacks(loaded_yaml: Dict) → None[source]

Ensure that non-fallback options can only run if a fallback did not just occur. Add fallback outcomes to actions as necessary.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.

_add_follow_ups_and_responses(loaded_yaml: Dict) → None[source]

Configures follow up actions and responses where they were specified in th YAML.

Follow ups are actions that are forced to take place after an outcome. Responses are messages that the agent must utter after an outcome.

NOTE: As it stands, follow ups only force the action that you specify and disable all others. This means that for actions that, for example, lead into clarifications, those clarifications will not be forced too. A more complex configuration for robust follow_up functionality (as well as more description of the issue) is detailed in #5, but this bare-bones specification can be safely used in the meantime.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.

_add_value_setters(loaded_yaml: Dict) → None[source]

Configures value setters when an action is contingent on the string value of a context variable. Resets the precondition of these actions to rely on the flag values that represent the true value of the context variable.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.
Raises:: AssertionError – Raised if the user tried to specify an invalid value for a context variable in a precondition.

_base_fallback_setup(loaded_yaml: Dict) → None[source]

Sets up the default intents, action, and context variables needed to handle fallbacks.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.

_configure_certainty(known: bool | str) → str[source]

Converts the parameter known (which is either True, False, or “maybe”) to the equivalent Hovor certainty (“Known”, “Unknown”, and “Uncertain” respectively). Used for preconditions.

Parameters:: known (bool or str) – The “known” status of a context variable in the YAML.
Returns:: The Hovor certainty equivalent to the “known” parameter provided.
Return type:: str

_configure_dialogue_statement() → Dict[source]

Returns the base dialogue_statement action.

Most often, the dialogue_statement action is triggered when a fallback occurs; in this case, dialogue_statement updates its message_variants to the appropriate fallback_message_variants. Dialogue statements are also used for responses, in which case dialogue_statement updates its message_variants to the appropriate response_variants.

Note that the intent utter_msg is a blank intent because message actions (dialogue type actions with a single outcome) do not take user input into account and simply execute the single outcome.

Returns:: The full configuration for the dialogue_statement action.
Return type:: Dict

_configure_fallback() → Dict[source]: Returns: Dict: Update configuration for a fallback outcome.

_configure_force_message_true() → Dict[source]: Returns: Dict: Configuration where force-statement is set to True. Used to force a dialogue_statement action.

_configure_message_actions(loaded_yaml: Dict) → None[source]

Adds a blank “utter_msg” intent to message actions (dialogue actions with a single outcome and no specified intent) and make them disable fallbacks by default.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.

_configure_value_setter(loaded_yaml: Dict, ctx_var: str) → None[source]

Configures the actions in loaded_yaml to allow for value setting. This allows values to be used in preconditions, i.e. cuisine: {value: "Mexican"}.

This is done by creating flag context variables that represent the value of the context variable; i.e. “cuisine-value-Mexican”. We need to create flag representations so that value knowledge is reflected in the PDDL and ultimately the generated tree/controller. This flag is what would be used as a precondition to check the value of the context variable.

Obviously, the flag values can be set when the context variable becomes known, and reset when the context variable becomes unknown.

Parameters:

loaded_yaml (Dict) – The loaded YAML configuration.
ctx_var (str) – The context variable referenced in value-dependent preconditions.

_convert_actions(loaded_yaml: Dict) → None[source]

Converts the actions from how they were formatted in the YAML to the JSON configuration that Hovor requires.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.

_convert_ctx_var(loaded_yaml: Dict) → None[source]

Converts the context variables from how they were formatted in the YAML to the JSON configuration that Hovor requires.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.

_convert_intents(loaded_yaml: Dict) → None[source]

Converts the intents from how they were formatted in the YAML to the JSON configuration that Hovor requires.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.

_convert_to_DNF(condition: Dict) → And[source]

Converts an action condition from the YAML to an NNF formula in Disjunctive Normal Form. Eventually, this would be used for auto-generating equivalent actions based on arbritrary logical formulas.

NOTE: Will not be in use until issue #4 is resolved.

Parameters:: condition (Dict) – An action condition from the YAML.
Returns:: The DNF formula that the action condition was converted to.
Return type:: nnf.And

_convert_to_formula(condition: Dict) → And | Or[source]

Converts an action condition from the YAML to a list of terms for an NNF formula.

Parameters:: condition (Dict) – An action condition from the YAML.
Returns:: An NNF formula.
Return type:: Union[nnf.And, nnf.Or]

TODO: Test extensively once arbitrary conversion to DNF becomes viable.

_duplicate_for_or_condition(loaded_yaml: Dict) → None[source]

Creates equivalent actions to those with an “or” precondition by splitting them up into separate actions.

NOTE: ARBITRARY FORMULAS ARE NOT YET HANDLED (see #4). Should not be deployed yet.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.

_duplicate_for_or_when_condition(loaded_yaml: Dict) → None[source]

Creates equivalent “when” expressions to those with an “or” condition by splitting them up into separate conditions.

NOTE: ARBITRARY FORMULAS ARE NOT YET HANDLED (see #3 and #4). Should not be deployed yet.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.

_instantiate_custom_actions(loaded_yaml: Dict) → None[source]

Instantiate custom actions.

NOTE: All custom action functions must be placed in a file in plan4dial/generate_files/custom_actions.py. The name of the file should be the same name as the function that configures the custom action.

NOTE: The custom actions are responsible for adding the actions to the configuration. This is because some custom actions add multiple actions, make changes to the context variables, etc. As a rule, the loaded_yaml should always be the first parameter.

NOTE: Custom actions should have “custom” as the type, and the name of the function as the subtype. Parameters to the function should go in a parameters dictionary.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.

configure_assignments(known: bool | str) → str[source]

Converts the parameter known (which is either True, False, or “maybe”) to the equivalent Hovor assignment (“found”, “didnt-find”, and “maybe-found” respectively). Used for outcomes.

Parameters:: known (bool or str) – The “known” status of a context variable in the YAML.
Returns:: The Hovor assignment equivalent to the “known” parameter provided.
Return type:: str

convert_yaml(loaded_yaml: Dict) → Dict[source]

Generates the JSON configuration required by Hovor from the provided YAML file. First preprocesses the YAML, adding clarification actions, follow-up actions, etc., then finally converts everything into Hovor format.

Parameters:: loaded_yaml (Dict) – The loaded YAML configuration.
Returns:: The JSON configuration required by Hovor.
Return type:: Dict