Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 116 additions & 9 deletions docs/chat_models.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Chat Models

UiPath provides two chat models `UiPathAzureChatOpenAI` and `UiPathChat`. These are compatible with LangGraph as drop in replacements. You do not need to add tokens from OpenAI or Anthropic, usage of these chat models will consume `Agent Units` on your account.
UiPath provides chat models that are compatible with LangGraph as drop-in replacements for LLM clients. You do not need to add tokens from OpenAI, Vertex AI or Anthropic, usage of these chat models will consume `Agent Units` on your account.

## UiPathAzureChatOpenAI
## UiPathChatOpenAI and UiPathAzureChatOpenAI

`UiPathAzureChatOpenAI` can be used as a drop in replacement for `ChatOpenAI` or `AzureChatOpenAI`.
`UiPathChatOpenAI` and `UiPathAzureChatOpenAI` are both compatible as drop-in replacements for `ChatOpenAI` and `AzureChatOpenAI` from `langchain_openai`.

> **Note:** `UiPathAzureChatOpenAI` will be deprecated in the future. We recommend using `UiPathChatOpenAI` for all new implementations.

### Example usage

Here is a code that is using `ChatOpenAI`
Here is code using `ChatOpenAI` from `langchain_openai`:

```python
from langchain_openai import ChatOpenAI
Expand All @@ -26,12 +28,12 @@ llm = ChatOpenAI(
)
```

You can simply change `ChatOpenAi` with `UiPathAzureChatOpenAI`, you don't have to provide an OpenAI token.
You can simply change `ChatOpenAI` with `UiPathChatOpenAI`, you don't have to provide an OpenAI API key.

```python
from uipath_langchain.chat.models import UiPathAzureChatOpenAI
from uipath_langchain.chat import UiPathChatOpenAI

llm = UiPathAzureChatOpenAI(
llm = UiPathChatOpenAI(
model="gpt-4o-2024-08-06",
temperature=0,
max_tokens=4000,
Expand All @@ -41,9 +43,114 @@ llm = UiPathAzureChatOpenAI(
)
```

Currently, the following models can be used with `UiPathAzureChatOpenAI` (this list can be updated in the future):
Currently, the following models can be used with `UiPathChatOpenAI` (this list can be updated in the future):

- `gpt-4o-2024-05-13`, `gpt-4o-2024-08-06`, `gpt-4o-2024-11-20`, `gpt-4o-mini-2024-07-18`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `gpt-5-2025-08-07`, `gpt-5-chat-2025-08-07`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-5.1-2025-11-13`, `gpt-5.2-2025-12-11`

## UiPathChatBedrock and UiPathChatBedrockConverse

`UiPathChatBedrock` and `UiPathChatBedrockConverse` can be used as drop in replacements for `ChatBedrock` and `ChatBedrockConverse` from `langchain_aws`.

### Installation

These classes require additional dependencies. Install them with:

```bash
pip install uipath-langchain[bedrock]
# or using uv:
uv add 'uipath-langchain[bedrock]'
```

### Example usage

Here is code using `ChatBedrockConverse` from `langchain_aws`:

```python
from langchain_aws import ChatBedrockConverse

llm = ChatBedrockConverse(
model="anthropic.claude-3-5-sonnet-20240620-v1:0",
temperature=0,
max_tokens=1024,
)
```

You can replace it with `UiPathChatBedrockConverse` without needing AWS credentials:

```python
from uipath_langchain.chat import UiPathChatBedrockConverse

llm = UiPathChatBedrockConverse(
model_name="anthropic.claude-haiku-4-5-20251001-v1:0",
temperature=0,
max_tokens=1024,
# other params...
)
```

Similarly, `ChatBedrock` can be replaced with `UiPathChatBedrock`:

```python
from uipath_langchain.chat import UiPathChatBedrock

llm = UiPathChatBedrock(
model_name="anthropic.claude-haiku-4-5-20251001-v1:0",
temperature=0,
max_tokens=1024,
# other params...
)
```

Currently, the following models can be used (this list can be updated in the future):

- `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`

## UiPathChatVertex

`UiPathChatVertex` can be used as a drop in replacement for `ChatGoogleGenerativeAI` from `langchain_google_genai`.

### Installation

This class requires additional dependencies. Install them with:

```bash
pip install uipath-langchain[vertex]
# or using uv:
uv add 'uipath-langchain[vertex]'
```

### Example usage

Here is code using `ChatGoogleGenerativeAI` from `langchain_google_genai`:

```python
from langchain_google_genai import ChatGoogleGenerativeAI

llm = ChatGoogleGenerativeAI(
model="gemini-2.0-flash-001",
temperature=0,
max_tokens=1024,
# api_key="...",
# other params...
)
```

You can replace it with `UiPathChatVertex` without needing a Google API key:

```python
from uipath_langchain.chat import UiPathChatVertex

llm = UiPathChatVertex(
model_name="gemini-2.5-flash",
temperature=0,
max_tokens=1024,
# other params...
)
```

Currently, the following models can be used (this list can be updated in the future):

- `gpt-4`, `gpt-4-1106-Preview`, `gpt-4-32k`, `gpt-4-turbo-2024-04-09`, `gpt-4-vision-preview`, `gpt-4o-2024-05-13`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `o3-mini-2025-01-31`
- `gemini-2.0-flash-001`, `gemini-2.5-flash`, `gemini-2.5-pro`, `gemini-3-pro-preview`

## UiPathChat

Expand Down