File size: 2,031 Bytes
23c9a86 9c31af5 23c9a86 9c31af5 23c9a86 9c31af5 23c9a86 9c31af5 23c9a86 9c31af5 23c9a86 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
from flow_modules.aiflows.HumanStandardInputFlowModule import HumanStandardInputFlow
from typing import Dict, Any
from aiflows.messages import UpdateMessage_Generic
from aiflows.utils import logging
log = logging.get_logger(f"aiflows.{__name__}")
class ExtLibAskUserFlow(HumanStandardInputFlow):
"""This class is used to ask for user feedback whenever the controller is unsure of something, or need confirmation, etc.
*Input Interface*:
- `question`: The question asked by the controller
*Expected Behaviour*:
- The question is displayed, and the user gives feedback by input string.
*Output Interface*:
- `result`: The input of the user.
- `summary`: The summary that will be written by the caller.
*Configuration Parameters*:
- `query_message_prompt_template`: The template of the message that is displayed to the user.
- `request_multi_line_input`: Whether the user should be able to input multiple lines. Default: False.
- `end_of_input_string`: The string that the user can input to indicate that he/she is done with the input. Default: EOI
"""
def run(self,
input_data: Dict[str, Any]) -> Dict[str, Any]:
"""Run the flow module.
:param input_data: The input data.
:type input_data: Dict[str, Any]
:return: The output data.
:rtype: Dict[str, Any]
"""
query_message = self._get_message(self.query_message_prompt_template, input_data)
state_update_message = UpdateMessage_Generic(
created_by=self.flow_config['name'],
updated_flow=self.flow_config["name"],
data={"query_message": query_message},
)
self._log_message(state_update_message)
log.info(query_message)
human_input = self._read_input()
question = input_data["question"]
response = {}
response["result"] = human_input
response["summary"] = f"Question raised: {question}; answer of user: {human_input}"
return response |