Proper Doc

README.md

@@ -1,12 +1,17 @@
 ---
 license: mit
 ---
-
 # Table of Contents
 
 * [ChatHumanFlowModule](#ChatHumanFlowModule)
   * [ChatHumanFlowModule](#ChatHumanFlowModule.ChatHumanFlowModule)
+    * [set\_up\_flow\_state](#ChatHumanFlowModule.ChatHumanFlowModule.set_up_flow_state)
     * [type](#ChatHumanFlowModule.ChatHumanFlowModule.type)
+    * [max\_rounds\_reached](#ChatHumanFlowModule.ChatHumanFlowModule.max_rounds_reached)
+    * [generate\_reply](#ChatHumanFlowModule.ChatHumanFlowModule.generate_reply)
+    * [call\_to\_user](#ChatHumanFlowModule.ChatHumanFlowModule.call_to_user)
+    * [call\_to\_assistant](#ChatHumanFlowModule.ChatHumanFlowModule.call_to_assistant)
+    * [run](#ChatHumanFlowModule.ChatHumanFlowModule.run)
 
 <a id="ChatHumanFlowModule"></a>
 
@@ -17,7 +22,7 @@ license: mit
 ## ChatHumanFlowModule Objects
 
 ```python
-class ChatHumanFlowModule(CircularFlow)
+class ChatHumanFlowModule(CompositeFlow)
 ```
 
 This class implements a Chat Human Flow Module. It is a flow that consists of two sub-flows that are executed circularly. It Contains the following subflows:
@@ -60,6 +65,16 @@ By default, the topology is the one shown in the illustration above (the topolog
 
 - `\**kwargs` (`Dict[str, Any]`): Arguments to be passed to the parent class CircularFlow constructor.
 
+<a id="ChatHumanFlowModule.ChatHumanFlowModule.set_up_flow_state"></a>
+
+#### set\_up\_flow\_state
+
+```python
+def set_up_flow_state()
+```
+
+This method sets up the flow state. It is called when the flow is executed.
+
 <a id="ChatHumanFlowModule.ChatHumanFlowModule.type"></a>
 
 #### type
@@ -71,3 +86,69 @@ def type(cls)
 
 This method returns the type of the flow.
 
+<a id="ChatHumanFlowModule.ChatHumanFlowModule.max_rounds_reached"></a>
+
+#### max\_rounds\_reached
+
+```python
+def max_rounds_reached()
+```
+
+This method checks if the maximum number of rounds has been reached. If the maximum number of rounds has been reached, it returns True. Otherwise, it returns False.
+
+<a id="ChatHumanFlowModule.ChatHumanFlowModule.generate_reply"></a>
+
+#### generate\_reply
+
+```python
+def generate_reply()
+```
+
+This method generates the reply message. It is called when the interaction is finished.
+
+**Arguments**:
+
+- `input_message` (`FlowMessage`): The input message to the flow.
+
+<a id="ChatHumanFlowModule.ChatHumanFlowModule.call_to_user"></a>
+
+#### call\_to\_user
+
+```python
+def call_to_user(input_message)
+```
+
+This method calls the User Flow. (Human)
+
+**Arguments**:
+
+- `input_message` (`FlowMessage`): The input message to the flow.
+
+<a id="ChatHumanFlowModule.ChatHumanFlowModule.call_to_assistant"></a>
+
+#### call\_to\_assistant
+
+```python
+def call_to_assistant(input_message)
+```
+
+This method calls the Assistant Flow.
+
+**Arguments**:
+
+- `input_message` (`FlowMessage`): The input message to the flow.
+
+<a id="ChatHumanFlowModule.ChatHumanFlowModule.run"></a>
+
+#### run
+
+```python
+def run(input_message: FlowMessage)
+```
+
+This method runs the flow. It is the main method of the flow and it is called when the flow is executed.
+
+**Arguments**:
+
+- `input_message` (`FlowMessage`): The input message to the flow.
+