ReplanningFlowModule / ReplanningAskUserFlow.py
Tachi67's picture
add more comments & docs; link change
2dccc9b verified
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 ReplanningAskUserFlow(HumanStandardInputFlow):
"""Refer to: https://huggingface.co/aiflows/ExtendLibraryFlowModule/blob/main/ExtLibAskUserFlow.py
*Input Interface*:
- `question`
*Output Interface*:
- `feedback`
- `new_plan`
*Configuration Parameters*:
- `request_multi_line_input_flag`: if True, the user can input multiple lines of text. Default: False
- `end_of_input_string`: the string that the user can input to indicate that the input is finished. Default: EOI
- `query_message_prompt_template`: the template of the message that is sent to the user to ask for input.
"""
def run(self,
input_data: Dict[str, Any]) -> Dict[str, Any]:
"""Run the flow module.
:param input_data: the input data
:return: the output data
"""
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()
response = {}
response["feedback"] = human_input
response["new_plan"] = "no new plan was written"
return response