Proper Doc

README.md

@@ -1,7 +1,6 @@
 ---
 license: mit
 ---
-
 # Table of Contents
 
 * [ChatAtomicFlow](#ChatAtomicFlow)
@@ -9,6 +8,7 @@ license: mit
     * [set\_up\_flow\_state](#ChatAtomicFlow.ChatAtomicFlow.set_up_flow_state)
     * [instantiate\_from\_config](#ChatAtomicFlow.ChatAtomicFlow.instantiate_from_config)
     * [get\_interface\_description](#ChatAtomicFlow.ChatAtomicFlow.get_interface_description)
+    * [query\_llm](#ChatAtomicFlow.ChatAtomicFlow.query_llm)
     * [run](#ChatAtomicFlow.ChatAtomicFlow.run)
 
 <a id="ChatAtomicFlow"></a>
@@ -136,15 +136,15 @@ This method returns the description of the flow's input and output interface.
 
 `Dict[str, Any]`: The description of the flow's interface.
 
-<a id="ChatAtomicFlow.ChatAtomicFlow.run"></a>
+<a id="ChatAtomicFlow.ChatAtomicFlow.query_llm"></a>
 
-#### run
+#### query\_llm
 
 ```python
-def run(input_data: Dict[str, Any])
+def query_llm(input_data: Dict[str, Any])
 ```
 
-This method runs the flow. It processes the input, calls the backend and updates the state of the flow.
+This method queries the LLM. It processes the input, calls the backend and returns the response.
 
 **Arguments**:
 
@@ -152,5 +152,19 @@ This method runs the flow. It processes the input, calls the backend and updates
 
 **Returns**:
 
-`Dict[str, Any]`: The LLM's api output.
+`Union[str, List[str]]`: The response of the LLM to the input.
+
+<a id="ChatAtomicFlow.ChatAtomicFlow.run"></a>
+
+#### run
+
+```python
+def run(input_message: FlowMessage)
+```
+
+This method runs the flow. It processes the input, calls the backend and updates the state of the flow.
+
+**Arguments**:
+
+- `input_message` (`aiflows.messages.FlowMessage`): The input data of the flow.