| from flows.base_flows import SequentialFlow | |
| from flows.utils import logging | |
| logging.set_verbosity_debug() | |
| log = logging.get_logger(__name__) | |
| class ChatWithDemonstrationsFlow(SequentialFlow): | |
| """ A Chat with Demonstrations Flow. It is a flow that consists of multiple sub-flows that are executed sequentially. | |
| It's parent class is SequentialFlow. | |
| It Contains the following subflows: | |
| - A Demonstration Flow: It is a flow that passes demonstrations to the ChatFlow | |
| - A Chat Flow: It is a flow that uses the demonstrations to answer queries asked by the user/human. | |
| An illustration of the flow is as follows: | |
| -------> Demonstration Flow -------> Chat Flow -------> | |
| *Configuration Parameters*: | |
| - `name` (str): The name of the flow. Default: "ChatAtomic_Flow_with_Demonstrations" | |
| - `description` (str): A description of the flow. This description is used to generate the help message of the flow. | |
| Default: "A sequential flow that answers questions with demonstrations" | |
| - `subflows_config` (Dict[str,Any]): A dictionary of subflows configurations of the sequential Flow. Default: | |
| - `Demonstration Flow`: The configuration of the Demonstration Flow. By default, it a DemonstrationsAtomicFlow. | |
| Its default parmaters are defined in DemonstrationsAtomicFlow). | |
| - `Chat Flow`: The configuration of the Chat Flow. By default, its a ChatAtomicFlow. | |
| Its default parmaters are defined in ChatAtomicFlowModule (see Flowcard, i.e. README.md, of ChatAtomicFlowModule). | |
| - `topology` (str): The topology of the flow which is "sequential". By default, the topology is the one shown in the | |
| illustration above (the topology is also described in ChatWithDemonstrationsFlow.yaml). | |
| *Input Interface*: | |
| - `query` (str): A query asked to the flow (e.g. "What is the capital of France?") | |
| Output Interface: | |
| - `answer` (str): The answer of the flow to the query | |
| :param \**kwargs: Arguments to be passed to the parent class SequentialFlow constructor. | |
| """ | |
| def __init__(self,**kwargs): | |
| super().__init__(**kwargs) |