Merge pull request #86 from UiPath/fix/update_new_contracts

fix: update samples and docs

Author: cristipufu

README.md

@@ -47,7 +47,7 @@ The SDK provides a command-line interface for creating, packaging, and deploying
 uipath init
 ```
 
-Running `uipath init` will process the graph definitions in the `llama_index.json` file and create the corresponding `entry-points.json` file needed for deployment.
+Running `uipath init` will process the workflow definitions in the `llama_index.json` file and create the corresponding `entry-points.json` file needed for deployment.
 
 For more details on the configuration format, see the [UiPath configuration specifications](https://github.com/UiPath/uipath-python/blob/main/specs/README.md).
 

docs/human_in_the_loop.md

@@ -5,58 +5,59 @@ It focuses on the **ctx.write_event_to_stream** LlamaIndex functionality.
 
 ## Models Overview
 
-### 1. CreateAction
+### 1. CreateTaskEvent
 
-The `CreateAction` model is utilized to create an escalation action within the UiPath Action Center as part of an interrupt context. The action will rely on a previously created UiPath app.
+The `CreateTaskEvent` model is utilized to create an escalation task within the UiPath Action Center as part of an interrupt context. The task will rely on a previously created UiPath app.
 After addressing the escalation, the current agent will resume execution.
-For more information on UiPath apps, refer to the [UiPath Apps User Guide](https://docs.uipath.com/apps/automation-cloud/latest/user-guide/introduction).
+For more information on UiPath Apps, refer to the [UiPath Apps User Guide](https://docs.uipath.com/apps/automation-cloud/latest/user-guide/introduction).
 
 #### Attributes:
 
 -   **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).
+-   **title** (str): The title of the task to create.
+-   **data** (Optional[Dict[str, Any]]): Values that the task will be populated with.
 -   **assignee** (Optional[str]): The username or email of the person assigned to handle the escalation.
 
 #### Example:
 
 ```python
-from uipath_llamaindex.models import CreateActionEvent
-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"))
+from uipath_llamaindex.models import CreateTaskEvent
+ctx.write_event_to_stream(CreateTaskEvent(app_name="AppName", app_folder_path="MyFolderPath", title="Escalate Issue", data={"key": "value"}, assignee="user@example.com"))
+task_data = await ctx.wait_for_event(HumanResponseEvent)
 ```
 
-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.
+For a practical implementation of the `CreateTaskEvent` 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 a task with dynamic input.
 
 
 ---
 
-### 2. WaitAction
+### 2. WaitTaskEvent
 
-The `WaitAction` model is used to wait for an action to be handled. This model is intended for scenarios where the action has already been created.
+The `WaitTaskEvent` model is used to wait for a task to be approved. This model is intended for scenarios where the task has already been created.
 
 #### Attributes:
 
--   **action** (Action): The instance of the action to wait for.
+-   **action** (Task): The instance of the task 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, app_folder_path="MyFolderPath"))
+from uipath_llamaindex.models import WaitTaskEvent
+ctx.write_event_to_stream(WaitTaskEvent(action=my_task_instance, app_folder_path="MyFolderPath"))
+task_data = await ctx.wait_for_event(HumanResponseEvent)
 ```
 
 ---
 
 > 💡 UiPath LlamaIndex sdk also supports **Robot/Agent-in-the-loop** scenarios. In this context, the execution of one agent
 > can be suspended until another robot or agent finishes its execution.
 
-### 3. InvokeProcess
+### 3. InvokeProcessEvent
 
-The `InvokeProcess` model is utilized to invoke a process within the UiPath cloud platform.
+The `InvokeProcessEvent` model is utilized to invoke a process within the UiPath cloud platform.
 This process can be of various types, including API workflows, Agents or RPA automation.
 Upon completion of the invoked process, the current agent will automatically resume execution.
 
@@ -70,20 +71,21 @@ Upon completion of the invoked process, the current agent will automatically res
 
 ```python
 from uipath_llamaindex.models import InvokeProcessEvent
-process_output = ctx.write_event_to_stream(InvokeProcessEvent(name="MyProcess", process_folder_path="MyFolderPath", input_arguments={"arg1": "value1"}))
+ctx.write_event_to_stream(InvokeProcessEvent(name="MyProcess", process_folder_path="MyFolderPath", input_arguments={"arg1": "value1"}))
+job_data = await ctx.wait_for_event(HumanResponseEvent)
 ```
 
 /// 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.
+For a practical implementation of the `InvokeProcessEvent` 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.
 
 ---
 
 ### 4. WaitJob
 
-The `WaitJob` model is used to wait for a job completion. Unlike `InvokeProcess`, which automatically creates a job, this model is intended for scenarios where
+The `WaitJobEvent` model is used to wait for a job completion. Unlike `InvokeProcessEvent`, which automatically creates a job, this model is intended for scenarios where
 the job has already been created.
 
 #### Attributes:
@@ -95,5 +97,6 @@ the job has already been created.
 
 ```python
 from uipath_llamaindex.models import WaitJobEvent
-job_output = ctx.write_event_to_stream(WaitJobEvent(job=my_job_instance, process_folder_path="MyFolderPath"))
+ctx.write_event_to_stream(WaitJobEvent(job=my_job_instance, process_folder_path="MyFolderPath"))
+job_data = await ctx.wait_for_event(HumanResponseEvent)
 ```