Skip to content

Commit b0ff44f

Browse files
committed
docs: add readme for multi-agent sample
1 parent 1ee55eb commit b0ff44f

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

samples/multi-agent/README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Company Research Agent
2+
3+
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.
4+
5+
## Features
6+
1. Triggers a UiPath process to research the company name.
7+
2. Human-in-the-loop feedback for approval.
8+
3. Produces the final, validated company report.
9+
10+
## Getting Started
11+
12+
### 1. Clone the Repository
13+
14+
```sh
15+
git clone https://github.com/your-org/uipath-llamaindex-python.git
16+
cd uipath-llamaindex-python/samples/multi-agent
17+
```
18+
19+
### 2. Set Up Python Environment
20+
21+
```sh
22+
python -m venv .venv
23+
source .venv/bin/activate # On Windows: .venv\Scripts\activate
24+
pip install -r requirements.txt
25+
```
26+
27+
Or use `pyproject.toml` with pip:
28+
```sh
29+
pip install .
30+
```
31+
32+
### 3. Configure Environment
33+
34+
Copy `.env.template` to `.env` and fill in your secrets (API keys, tokens, etc.)
35+
36+
### 4. Run the Agent
37+
38+
```sh
39+
uipath run agent --file ./input.json
40+
```
41+
### 5. Resume
42+
43+
To approve the rules and commit them use:
44+
```sh
45+
uipath run agent true --resume
46+
```
47+
48+
Example:
49+
```sh
50+
uipath run agent --file ./input.json
51+
```
52+
53+
### Deployment Guide
54+
55+
To run the company-researcher-agent on the UiPath Cloud Platform, follow this guide:
56+
[Ticket Classification Sample Deployment](https://github.com/UiPath/uipath-langchain-python/tree/main/samples/ticket-classification)

0 commit comments

Comments
 (0)