<img src="./assets/icon-transparent.svg" alt="Icon for OpenChat Playground" width="32" /> Open Chat Playground

Open Chat Playground (OCP) is a web UI that is able to connect virtually any LLM from any platform.

OpenChat Playground - hero image

Supported platforms

Prerequisites

Azure Subscription
.NET SDK 9
Visual Studio Code + C# DevKit or Visual Studio 2022 v17.14+
Docker Desktop
Azure Developer CLI
GitHub CLI
PowerShell 7.5+ 👉 Windows only

Getting started

Get the repository ready

Login to GitHub.
```
bash
gh auth login
```
Check login status.
```
bash
gh auth status
```
Fork this repository to your account and clone the forked repository to your local machine.
```
bash
gh repo fork aliencube/open-chat-playground --clone --default-branch-only
```
Navigate to the cloned repository.
```
bash
cd open-chat-playground
```

Run on local machine

Run in local container

Run on Azure

Use Amazon Bedrock
Use Azure AI Foundry
Use GitHub Models
Use Google Vertex AI
~~Use Docker Model Runner~~ 👉 NOT SUPPORTED
~~Use Foundry Local~~ 👉 NOT SUPPORTED
Use Hugging Face
Use Ollama
Use Anthropic
Use LG
~~Use Naver~~ 👉 NOT SUPPORTED
Use OpenAI
Use Upstage

Run as API

Run the app - either locally or remotely.
Navigate to {{APP_URL}}/openapi.json to see the OpenAPI doc. NOTE: the OpenAPI doc is only able to see on a local machine, not on a remote instance.

Send a POST request to {{APP_URL}}/api/chat/responses with a request payload like:

json
[
  {
    "role": "system",
    "message": "You're a friendly assistant"
  },
  {
    "role": "user",
    "message": "Why is the sky blue?"
  }
]

Confirm the response payload like:

jsonc
[
  {
    "role": "assistant",
    "message": "Because "
  },
  {
    "role": "assistant",
    "message": "It's "
  },
  {
    "role": "assistant",
    "message": "... "
  },
  ...
  {
    "role": "assistant",
    "message": "... "
  }
]

Run tests

Build app

Make sure you are at the repository root.
```
bash
cd $REPOSITORY_ROOT
```
Build the app.
```
bash
dotnet restore && dotnet build
```

Unit tests

Make sure you are at the repository root.
```
bash
cd $REPOSITORY_ROOT
```

Run tests.

bash
dotnet test --filter "Category=UnitTest"

Integration tests

Make sure you have the Ollama server up and running on your local machine.
```
bash
ollama serve
ollama run hf.co/Qwen/Qwen3-0.6B-GGUF
```
Make sure you are at the repository root.
```
bash
cd $REPOSITORY_ROOT
```

Install playwright.

bash
pwsh $REPOSITORY_ROOT/test/OpenChat.PlaygroundApp.Tests/bin/Debug/net{YOUR_VERSION}/playwright.ps1 install

Run the app.

bash
dotnet run --project $REPOSITORY_ROOT/src/OpenChat.PlaygroundApp -- --connector-type HuggingFace

Run tests.

bash
# With LLM provider
dotnet test --filter "Category=IntegrationTest"

bash
# Without LLM provider
dotnet test --filter "Category=IntegrationTest & Category!=LLMRequired"

Configure GitHub Actions for CI/CD Pipeline

Make sure you are at the repository root.
```
bash
cd $REPOSITORY_ROOT
```
Make sure you've logged in to Azure.
```
bash
azd auth login --check-status
```
Run pipeline config.
```
bash
azd pipeline config
```
Answer the question below:
- ? Select how to authenticate the pipeline to Azure 👉 Federated Service Principal (SP + OIDC)
- ? Would you like to commit and push your local changes to start the configured CI pipeline? 👉 No
Once the configuration is done, push a new commit to GitHub to run the GitHub Actions workflow.