Skip to content

Latest commit

 

History

History
206 lines (145 loc) · 6.38 KB

README.md

File metadata and controls

206 lines (145 loc) · 6.38 KB
Raw

GPT on your data Frontend

Part of GPT-RAG

Deploy (quickstart)

Pre-reqs

1) Clone the Repository

git clone https://github.com/Azure/gpt-rag-frontend.git

If you plan to customize the application code, create a new repo by clicking on the Use this template button on top of this page.

If you created a new repository please update the repository URL before running the git clone command

2) Build App

Everytime you change frontend code you need to build it before a new deployment, including in the first time:

cd frontend
npm install
npm run build

3) Deploy to Azure

Execute the following commands in the terminal to deploy your function:

2.1. Enter backend folder

cd ..
cd backend

2.2. Remove backend_env if you have tested it locally

bash:

rm -rf backend_env

or

Powershell:

Remove-Item -Recurse -Force backend_env

2.3. Zip source code

Linux or Mac:

zip -r ../deploy.zip *

Windows:

tar -a -c -f ../deploy.zip *

2.4. Deploy it with az webapp deploy:

cd ..
az webapp deploy --subscription [SUBSCRIPTION_ID] --resource-group [RESOURCE_GROUP_NAME] --name [WEB_APP_NAME] --src-path deploy.zip --type zip --async true

(Optional) Test locally

Before running the application locally, make sure that the necessary Azure resources (like Blob Storage, AI services, and the Orchestrator) are already deployed in the cloud. Don’t worry—this can easily be done using azd provision, as outlined in the setup guide for the GPT-RAG repository.

  1. Rename .env.template to .env and update the environment variables with your details.

  2. Log in to your Azure account by running azd auth login or az login.

  3. Start the application by running ./start.sh (or ./startwin.sh if you’re on Windows).

Permissions for your user to run the frontend app locally

Assign the necessary permissions to the user who will run the frontend application locally. Below are the specific roles and the corresponding commands.

Replace the variables (those starting with the $ symbol) with the corresponding values from your deployment, keeping in mind that principalId is the identifier of your user in Entra ID.

  • Storage Account
    Assign the "Storage Blob Data Reader" role to the user for accessing blob storage.

    az role assignment create \
    --assignee $principalId \
    --role "Storage Blob Data Reader" \
    --scope "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.Storage/storageAccounts/$storageAccountName"

  • Key Vault
    Assign the "Key Vault Secrets User" role to the user to access secrets.

    az role assignment create \
    --assignee $principalId \
    --role "Key Vault Secrets User" \
    --scope "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.KeyVault/vaults/$keyVaultName"

  • Azure AI Services
    Assign the "Cognitive Services Contributor" role to the user for using AI services.

    az role assignment create \
    --assignee $principalId \
    --role "Cognitive Services Contributor" \
    --scope "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.CognitiveServices/accounts/$aiServicesAccountName"

  • Application Insights
    Assign the "Application Insights Component Contributor" role to the user for monitoring.

    az role assignment create \
    --assignee $principalId \
    --role 'Application Insights Component Contributor' \
    --scope "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/microsoft.insights/components/$appInsightsName"

Frontend customizations

Optionally you can customize some items in the frontend.

1) Title

Update page's title

file: frontend/src/pages/layout/Layout.tsx

<h4 className={styles.headerRightText}>Chat On Your Data/h4>

file: frontend/src/pages/layout/index.html

<title>Chat Chat On Your Data | Demo</title>

2) Logo

Update frontend logo

file: frontend/src/pages/layout/Layout.tsx

Example:

<Link to="/" className={styles.headerTitleContainer}>
    <img height="80px" src="https://www.yourdomain.com/yourlogo.png"></img>
    <h3 className={styles.headerTitle}></h3>
</Link>

3) Citations

You can remove citations from the answers if you do not want them. Just set showSources to {false}

file: frontend/src/pages/chat/Chat.tsx

<Answer
    key={index}
    answer={answer[1]}
    isSelected={selectedAnswer === index && activeAnalysisPanelTab !== undefined}
    onCitationClicked={c => onShowCitation(c, index)}
    onThoughtProcessClicked={() => onToggleTab(AnalysisPanelTabs.ThoughtProcessTab, index)}
    onSupportingContentClicked={() => onToggleTab(AnalysisPanelTabs.SupportingContentTab, index)}
    onFollowupQuestionClicked={q => makeApiRequestGpt(q)}
    showFollowupQuestions={false}
    showSources={false}                                            
/>

4) Speech Synthesis

To enable speech synthesis change speechSynthesisEnabled variable to true.

file: frontend/src/pages/chat/Chat.tsx

const speechSynthesisEnabled = true;

Contributing

We appreciate your interest in contributing to this project! Please refer to the CONTRIBUTING.md page for detailed guidelines on how to contribute, including information about the Contributor License Agreement (CLA), code of conduct, and the process for submitting pull requests.

Thank you for your support and contributions!

Trademarks

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.