Skip to content

Commit a6550c3

Browse files
authored
Merge pull request #356 from UiPath/docs/llamaindex-list-models
docs: point llamaindex model lists to uipath list-models
2 parents d56b2c5 + 06bd01b commit a6550c3

1 file changed

Lines changed: 37 additions & 19 deletions

File tree

packages/uipath-llamaindex/docs/llms_and_embeddings.md

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,47 @@
11
# LLMs and Embeddings
22

3-
UiPath provides pre-configured LLM and embedding classes that handle authentication, routing, and configuration automatically, allowing you to focus on building your agents.
4-
You do not need to add API keys from OpenAI, AWS, or Google, usage of these models will consume `Agent Units` on your account.
3+
UiPath provides pre-configured LLM and embedding classes for several providers (OpenAI via `UiPathOpenAI`, Anthropic on AWS Bedrock via `UiPathChatBedrockConverse`, Google Vertex AI via `UiPathVertex`, and more), plus embeddings via `UiPathOpenAIEmbedding`. These handle authentication, routing, and configuration automatically, allowing you to focus on building your agents. You do not need to add API keys from OpenAI, AWS, or Google, usage of these models will consume `Agent Units` on your account.
4+
5+
## Available models
6+
7+
LLM models are served through the UiPath LLM Gateway and are subject to [AI Trust Layer](https://docs.uipath.com/automation-cloud/automation-cloud/latest/admin-guide/about-ai-trust-layer) policies, so the exact set of models available to you depends on your tenant configuration. List the models you can use with the `uipath` CLI:
8+
9+
```console
10+
$ uipath list-models
11+
Available LLM Models
12+
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
13+
┃ AwsBedrock ┃ OpenAi ┃ VertexAi ┃
14+
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
15+
│ anthropic.claude-haiku-4-5-20251001-v1:0 │ gpt-4.1-2025-04-14 │ gemini-2.5-flash │
16+
│ anthropic.claude-opus-4-7 │ gpt-4.1-mini-2025-04-14 │ gemini-2.5-pro │
17+
│ ... │ ... │ ... │
18+
└──────────────────────────────────────────┴─────────────────────────┴──────────────────┘
19+
```
20+
21+
Pick a model id from the relevant provider column and pass it (or the matching enum member) to the matching class:
22+
23+
```python
24+
from uipath_llamaindex.llms import UiPathOpenAI
25+
from uipath_llamaindex.llms.bedrock import UiPathChatBedrockConverse
26+
from uipath_llamaindex.llms.vertex import UiPathVertex
27+
28+
# OpenAI models
29+
llm = UiPathOpenAI(model="gpt-4.1-mini-2025-04-14")
30+
31+
# AWS Bedrock (Anthropic) models
32+
llm = UiPathChatBedrockConverse(model="anthropic.claude-sonnet-4-5-20250929-v1:0")
33+
34+
# Google Vertex AI (Gemini) models
35+
llm = UiPathVertex(model="gemini-2.5-flash")
36+
```
537

638
## UiPathOpenAI
739

840
The `UiPathOpenAI` class is a pre-configured Azure OpenAI client that routes requests through UiPath.
941

1042
### Available Models
1143

12-
The following OpenAI models are available through the `OpenAIModel` enum:
13-
14-
- `GPT_4_1_2025_04_14`
15-
- `GPT_4_1_MINI_2025_04_14`
16-
- `GPT_4_1_NANO_2025_04_14`
17-
- `GPT_4O_2024_05_13`
18-
- `GPT_4O_2024_08_06`
19-
- `GPT_4O_2024_11_20`
20-
- `GPT_4O_MINI_2024_07_18` (default)
21-
- `O3_MINI_2025_01_31`
22-
- `TEXT_DAVINCI_003`
44+
The OpenAI models from the `OpenAi` column of [`uipath list-models`](#available-models) can be used here, either as a model string or via the `OpenAIModel` enum.
2345

2446
### Basic Usage
2547

@@ -143,9 +165,7 @@ from uipath_llamaindex.llms import BedrockModel
143165
llm = UiPathChatBedrock(model=BedrockModel.anthropic_claude_sonnet_4)
144166
```
145167

146-
Currently, the following models can be used (this list can be updated in the future):
147-
148-
- `anthropic.claude-3-7-sonnet-20250219-v1:0`, `anthropic.claude-sonnet-4-20250514-v1:0`, `anthropic.claude-sonnet-4-5-20250929-v1:0`, `anthropic.claude-haiku-4-5-20251001-v1:0`
168+
The available models are the ones in the `AwsBedrock` column of [`uipath list-models`](#available-models).
149169

150170
## UiPathVertex
151171

@@ -184,9 +204,7 @@ response = llm.chat(messages)
184204
print(response)
185205
```
186206

187-
Currently, the following models can be used (this list can be updated in the future):
188-
189-
- `gemini-2.0-flash-001`, `gemini-2.5-flash`, `gemini-2.5-pro`
207+
The available models are the ones in the `VertexAi` column of [`uipath list-models`](#available-models).
190208

191209
## Integration with LlamaIndex
192210

0 commit comments

Comments
 (0)