-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2248135
commit 3b3a9eb
Showing
1 changed file
with
0 additions
and
160 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,16 +15,6 @@ Note: some portions of the app use preview APIs. | |
|
|
||
| ## Deploy the app | ||
|
|
||
| ### Deploy with Azure Developer CLI | ||
| Please see [README_azd.md](./README_azd.md) for detailed instructions. | ||
|
|
||
| ### One click Azure deployment | ||
| [](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2Fsample-app-aoai-chatGPT%2Fmain%2Finfrastructure%2Fdeployment.json) | ||
|
|
||
| Click on the Deploy to Azure button and configure your settings in the Azure Portal as described in the [Environment variables](#environment-variables) section. | ||
|
|
||
| Please see the [section below](#add-an-identity-provider) for important information about adding authentication to your app. | ||
|
|
||
| ### Deploy from your local machine | ||
|
|
||
| #### Local Setup: Basic Chat Experience | ||
|
|
@@ -97,125 +87,6 @@ To enable message feedback, you will need to set up CosmosDB resources. Then spe | |
| /.env | ||
| - `AZURE_COSMOSDB_ENABLE_FEEDBACK=True` | ||
|
|
||
| #### Local Setup: Enable SQL Server | ||
| To enable SQL Server, you will need to set up SQL Server resources. Then specify these additional environment variables: | ||
| - `DATASOURCE_TYPE` (Should be set to `AzureSqlServer`) | ||
| - `AZURE_SQL_SERVER_CONNECTION_STRING` | ||
| - `AZURE_SQL_SERVER_TABLE_SCHEMA` | ||
|
|
||
| #### Deploy with the Azure CLI | ||
| **NOTE**: If you've made code changes, be sure to **build the app code** with `start.cmd` or `start.sh` before you deploy, otherwise your changes will not be picked up. If you've updated any files in the `frontend` folder, make sure you see updates to the files in the `static` folder before you deploy. | ||
|
|
||
| You can use the [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-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](https://learn.microsoft.com/en-us/cli/azure/webapp?view=azure-cli-latest#az-webapp-up). Run the following two commands 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. | ||
|
|
||
| 1. `az webapp up --runtime PYTHON:3.11 --sku B1 --name <new-app-name> --resource-group <resource-group-name> --location <azure-region> --subscription <subscription-name>` | ||
| 1. `az webapp config set --startup-file "python3 -m gunicorn app:app" --name <new-app-name>` | ||
|
|
||
| If you've deployed the app previously, 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` | ||
|
|
||
| Check the runtime stack for your app by viewing the app service resource in the Azure Portal. If it shows "Python - 3.10", use `PYTHON:3.10` in the runtime argument below. If it shows "Python - 3.11", use `PYTHON:3.11` in the runtime argument below. | ||
|
|
||
| Check the SKU in the same way. Use the abbreviated SKU name in the argument below, e.g. for "Basic (B1)" the SKU is `B1`. | ||
|
|
||
| Then, use these commands to deploy your local code to the existing app: | ||
|
|
||
| 1. `az webapp up --runtime <runtime-stack> --sku <sku> --name <existing-app-name> --resource-group <resource-group-name>` | ||
| 1. `az webapp config set --startup-file "python3 -m gunicorn app:app" --name <existing-app-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. | ||
|
|
||
| ### Add an identity provider | ||
| After deployment, you will need to add an identity provider to provide authentication support in your app. See [this tutorial](https://learn.microsoft.com/en-us/azure/app-service/scenario-secure-app-authentication-app-service) 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, you can add `AUTH_ENABLED=False` to the environment variables. This will disable authentication and allow anyone to access the chat functionality of your app. **This is not recommended for production apps.** | ||
|
|
||
| To add further access controls, update the logic in `getUserInfoList` in `frontend/src/pages/chat/Chat.tsx`. | ||
|
|
||
| ### Common Customization Scenarios (e.g. updating the default chat logo and headers) | ||
|
|
||
| The interface allows for easy adaptation of the UI by modifying certain elements, such as the title and logo, through the use of [environment variables](#environment-variables). | ||
|
|
||
| - `UI_TITLE` | ||
| - `UI_LOGO` | ||
| - `UI_CHAT_TITLE` | ||
| - `UI_CHAT_LOGO` | ||
| - `UI_CHAT_DESCRIPTION` | ||
| - `UI_FAVICON` | ||
| - `UI_SHOW_SHARE_BUTTON` | ||
| - `UI_SHOW_CHAT_HISTORY_BUTTON` | ||
|
|
||
| Feel free to fork this repository and make your own modifications to the UX or backend logic. You can modify the source (`frontend/src`). For example, you may want to change aspects of the chat display, or expose some of the settings in `app.py` in the UI for users to try out different behaviors. After your code changes, you will need to rebuild the front-end via `start.sh` or `start.cmd`. | ||
|
|
||
| ### Scalability | ||
| You can configure the number of threads and workers in `gunicorn.conf.py`. After making a change, redeploy your app using the commands listed above. | ||
|
|
||
| See the [Oryx documentation](https://github.com/microsoft/Oryx/blob/main/doc/configuration.md) for more details on these settings. | ||
|
|
||
| ### Debugging your deployed app | ||
| First, add an environment variable on the app service resource called "DEBUG". Set this to "true". | ||
|
|
||
| Next, enable logging on the app service. Go to "App Service logs" under Monitoring, and change Application logging to File System. Save the change. | ||
|
|
||
| Now, you should be able to see logs from your app by viewing "Log stream" under Monitoring. | ||
|
|
||
| ### Configuring vector search | ||
| When using your own data with a vector index, ensure these settings are configured on your app: | ||
| - `AZURE_SEARCH_QUERY_TYPE`: can be `vector`, `vectorSimpleHybrid`, or `vectorSemanticHybrid`, | ||
| - `AZURE_OPENAI_EMBEDDING_NAME`: the name of your Ada (text-embedding-ada-002) model deployment on your Azure OpenAI resource. | ||
| - `AZURE_SEARCH_VECTOR_COLUMNS`: the vector columns in your index to use when searching. Join them with `|` like `contentVector|titleVector`. | ||
|
|
||
| ### Changing Citation Display | ||
| The Citation panel is defined at the end of `frontend/src/pages/chat/Chat.tsx`. The citations returned from Azure OpenAI On Your Data will include `content`, `title`, `filepath`, and in some cases `url`. You can customize the Citation section to use and display these as you like. For example, the title element is a clickable hyperlink if `url` is not a blob URL. | ||
|
|
||
| ``` | ||
| <h5 | ||
| className={styles.citationPanelTitle} | ||
| tabIndex={0} | ||
| title={activeCitation.url && !activeCitation.url.includes("blob.core") ? activeCitation.url : activeCitation.title ?? ""} | ||
| onClick={() => onViewSource(activeCitation)} | ||
| >{activeCitation.title}</h5> | ||
| const onViewSource = (citation: Citation) => { | ||
| if (citation.url && !citation.url.includes("blob.core")) { | ||
| window.open(citation.url, "_blank"); | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| ### Using Entra ID | ||
|
|
||
| The app uses Azure OpenAI on your data [(see documentation)](https://learn.microsoft.com/en-us/azure/ai-services/openai/references/on-your-data). To enable Entra ID for intra-service authentication | ||
|
|
||
| 1. Enable managed identity on Azure OpenAI | ||
| 2. Configure AI search to allow access from Azure OpenAI | ||
| 1. Enable Role Based Access control on the used AI search instance [(see documentation)](https://learn.microsoft.com/en-us/azure/search/search-security-enable-roles) | ||
| 2. Assign `Search Index Data Reader` and `Search Service Contributor` to the identity of the Azure OpenAI instance | ||
| 3. Do not configure `AZURE_SEARCH_KEY` and `AZURE_OPENAI_KEY` to use Entra ID authentication. | ||
| 4. Configure the webapp identity | ||
| 1. Enable managed identity in the app service that hosts the webapp | ||
| 2. Go to the Azure OpenAI instance and assign the role `Cognitive Services OpenAI User` to the identity of the webapp | ||
|
|
||
| Note: RBAC assignments can take a few minutes before becoming effective. | ||
|
|
||
| ### Best Practices | ||
| 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. | ||
| - Pull in changes from `main` frequently to ensure you have the latest bug fixes and improvements, especially when using Azure OpenAI on your data. | ||
|
|
||
| **A note on Azure OpenAI API versions**: The application code in this repo will implement the request and response contracts for the most recent preview API version supported for Azure OpenAI. To keep your application up-to-date as the Azure OpenAI API evolves with time, be sure to merge the latest API version update into your own application code and redeploy using the methods described in this document. | ||
|
|
||
| ## Environment variables | ||
|
|
||
| Note: settings starting with `AZURE_SEARCH` are only needed when using Azure OpenAI on your data with Azure AI Search. If not connecting to your data, you only need to specify `AZURE_OPENAI` settings. | ||
|
|
@@ -268,37 +139,6 @@ Note: settings starting with `AZURE_SEARCH` are only needed when using Azure Ope | |
| |PROMPTFLOW_CITATIONS_FIELD_NAME|documents|Default field name to process the citations output from Promptflow request.| | ||
| |DATASOURCE_TYPE||Type of data source to use for using the 'on-your-data' api. Can be `AzureCognitiveSearch`, `AzureCosmosDB`, `Elasticsearch`, `Pinecone`, `AzureMLIndex`, `AzureSqlServer` or `None` | | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| 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](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
| contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| When contributing to this repository, please help keep the codebase clean and maintainable by running | ||
| the formatter and linter with `npm run format` this will run `npx eslint --fix` and `npx prettier --write` | ||
| on the frontebnd codebase. | ||
|
|
||
| If you are using VSCode, you can add the following settings to your `settings.json` to format and lint on save: | ||
|
|
||
| ```json | ||
| { | ||
| "editor.codeActionsOnSave": { | ||
| "source.fixAll.eslint": "explicit" | ||
| }, | ||
| "editor.formatOnSave": true, | ||
| "prettier.requireConfig": true, | ||
| } | ||
| ``` | ||
|
|
||
| ## Trademarks | ||
|
|
||
| This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft | ||
|
|
||