This repo contains sample code for a simple chat webapp that integrates with Azure OpenAI. Note: some portions of the app use preview APIs.
Update the environment variables listed in app.py. At minimum, you need to specify AZURE_OPENAI_RESOURCE, AZURE_OPENAI_MODEL, and AZURE_OPENAI_KEY.
Start the app with start.cmd.
This will build the frontend, install backend dependencies, and then start the app.
You can see the local running app at http://127.0.0.1:5000.
Note: this app is under construction!
Please see the section below for important information about adding authentication to your app.
Click on the Deploy to Azure button and configure your settings in the Azure Portal as described in the Environment variables section.
Please be aware that you need:
- an existing Azure OpenAI resource with models deployment
- OPTIONALLY - an existing Azure Cognitive Search
You can use the Azure CLI to deploy the app from your local machine. Make sure you have version 2.48.1 or later.
If this is your first time deploying the app, you can use az webapp up. Run the following command from the root folder of the repo, updating the placeholder values to your desired app name, resource group, location, and subscription. You can also change the SKU if desired.
az webapp up --runtime PYTHON:3.10 --sku B1 --name <new-app-name> --resource-group <resource-group-name> --location <azure-region> --subscription <subscription-name>
If you've deployed the app previously from the AOAI studio, first run this command to update the appsettings to allow local code deployment:
az webapp config appsettings set -g <resource-group-name> -n <existing-app-name> --settings WEBSITE_WEBDEPLOY_USE_SCM=false
Then, use the az webapp up command to deploy your local code to the existing app:
az webapp up --runtime PYTHON:3.10 --sku B1 --name <existing-app-name> --resource-group <resource-group-name>
Make sure that the app name and resource group match exactly for the app that was previously deployed.
Deployment will take several minutes. When it completes, you should be able to navigate to your app at {app-name}.azurewebsites.net.
After deployment, you will need to add an identity provider to provide authentication support in your app. See this tutorial for more information.
If you don't add an identity provider, the chat functionality of your app will be blocked to prevent unauthorized access to your resources and data. To remove this restriction, or add further access controls, update the logic in getUserInfoList in frontend/src/pages/chat/Chat.tsx.
Feel free to fork this repository and make your own modifications to the UX or backend logic. For example, you may want to expose some of the settings in app.py in the UI for users to try out different behaviors. We recommend keeping these best practices in mind:
- Reset the chat session (clear chat) if the user changes any settings. Notify the user that their chat history will be lost.
- Clearly communicate to the user what impact each setting will have on their experience.
- When you rotate API keys for your AOAI or ACS resource, be sure to update the app settings for each of your deployed apps to use the new key.
| App Setting | Value | Note |
|---|---|---|
| AZURE_SEARCH_SERVICE | ||
| AZURE_SEARCH_INDEX | ||
| AZURE_SEARCH_KEYv | ||
| AZURE_SEARCH_USE_SEMANTIC_SEARCH | False | |
| AZURE_SEARCH_SEMANTIC_SEARCH_CONFIG | ||
| AZURE_SEARCH_INDEX_IS_PRECHUNKED | False | |
| AZURE_SEARCH_TOP_K | 5 | |
| AZURE_SEARCH_ENABLE_IN_DOMAIN | False | |
| AZURE_SEARCH_CONTENT_COLUMNS | ||
| AZURE_SEARCH_FILENAME_COLUMN | ||
| AZURE_SEARCH_TITLE_COLUMN | ||
| AZURE_SEARCH_URL_COLUMN | ||
| AZURE_OPENAI_RESOURCE | ||
| AZURE_OPENAI_MODEL | The name of your model deployment | |
| AZURE_OPENAI_MODEL_NAME | gpt-35-turbo | The name of the model |
| AZURE_OPENAI_KEY | ||
| AZURE_OPENAI_TEMPERATURE | 0 | |
| AZURE_OPENAI_TOP_P | 1.0 | |
| AZURE_OPENAI_MAX_TOKENS | 1000 | |
| AZURE_OPENAI_STOP_SEQUENCE | ||
| AZURE_OPENAI_SYSTEM_MESSAGE | You are an AI assistant that helps people find information. | |
| AZURE_OPENAI_PREVIEW_API_VERSION | 2023-06-01-preview | |
| AZURE_OPENAI_STREAM | True |
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.