Merge pull request #66 from UiPath/docs/add-reinvoke-warning

docs: add warning message in quick start guide

Author: radugheo

docs/human_in_the_loop.md

@@ -13,8 +13,9 @@ For more information on UiPath apps, refer to the [UiPath Apps User Guide](https
 
 #### Attributes:
 
--   **name** (Optional[str]): The name of the app.
--   **key** (Optional[str]): The key of the app.
+-   **app_name** (Optional[str]): The name of the app.
+-   **app_folder_path** (Optional[str]): The folder path of the app.
+-   **app_key** (Optional[str]): The key of the app.
 -   **title** (str): The title of the action to create.
 -   **data** (Optional[Dict[str, Any]]): Values that the action will be populated with.
 -   **app_version** (Optional[int]): The version of the app (defaults to 1).
@@ -24,7 +25,7 @@ For more information on UiPath apps, refer to the [UiPath Apps User Guide](https
 
 ```python
 from uipath_llamaindex.models import CreateActionEvent
-action_output = ctx.write_event_to_stream(CreateActionEvent(name="AppName", title="Escalate Issue", data={"key": "value"}, app_version=1, assignee="user@example.com"))
+action_output = ctx.write_event_to_stream(CreateActionEvent(app_name="AppName", app_folder_path="MyFolderPath", title="Escalate Issue", data={"key": "value"}, app_version=1, assignee="user@example.com"))
 ```
 
 For a practical implementation of the `CreateAction` model, refer to the [action-center-hitl-agent](https://github.com/UiPath/uipath-llamaindex-python/tree/main/samples/action-center-hitl-agent). This sample demonstrates how to create an action with dynamic input.
@@ -39,12 +40,13 @@ The `WaitAction` model is used to wait for an action to be handled. This model i
 #### Attributes:
 
 -   **action** (Action): The instance of the action to wait for.
+-   **app_folder_path** (Optional[str]): The folder path of the app.
 
 #### Example:
 
 ```python
 from uipath_llamaindex.models import WaitActionEvent
-action_output = ctx.write_event_to_stream(WaitActionEvent(action=my_action_instance))
+action_output = ctx.write_event_to_stream(WaitActionEvent(action=my_action_instance, app_folder_path="MyFolderPath"))
 ```
 
 ---
@@ -61,15 +63,20 @@ Upon completion of the invoked process, the current agent will automatically res
 #### Attributes:
 
 -   **name** (str): The name of the process to invoke.
+-   **process_folder_path** (Optional[str]): The folder path of the process.
 -   **input_arguments** (Optional[Dict[str, Any]]): A dictionary containing the input arguments required for the invoked process.
 
 #### Example:
 
 ```python
 from uipath_llamaindex.models import InvokeProcessEvent
-process_output = ctx.write_event_to_stream(InvokeProcessEvent(name="MyProcess", input_arguments={"arg1": "value1"}))
+process_output = ctx.write_event_to_stream(InvokeProcessEvent(name="MyProcess", process_folder_path="MyFolderPath", input_arguments={"arg1": "value1"}))
 ```
 
+/// warning
+An agent can invoke itself if needed, but this must be done with caution. Be mindful that using the same name for invocation may lead to unintentional loops. To prevent recursion issues, implement safeguards like exit conditions.
+///
+
 For a practical implementation of the `InvokeProcess` model, refer to the [multi-agent sample](https://github.com/UiPath/uipath-llamaindex-python/tree/main/samples/multi-agent). This sample demonstrates how to invoke a process with dynamic input arguments, showcasing the integration of the interrupt functionality within a multi-agent system or a system where an agent integrates with RPA processes and API workflows.
 
 ---
@@ -82,10 +89,11 @@ the job has already been created.
 #### Attributes:
 
 -   **job** (Job): The instance of the job that the agent will wait for. This should be a valid job object that has been previously created.
+-   **process_folder_path** (Optional[str]): The folder path of the process.
 
 #### Example:
 
 ```python
 from uipath_llamaindex.models import WaitJobEvent
-job_output = ctx.write_event_to_stream(WaitJobEvent(job=my_job_instance))
+job_output = ctx.write_event_to_stream(WaitJobEvent(job=my_job_instance, process_folder_path="MyFolderPath"))
 ```

samples/multi-agent/README.md

@@ -0,0 +1,59 @@
+# Company Research Agent
+
+This UiPath LlamaIndex agent assists in researching companies using AI and human-in-the-loop (HITL) collaboration. It triggers external processes, waits for human input, and generates validated reports.
+
+## Features
+* Triggers a UiPath workflow to research and analyze the given company name
+* Incorporates human feedback to validate the analysis
+* Produces the final, validated company report
+
+## Getting Started
+
+### 1. Clone the Repository
+
+```sh
+git clone https://github.com/your-org/uipath-llamaindex-python.git
+cd uipath-llamaindex-python/samples/multi-agent
+```
+
+### 2. Set Up Python Environment
+
+```sh
+python -m venv .venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+pip install -r requirements.txt
+```
+
+Or use `pyproject.toml` with pip:
+```sh
+pip install .
+```
+
+### 3. Configure Environment
+
+Copy `.env.template` to `.env` and fill in your secrets (API keys, tokens, etc.)
+
+### 4. Run the Agent
+
+```sh
+uipath run agent --file ./input.json
+```
+
+> **Warning:** An agent can invoke itself if needed, but this must be done with caution. Be mindful that using the same name for invocation may lead to unintentional loops. To prevent recursion issues, implement safeguards like exit conditions.
+
+### 5. Resume
+
+To approve the rules and commit them use:
+```sh
+uipath run agent true --resume
+```
+
+Example:
+```sh
+uipath run agent --file ./input.json
+```
+
+### Deployment Guide
+
+To run the company-researcher-agent on the UiPath Cloud Platform, follow this guide:
+[Ticket Classification Sample Deployment](https://github.com/UiPath/uipath-langchain-python/tree/main/samples/ticket-classification)