You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A collection of Python SDKs that enable developers to build and deploy AI agents to the UiPath Cloud Platform using different agent frameworks. These packages provide programmatic interaction with UiPath Cloud Platform services and human-in-the-loop (HITL) semantics through Action Center integration.
4
+
5
+
All packages are extensions to the [UiPath Python SDK](https://github.com/UiPath/uipath-python) and implement the [UiPath Runtime Protocol](https://github.com/UiPath/uipath-runtime-python).
A Python SDK that enables developers to build and deploy LlamaIndex agents to the UiPath Cloud Platform. It provides programmatic interaction with UiPath Cloud Platform services and human-in-the-loop (HITL) semantics through Action Center integration.
14
+
Build agents using the [LlamaIndex](https://www.llamaindex.ai/) framework with support for RAG, multiple LLM providers, and state persistence.
8
15
9
-
This package is an extension to the [UiPath Python SDK](https://github.com/UiPath/uipath-python) and implements the [UiPath Runtime Protocol](https://github.com/UiPath/uipath-runtime-python).
Check out these [sample projects](https://github.com/UiPath/uipath-integrations-python/tree/main/packages/uipath-llamaindex/samples) to see the SDK in action.
12
21
@@ -15,111 +24,75 @@ Check out these [sample projects](https://github.com/UiPath/uipath-integrations-
15
24
- Python 3.11 or higher
16
25
- UiPath Automation Cloud account
17
26
18
-
## Installation
27
+
## Quick Start
19
28
20
-
```bash
21
-
pip install uipath-llamaindex
22
-
```
29
+
Choose the agent framework that best fits your needs and follow the installation instructions for that package:
23
30
24
-
using `uv`:
31
+
-**LlamaIndex**: For RAG applications and stateful workflows → See [LlamaIndex documentation](packages/uipath-llamaindex/)
32
+
-**OpenAI Agents**: For multi-agent systems → See [OpenAI Agents documentation](packages/uipath-openai-agents/)
The SDK provides a command-line interface for creating, packaging, and deploying LlamaIndex Agents:
44
-
45
-
### Initialize a Project
46
-
47
-
```bash
48
-
uipath init
49
-
```
50
-
51
-
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.
52
-
53
-
For more details on the configuration format, see the [UiPath configuration specifications](https://github.com/UiPath/uipath-python/blob/main/specs/README.md).
54
-
55
-
### Authentication
56
-
57
-
```bash
58
-
uipath auth
59
-
```
60
-
61
-
This command opens a browser for authentication and creates/updates your `.env` file with the proper credentials.
62
-
63
-
### Debug a Project
64
-
65
-
```bash
66
-
uipath run WORKFLOW [INPUT]
67
-
```
54
+
## Development
68
55
69
-
Executes the agent with the provided JSON input arguments.
56
+
### Setting Up a Development Environment
70
57
71
-
### Package a Project
58
+
This repository uses [UV](https://docs.astral.sh/uv/) for workspace management:
72
59
73
60
```bash
74
-
uipath pack
75
-
```
76
-
77
-
Packages your project into a `.nupkg` file that can be deployed to UiPath.
78
-
79
-
**Note:** Your `pyproject.toml` must include:
61
+
# Install UV
62
+
curl -LsSf https://astral.sh/uv/install.sh | sh
80
63
81
-
- A description field (avoid characters: &, <, >, ", ', ;)
Publishes the most recently created package to your UiPath Orchestrator.
98
-
99
-
## Project Structure
100
-
101
-
To properly use the CLI for packaging and publishing, your project should include:
102
-
103
-
- A `pyproject.toml` file with project metadata
104
-
- A `llama_index.json` file with your workflow definitions (e.g., `"workflows": {"agent": "main.py:agent"}`)
105
-
- A `entry-points.json` file (generated by `uipath init`)
106
-
- A `bindings.json` file (generated by `uipath init`) to configure resource overrides
107
-
- Any Python files needed for your automation
108
-
109
-
## Development
110
-
111
79
### Developer Tools
112
80
113
81
Check out [uipath-dev](https://github.com/uipath/uipath-dev-python) - an interactive terminal application for building, testing, and debugging UiPath Python runtimes, agents, and automation scripts.
114
82
115
-
### Setting Up a Development Environment
83
+
### Contributing
116
84
117
85
Please read our [contribution guidelines](https://github.com/UiPath/uipath-integrations-python/packages/uipath-llamaindex/blob/main/CONTRIBUTING.md) before submitting a pull request.
118
86
119
-
###Special Thanks
87
+
## Special Thanks
120
88
121
89
A huge thank-you to the open-source community and the maintainers of the libraries that make this project possible:
122
90
123
-
-[LlamaIndex](https://github.com/run-llama/llama_index) for providing a powerful framework for building stateful LLM applications.
124
-
-[OpenInference](https://github.com/Arize-ai/openinference) for observability and instrumentation support.
125
-
-[Pydantic](https://github.com/pydantic/pydantic) for reliable, typed configuration and validation.
91
+
-[LlamaIndex](https://github.com/run-llama/llama_index) for providing a powerful framework for building stateful LLM applications
92
+
-[OpenAI](https://github.com/openai) for the Agents framework and APIs
93
+
-[OpenInference](https://github.com/Arize-ai/openinference) for observability and instrumentation support
94
+
-[Pydantic](https://github.com/pydantic/pydantic) for reliable, typed configuration and validation
0 commit comments