https://github.com/aliencube/open-chat-playground
This provides a web UI for AI chat playground that is able to connect virtually any LLM from any platform.
https://github.com/aliencube/open-chat-playground
Last synced: 7 months ago
JSON representation
This provides a web UI for AI chat playground that is able to connect virtually any LLM from any platform.
- Host: GitHub
- URL: https://github.com/aliencube/open-chat-playground
- Owner: aliencube
- License: mit
- Created: 2025-03-28T10:54:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-28T11:19:24.000Z (about 1 year ago)
- Last Synced: 2025-03-28T12:23:01.197Z (about 1 year ago)
- Language: C#
- Homepage:
- Size: 441 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Open Chat Playground
Open Chat Playground (OCP) is a web UI that is able to connect virtually any LLM from any platform.
## Supported platforms
- [ ] [Amazon Bedrock](https://docs.aws.amazon.com/bedrock)
- [ ] [Azure AI Foundry](https://learn.microsoft.com/azure/ai-foundry/what-is-azure-ai-foundry)
- [x] [GitHub Models](https://docs.github.com/github-models/about-github-models)
- [ ] [Google Vertex AI](https://cloud.google.com/vertex-ai/docs)
- [ ] [Docker Model Runner](https://docs.docker.com/ai/model-runner)
- [ ] [Foundry Local](https://learn.microsoft.com/azure/ai-foundry/foundry-local/what-is-foundry-local)
- [x] [Hugging Face](https://huggingface.co/docs)
- [ ] [Ollama](https://github.com/ollama/ollama/tree/main/docs)
- [ ] [Anthropic](https://docs.anthropic.com)
- [ ] [Naver](https://api.ncloud-docs.com/docs/ai-naver-clovastudio-summary)
- [ ] [LG](https://github.com/LG-AI-EXAONE)
- [x] [OpenAI](https://openai.com/api)
- [ ] [Upstage](https://console.upstage.ai/docs/getting-started)
## Prerequisites
- [Azure Subscription](https://azure.microsoft.com/free)
- [.NET SDK 9](https://dotnet.microsoft.com/download/dotnet/9.0)
- [Visual Studio Code](https://code.visualstudio.com/) + [C# DevKit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) or [Visual Studio 2022 v17.14+](https://visualstudio.com/vs)
- [Docker Desktop](https://docs.docker.com/desktop/)
- [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd)
- [GitHub CLI](https://cli.github.com/)
- [PowerShell 7.5+](https://learn.microsoft.com/powershell/scripting/install/installing-powershell) 👉 Windows only
## Getting started
### Get the repository ready
1. Login to GitHub.
```bash
gh auth login
```
1. Check login status.
```bash
gh auth status
```
1. 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
```
1. Navigate to the cloned repository.
```bash
cd open-chat-playground
```
### Run on local machine
- [Use GitHub Models](./docs/github-models.md#run-on-local-machine)
- [Use Hugging Face](./docs/hugging-face.md#run-on-local-machine)
- [Use OpenAI](./docs/openai.md#run-on-local-machine)
### Run in local container
- [Use GitHub Models](./docs/github-models.md#run-in-local-container)
- [Use Hugging Face](./docs/hugging-face.md#run-in-local-container)
- [Use OpenAI](./docs/openai.md#run-in-local-container)
### Run on Azure
- [Use GitHub Models](./docs/github-models.md#run-on-azure)
- [Use Hugging Face](./docs/hugging-face.md#run-on-azure)
- [Use OpenAI](./docs/openai.md#run-on-azure)
### Run as API
1. Run the app - either locally or remotely.
1. 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.
1. 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?"
}
]
```
1. 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
1. Make sure you are at the repository root.
```bash
cd $REPOSITORY_ROOT
```
1. Build the app.
```bash
dotnet restore && dotnet build
```
#### Unit tests
1. Make sure you are at the repository root.
```bash
cd $REPOSITORY_ROOT
```
1. Run tests.
```bash
dotnet test --filter "Category=UnitTest"
```
#### Integration tests
1. Make sure you are at the repository root.
```bash
cd $REPOSITORY_ROOT
```
1. Install playwright.
```bash
pwsh $REPOSITORY_ROOT/test/OpenChat.PlaygroundApp.Tests/bin/Debug/net{YOUR_VERSION}/playwright.ps1 install
```
1. Run the app.
```bash
dotnet run --project $REPOSITORY_ROOT/src/OpenChat.PlaygroundApp
```
1. 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
1. Make sure you are at the repository root.
```bash
cd $REPOSITORY_ROOT
```
1. Make sure you've logged in to Azure.
```bash
azd auth login --check-status
```
1. Run pipeline config.
```bash
azd pipeline config
```
1. 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`
1. Once the configuration is done, push a new commit to GitHub to run the GitHub Actions workflow.