Skip to content

Commit 783d7de

Browse files
committed
docs: update hitl method parameters
1 parent c0b4de7 commit 783d7de

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/human_in_the_loop.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ For more information on UiPath apps, refer to the [UiPath Apps User Guide](https
1313

1414
#### Attributes:
1515

16-
- **name** (Optional[str]): The name of the app.
17-
- **key** (Optional[str]): The key of the app.
16+
- **app_name** (Optional[str]): The name of the app.
17+
- **app_folder_path** (Optional[str]): The folder path of the app.
18+
- **app_key** (Optional[str]): The key of the app.
1819
- **title** (str): The title of the action to create.
1920
- **data** (Optional[Dict[str, Any]]): Values that the action will be populated with.
2021
- **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
2425

2526
```python
2627
from uipath_llamaindex.models import CreateActionEvent
27-
action_output = ctx.write_event_to_stream(CreateActionEvent(name="AppName", title="Escalate Issue", data={"key": "value"}, app_version=1, assignee="[email protected]"))
28+
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="[email protected]"))
2829
```
2930

3031
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
3940
#### Attributes:
4041

4142
- **action** (Action): The instance of the action to wait for.
43+
- **app_folder_path** (Optional[str]): The folder path of the app.
4244

4345
#### Example:
4446

4547
```python
4648
from uipath_llamaindex.models import WaitActionEvent
47-
action_output = ctx.write_event_to_stream(WaitActionEvent(action=my_action_instance))
49+
action_output = ctx.write_event_to_stream(WaitActionEvent(action=my_action_instance, app_folder_path="MyFolderPath"))
4850
```
4951

5052
---
@@ -61,13 +63,14 @@ Upon completion of the invoked process, the current agent will automatically res
6163
#### Attributes:
6264

6365
- **name** (str): The name of the process to invoke.
66+
- **process_folder_path** (Optional[str]): The folder path of the process.
6467
- **input_arguments** (Optional[Dict[str, Any]]): A dictionary containing the input arguments required for the invoked process.
6568

6669
#### Example:
6770

6871
```python
6972
from uipath_llamaindex.models import InvokeProcessEvent
70-
process_output = ctx.write_event_to_stream(InvokeProcessEvent(name="MyProcess", input_arguments={"arg1": "value1"}))
73+
process_output = ctx.write_event_to_stream(InvokeProcessEvent(name="MyProcess", process_folder_path="MyFolderPath", input_arguments={"arg1": "value1"}))
7174
```
7275

7376
/// warning
@@ -86,10 +89,11 @@ the job has already been created.
8689
#### Attributes:
8790

8891
- **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.
92+
- **process_folder_path** (Optional[str]): The folder path of the process.
8993

9094
#### Example:
9195

9296
```python
9397
from uipath_llamaindex.models import WaitJobEvent
94-
job_output = ctx.write_event_to_stream(WaitJobEvent(job=my_job_instance))
98+
job_output = ctx.write_event_to_stream(WaitJobEvent(job=my_job_instance, process_folder_path="MyFolderPath"))
9599
```

0 commit comments

Comments
 (0)