Skip to content

Commit c1905b8

Browse files
authored
Update README.md
1 parent 0da6084 commit c1905b8

1 file changed

Lines changed: 40 additions & 49 deletions

File tree

samples/quickstart-llamacloud/README.md

Lines changed: 40 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quickstart LlamaCloud Agent
22

3-
This project demonstrates how to integrate UiPath with LlamaIndex and LlamaCloud for document search and travel assistance workflows using a FunctionAgent.
3+
This project demonstrates how to integrate UiPath with LlamaIndex and LlamaCloud for document search and travel assistance workflows using a `FunctionAgent`.
44

55
## Overview
66

@@ -33,9 +33,6 @@ The Quickstart LlamaCloud Agent provides a FunctionAgent that can:
3333
We recommend using `uv` for package management:
3434

3535
```bash
36-
# Initialize a new uv project
37-
uv init .
38-
3936
# Create and activate virtual environment
4037
uv venv
4138
source .venv/bin/activate # On Windows: .venv\Scripts\activate
@@ -65,13 +62,51 @@ Required environment variables:
6562
- `LLAMACLOUD_INDEX_1_NAME`: First index name (e.g., "company-policy")
6663
- `LLAMACLOUD_INDEX_2_NAME`: Second index name (e.g., "personal-preferences")
6764

68-
### 4. Configure LlamaCloud Indexes
65+
## 4. Authenticate With UiPath
66+
67+
```shell
68+
> uipath auth
69+
⠋ Authenticating with UiPath ...
70+
🔗 If a browser window did not open, please open the following URL in your browser: [LINK]
71+
👇 Select tenant:
72+
0: Tenant1
73+
1: Tenant2
74+
Select tenant number: 0
75+
Selected tenant: Tenant1
76+
✓ Authentication successful.
77+
```
78+
79+
### 5. Configure LlamaCloud Indexes
6980

7081
- Set up your indexes in LlamaCloud with the names specified in your `.env` file
7182
- You can drag and drop the files in `/sample_data` into the relevant indexes
7283
- Update the project name and organization ID in your `.env` file
7384
- Ensure your API key has access to the specified indexes
7485

86+
### 6. Run Locally
87+
88+
```bash
89+
# Run the agent with a query
90+
uipath run agent '{"user_msg": "What are the travel rates for New York?"}'
91+
```
92+
93+
### 7. Run as a UiPath Deployment
94+
95+
1. **Package your project:**
96+
```bash
97+
uipath pack
98+
```
99+
100+
2. **Publish to UiPath Cloud:**
101+
```bash
102+
uipath publish --my-workspace
103+
```
104+
105+
3. **Invoke the agent:**
106+
```bash
107+
uipath invoke agent '{"user_msg": "What are the travel rates for New York?"}'
108+
```
109+
75110
## Available Functions
76111

77112
The agent has access to three main functions:
@@ -91,50 +126,6 @@ Generates comprehensive travel recommendations combining both company policies a
91126
- **Use case**: "Give me travel recommendations for a business trip"
92127
- **Returns**: Combined analysis from both indexes
93128

94-
## Usage
95-
96-
### Local Testing
97-
98-
99-
#### Using UiPath CLI (Recommended)
100-
101-
```bash
102-
# Run the agent with a query
103-
uipath run agent '{"user_msg": "What are the travel rates for New York?"}'
104-
```
105-
106-
#### Option 3: Using Input File
107-
108-
Create an `input.json` file:
109-
110-
```json
111-
{
112-
"user_msg": "What are the travel rates for California?"
113-
}
114-
```
115-
116-
117-
### UiPath Deployment
118-
119-
1. **Authenticate with UiPath:**
120-
```bash
121-
uipath auth
122-
```
123-
124-
2. **Package your project:**
125-
```bash
126-
uipath pack
127-
```
128-
129-
3. **Publish to UiPath Cloud:**
130-
```bash
131-
uipath publish --my-workspace
132-
```
133-
134-
4. **Invoke the agent:**
135-
```bash
136-
uipath invoke agent '{"user_msg": "What are the travel rates for New York?"}'
137-
```
138129

139130

140131
## Example Queries

0 commit comments

Comments
 (0)