Skip to content

Commit 21f5f9d

Browse files
committed
fix: update main repo readme
1 parent 34cc429 commit 21f5f9d

1 file changed

Lines changed: 22 additions & 69 deletions

File tree

README.md

Lines changed: 22 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,51 @@
1-
# UiPath AI Agent Runtimes for Python
1+
# UiPath Agents Runtime Integrations
22

3-
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.
3+
A collection of Python SDKs that enable developers to build and deploy 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.
44

55
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).
66

7-
## Available Packages
7+
## Integrations
88

9-
### UiPath LlamaIndex
9+
### LlamaIndex
1010

1111
[![PyPI - Version](https://img.shields.io/pypi/v/uipath-llamaindex)](https://pypi.org/project/uipath-llamaindex/)
1212
[![PyPI downloads](https://img.shields.io/pypi/dm/uipath-llamaindex.svg)](https://pypi.org/project/uipath-llamaindex/)
1313

14-
Build agents using the [LlamaIndex](https://www.llamaindex.ai/) framework with support for RAG, multiple LLM providers, and state persistence.
14+
Build agents using the [LlamaIndex SDK](https://www.llamaindex.ai/):
1515

16-
- **Installation**: `pip install uipath-llamaindex`
17-
- **Documentation**: [packages/uipath-llamaindex/](packages/uipath-llamaindex/)
18-
- **Samples**: [packages/uipath-llamaindex/samples/](packages/uipath-llamaindex/samples/)
16+
- [Docs](https://uipath.github.io/uipath-python/llamaindex/quick_start/)
17+
- [Samples](packages/uipath-llamaindex/samples/)
1918

20-
Check out these [sample projects](https://github.com/UiPath/uipath-integrations-python/tree/main/packages/uipath-llamaindex/samples) to see the SDK in action.
19+
### OpenAI Agents
2120

22-
## Requirements
21+
[![PyPI - Version](https://img.shields.io/pypi/v/uipath-openai-agents)](https://pypi.org/project/uipath-openai-agents/)
22+
[![PyPI downloads](https://img.shields.io/pypi/dm/uipath-openai-agents.svg)](https://pypi.org/project/uipath-openai-agents/)
2323

24-
- Python 3.11 or higher
25-
- UiPath Automation Cloud account
24+
Build agents using the [OpenAI Agents SDK](https://github.com/openai/openai-agents-python):
2625

27-
## Quick Start
26+
- [Docs](https://uipath.github.io/uipath-python/openai-agents/quick_start/)
27+
- [Samples](packages/uipath-openai-agents/samples/)
2828

29-
Choose the agent framework that best fits your needs and follow the installation instructions for that package:
3029

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/)
30+
## Structure
3331

34-
## Documentation
35-
36-
- [Quick Start Guide](docs/quick_start.md)
37-
- [LlamaIndex Package Documentation](packages/uipath-llamaindex/)
38-
- [OpenAI Agents Package Documentation](packages/uipath-openai-agents/)
39-
- [Sample Projects](packages/uipath-llamaindex/samples/)
40-
41-
## Monorepo Structure
42-
43-
This repository is organized as a UV workspace with multiple packages:
32+
This repository is organized as a monorepo with multiple packages:
4433

4534
```
46-
uipath-llamaindex-python/
47-
├── packages/
48-
│ ├── uipath-llamaindex/ # LlamaIndex runtime
49-
│ └── uipath-openai-agents/ # OpenAI Agents runtime
50-
├── docs/ # Shared documentation
51-
└── pyproject.toml # Workspace configuration
35+
uipath-integrations-python/
36+
└── packages/
37+
├── uipath-llamaindex/ # LlamaIndex runtime
38+
└── uipath-openai-agents/ # OpenAI Agents runtime
5239
```
5340

5441
## Development
5542

56-
### Setting Up a Development Environment
57-
58-
This repository uses [UV](https://docs.astral.sh/uv/) for workspace management:
59-
60-
```bash
61-
# Install UV
62-
curl -LsSf https://astral.sh/uv/install.sh | sh
63-
64-
# Clone the repository
65-
git clone https://github.com/UiPath/uipath-llamaindex-python.git
66-
cd uipath-llamaindex-python
67-
68-
# Install all dependencies
69-
uv sync --all-extras
70-
71-
# Run tests for all packages
72-
uv run pytest
73-
74-
# Build a specific package
75-
uv build --package uipath-llamaindex
76-
uv build --package uipath-openai-agents
77-
```
78-
79-
### Developer Tools
43+
### Tools
8044

8145
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.
8246

83-
### Contributing
84-
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.
86-
87-
## Special Thanks
88-
89-
A huge thank-you to the open-source community and the maintainers of the libraries that make this project possible:
47+
### Contributions
9048

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
49+
Please read our [contribution guidelines](https://github.com/UiPath/uipath-integrations-python/blob/main/CONTRIBUTING.md) before submitting a pull request.
9550

96-
## License
9751

98-
See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)