microsoft/chat-copilot

microsoft/chat-copilot

Language: TypeScript

License: MIT

Stars: 2436

Forks: 777

Open issues: 58

Created: 2023-07-17T16:12:33Z

Pushed: 2026-06-20T15:33:06Z

Default branch: main

Fork: no

Archived: no

README: NOTE: This is a sample application to help you understand how Semantic Kernel and AI can work in Web Applications. This sample is NOT FOR PRODUCTION deployments.

Chat Copilot Sample Application

This sample allows you to build your own integrated large language model (LLM) chat copilot. The sample is built on Microsoft Semantic Kernel and has three components:

1. A frontend application [React web app](./webapp/) 2. A backend REST API [.NET web API service](./webapi/) 3. A [.NET worker service](./memorypipeline/) for processing semantic memory.

These quick-start instructions run the sample locally. They can also be found on the official Chat Copilot Microsoft Learn documentation page for getting started.

To deploy the sample to Azure, please view [Deploying Chat Copilot](./scripts/deploy/README.md) after meeting the [requirements](#requirements) described below.

> IMPORTANT: This sample is for educational purposes only and is not recommended for production deployments.

> IMPORTANT: Each chat interaction will call Azure OpenAI/OpenAI which will use tokens that you may be billed for.

!Chat Copilot answering a question

Requirements

You will need the following items to run the sample:

• .NET 8.0 SDK _(via Setup install.\* script)_
• Node.js _(via Setup install.\* script)_
• Yarn _(via Setup install.\* script)_
• Git
• AI Service (one of the following is required)

| AI Service | Requirement | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Azure OpenAI | - Access

• Resource
• Deployed models (gpt-4o and text-embedding-ada-002)
• Endpoint
• API key |

| OpenAI | - Account

• API key |

Instructions

Windows

1. Open PowerShell as an administrator. > NOTE: Ensure that you have PowerShell Core 6+ installed. This is different from the default PowerShell installed on Windows. 1. Clone this repository

git clone https://github.com/microsoft/chat-copilot

1. Setup your environment.

The following is a script to help you install the dependencies required. Feel free to install dotnet, nodejs, and yarn with your method of choice or use this script.

cd \scripts\
.\Install.ps1

> NOTE: This script will install Chocolatey, dotnet-8.0-sdk, nodejs, and yarn.

> NOTE: If you receive an error that the script is not digitally signed or cannot execute on the system, you may need to change the execution policy (see list of policies and scopes) or unblock the script.

1. Configure Chat Copilot.

.\Configure.ps1 -AIService {AI_SERVICE} -APIKey {API_KEY} -Endpoint {AZURE_OPENAI_ENDPOINT}

• AI_SERVICE: AzureOpenAI or OpenAI.
• API_KEY: The API key for Azure OpenAI or for OpenAI.
• AZURE_OPENAI_ENDPOINT: The Azure OpenAI resource Endpoint address. This is only required when using Azure OpenAI, omit -Endpoint if using OpenAI.

• > IMPORTANT: For AzureOpenAI, if you deployed models gpt-4o and text-embedding-ada-002 with custom names (instead of the default names), also use the parameters:

-CompletionModel {DEPLOYMENT_NAME} -EmbeddingModel {DEPLOYMENT_NAME}

Open the .\Configure.ps1 script to see all of the available parameters.

1. Run Chat Copilot locally. This step starts both the backend API and frontend application.

.\Start.ps1

It may take a few minutes for Yarn packages to install on the first run.

> NOTE: Confirm pop-ups are not blocked and you are logged in with the same account used to register the application.

• (Optional) To start ONLY the backend:

.\Start-Backend.ps1

Linux/macOS

1. Open Bash as an Administrator. 1. Clone this repository

git clone https://github.com/microsoft/chat-copilot

1. Configure environment.

The following is a script to help you install the dependencies required. Feel free to install dotnet, nodejs, and yarn with your method of choice or use this script.

cd /scripts/

Ubuntu/Debian Linux

./install-apt.sh

> NOTE:...