Fully azdevify the application

.devcontainer/postCreate.sh

@@ -2,7 +2,7 @@
 
 pip install --upgrade pip
 
-pip install -r code/requirements.txt -r code/app/requirements.txt -r extensions/backend/requirements.txt
+pip install -r code/requirements.txt -r extensions/backend/requirements.txt
 
 pip install -r code/dev-requirements.txt
 

.env.sample

@@ -49,4 +49,9 @@ ORCHESTRATION_STRATEGY=openai_functions
 #Speech-to-text feature
 AZURE_SPEECH_SERVICE_KEY=
 AZURE_SPEECH_SERVICE_REGION=
-AZURE_AUTH_TYPE=rbac
+# Auth type environment variables.
+# When AZURE_AUTH_TYPE=rbac, please make sure variable USE_KEY_VAULT=false
+# When USE_KEY_VAULT=true, please make sure to set AZURE_KEY_VAULT_ENDPOINT
+AZURE_AUTH_TYPE=keys
+USE_KEY_VAULT=true
+AZURE_KEY_VAULT_ENDPOINT=

.github/workflows/unittests.yml

@@ -20,6 +20,6 @@ jobs:
             architecture: x64
         - name: Install dependencies
           run: |
-            pip install -r code/requirements.txt -r code/dev-requirements.txt -r code/app/requirements.txt
+            pip install -r code/requirements.txt -r code/dev-requirements.txt -r code/backend/requirements.txt
         - name: Run Python tests
           run: python -m pytest --rootdir=code -m "not azure"

.gitignore

@@ -4,7 +4,7 @@
 ## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
 
 # generated frontend files
-code/app/static/
+code/static/
 
 # User-specific files
 *.rsuser

.vscode/launch.json

@@ -17,7 +17,7 @@
                 "run",
                 "Admin.py"
             ],
-            "cwd": "${workspaceFolder}/code/admin",
+            "cwd": "${workspaceFolder}/code/backend",
             "preLaunchTask": "pip install (code)",
         },
         {
@@ -31,14 +31,14 @@
                 "--debug",
                 "run"
             ],
-            "cwd": "${workspaceFolder}/code/app",
+            "cwd": "${workspaceFolder}/code",
             "preLaunchTask": "pip install (code)"
         },
         {
             "name": "Launch Frontend (UI)",
             "type": "node",
             "request": "launch",
-            "cwd": "${workspaceFolder}/code/app/frontend",
+            "cwd": "${workspaceFolder}/code/frontend",
             "preLaunchTask": "npm install (code)",
             "runtimeExecutable": "npm",
             "runtimeArgs": [

.vscode/tasks.json

@@ -9,7 +9,7 @@
 			"isBackground": true,
 			"dependsOn": "pip install (functions)",
 			"options": {
-				"cwd": "${workspaceFolder}/backend"
+				"cwd": "${workspaceFolder}/code/backend/batch"
 			}
 		},
 		{
@@ -26,7 +26,7 @@
 			},
 			"problemMatcher": [],
 			"options": {
-				"cwd": "${workspaceFolder}/backend"
+				"cwd": "${workspaceFolder}/code/backend"
 			}
 		},
 		{
@@ -44,7 +44,7 @@
 			"command": "npm install",
 			"problemMatcher": [],
 			"options": {
-				"cwd": "${workspaceFolder}/code/app/frontend"
+				"cwd": "${workspaceFolder}/code/frontend"
 			}
 		}
 	]

Makefile

@@ -24,4 +24,8 @@ unittest: ## 🧪 Run the unit tests
 
 build-frontend: ## 🏗️ Build the Frontend webapp
 	@echo -e "\e[34m$@\e[0m" || true
-	@cd code/app/frontend && npm install && npm run build
+	@cd code/frontend && npm install && npm run build
+
+azd-login: ## 🔑 Login to Azure with azd and a SPN
+	@echo -e "\e[34m$@\e[0m" || true
+	@azd auth login --client-id ${AZURE_CLIENT_ID} --client-secret ${AZURE_CLIENT_SECRET} --tenant-id ${AZURE_TENANT_ID}

README.md

@@ -194,6 +194,46 @@ az deployment group create --resource-group $RESOURCE_GROUP_NAME --template-file
 
 
     ![A screenshot of the chat app.](./media/web-unstructureddata.png)
+### Running the sample using the Azure Developer CLI (azd)
+
+The Azure Developer CLI (`azd`) is a developer-centric command-line interface (CLI) tool for creating Azure applications.
+
+You need to install it before running and deploying with the Azure Developer CLI. (If you use the devcontainer, everything is already installed)
+
+### Windows
+
+```powershell
+powershell -ex AllSigned -c "Invoke-RestMethod 'https://aka.ms/install-azd.ps1' | Invoke-Expression"
+```
+
+### Linux/MacOS
+
+```
+curl -fsSL https://aka.ms/install-azd.sh | bash
+```
+
+After logging in with the following command, you will be able to use the `azd` cli to quickly provision and deploy the application.
+
+```
+azd auth login
+```
+
+Then, execute the `azd init` command to initialize the environment (You do not need to run this command if you already have the code or have opened this in a Codespace or DevContainer).
+```
+azd init -t chat-with-your-data-solution-accelerator
+```
+Enter an environment name.
+
+**Notes:** the default auth type uses keys, if you want to switch to rbac, please run `azd env set AUTH_TYPE rbac`.
+
+Then, run `azd up` to provision all the resources to Azure and deploy the code to those resources.
+```
+azd up 
+```
+
+Select your desired `subscription` and `location`. Wait a moment for the resource deployment to complete, click the website endpoint and you will see the web app page.
+
+You can also run the sample directly locally (See below).
 
 ### [Local deployment instructions](./docs/LOCAL_DEPLOYMENT.md)
 To customize the accelerator or run it locally, first, copy the .env.sample file to your development environment's .env file, and edit it according to environment variable values table. Learn more about deploying locally [here](./docs/LOCAL_DEPLOYMENT.md).

azure.yaml

@@ -0,0 +1,33 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-dev/main/schemas/v1.0/azure.yaml.json
+
+name: chat-with-your-data-solution-accelerator
+metadata:
+  template: chat-with-your-data-solution-accelerator@0.0.1-beta
+
+services:
+  web:
+    project: ./code
+    language: py
+    host: appservice
+    hooks:
+      prepackage:
+        windows:
+          shell: pwsh
+          run:  cd ./frontend;npm install;npm run build;
+          interactive: true
+          continueOnError: false
+        posix:
+          shell: sh
+          run:  cd ./frontend;npm install;npm run build;
+          interactive: true
+          continueOnError: false
+
+  adminweb:
+    project: ./code/backend
+    language: py
+    host: appservice
+
+  function:
+    project: ./code/backend/batch
+    language: py
+    host: function

code/app/app.py → code/app.py

@@ -2,11 +2,13 @@
 import os
 import logging
 import requests
-import openai
+from openai import AzureOpenAI
 import mimetypes
 from flask import Flask, Response, request, jsonify
 from dotenv import load_dotenv
+from azure.identity import DefaultAzureCredential, get_bearer_token_provider
 import sys
+from backend.batch.utilities.helpers.EnvHelper import EnvHelper
 
 # Fixing MIME types for static files under Windows
 mimetypes.add_type("application/javascript", ".js")
@@ -27,22 +29,27 @@ def static_file(path):
     return app.send_static_file(path)
 
 
+env_helper: EnvHelper = EnvHelper()
+AZURE_AUTH_TYPE = env_helper.AZURE_AUTH_TYPE
+AZURE_SEARCH_KEY = env_helper.AZURE_SEARCH_KEY
+AZURE_OPENAI_KEY = env_helper.AZURE_OPENAI_KEY
+AZURE_SPEECH_KEY = env_helper.AZURE_SPEECH_KEY
+
+
 @app.route("/api/config", methods=["GET"])
 def get_config():
     # Retrieve the environment variables or other configuration data
-    azure_speech_key = os.getenv("AZURE_SPEECH_SERVICE_KEY")
     azure_speech_region = os.getenv("AZURE_SPEECH_SERVICE_REGION")
 
     # Return the configuration data as JSON
     return jsonify(
-        {"azureSpeechKey": azure_speech_key, "azureSpeechRegion": azure_speech_region}
+        {"azureSpeechKey": AZURE_SPEECH_KEY, "azureSpeechRegion": azure_speech_region}
     )
 
 
 # ACS Integration Settings
 AZURE_SEARCH_SERVICE = os.environ.get("AZURE_SEARCH_SERVICE")
 AZURE_SEARCH_INDEX = os.environ.get("AZURE_SEARCH_INDEX")
-AZURE_SEARCH_KEY = os.environ.get("AZURE_SEARCH_KEY")
 AZURE_SEARCH_USE_SEMANTIC_SEARCH = os.environ.get(
     "AZURE_SEARCH_USE_SEMANTIC_SEARCH", "False"
 )
@@ -59,7 +66,6 @@ def get_config():
 # AOAI Integration Settings
 AZURE_OPENAI_RESOURCE = os.environ.get("AZURE_OPENAI_RESOURCE")
 AZURE_OPENAI_MODEL = os.environ.get("AZURE_OPENAI_MODEL")
-AZURE_OPENAI_KEY = os.environ.get("AZURE_OPENAI_KEY")
 AZURE_OPENAI_TEMPERATURE = os.environ.get("AZURE_OPENAI_TEMPERATURE", 0)
 AZURE_OPENAI_TOP_P = os.environ.get("AZURE_OPENAI_TOP_P", 1.0)
 AZURE_OPENAI_MAX_TOKENS = os.environ.get("AZURE_OPENAI_MAX_TOKENS", 1000)
@@ -75,7 +81,9 @@ def get_config():
 AZURE_OPENAI_MODEL_NAME = os.environ.get(
     "AZURE_OPENAI_MODEL_NAME", "gpt-35-turbo"
 )  # Name of the model, e.g. 'gpt-35-turbo' or 'gpt-4'
-AZURE_AUTH_TYPE = os.environ.get("AZURE_AUTH_TYPE", "keys")
+AZURE_TOKEN_PROVIDER = get_bearer_token_provider(
+    DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"
+)
 
 SHOULD_STREAM = True if AZURE_OPENAI_STREAM.lower() == "true" else False
 
@@ -100,9 +108,11 @@ def prepare_body_headers_with_data(request):
         "temperature": AZURE_OPENAI_TEMPERATURE,
         "max_tokens": AZURE_OPENAI_MAX_TOKENS,
         "top_p": AZURE_OPENAI_TOP_P,
-        "stop": AZURE_OPENAI_STOP_SEQUENCE.split("|")
-        if AZURE_OPENAI_STOP_SEQUENCE
-        else None,
+        "stop": (
+            AZURE_OPENAI_STOP_SEQUENCE.split("|")
+            if AZURE_OPENAI_STOP_SEQUENCE
+            else None
+        ),
         "stream": SHOULD_STREAM,
         "dataSources": [
             {
@@ -112,30 +122,42 @@ def prepare_body_headers_with_data(request):
                     "key": AZURE_SEARCH_KEY,
                     "indexName": AZURE_SEARCH_INDEX,
                     "fieldsMapping": {
-                        "contentField": AZURE_SEARCH_CONTENT_COLUMNS.split("|")
-                        if AZURE_SEARCH_CONTENT_COLUMNS
-                        else [],
-                        "titleField": AZURE_SEARCH_TITLE_COLUMN
-                        if AZURE_SEARCH_TITLE_COLUMN
-                        else None,
-                        "urlField": AZURE_SEARCH_URL_COLUMN
-                        if AZURE_SEARCH_URL_COLUMN
-                        else None,
-                        "filepathField": AZURE_SEARCH_FILENAME_COLUMN
-                        if AZURE_SEARCH_FILENAME_COLUMN
-                        else None,
+                        "contentField": (
+                            AZURE_SEARCH_CONTENT_COLUMNS.split("|")
+                            if AZURE_SEARCH_CONTENT_COLUMNS
+                            else []
+                        ),
+                        "titleField": (
+                            AZURE_SEARCH_TITLE_COLUMN
+                            if AZURE_SEARCH_TITLE_COLUMN
+                            else None
+                        ),
+                        "urlField": (
+                            AZURE_SEARCH_URL_COLUMN if AZURE_SEARCH_URL_COLUMN else None
+                        ),
+                        "filepathField": (
+                            AZURE_SEARCH_FILENAME_COLUMN
+                            if AZURE_SEARCH_FILENAME_COLUMN
+                            else None
+                        ),
                     },
-                    "inScope": True
-                    if AZURE_SEARCH_ENABLE_IN_DOMAIN.lower() == "true"
-                    else False,
+                    "inScope": (
+                        True
+                        if AZURE_SEARCH_ENABLE_IN_DOMAIN.lower() == "true"
+                        else False
+                    ),
                     "topNDocuments": AZURE_SEARCH_TOP_K,
-                    "queryType": "semantic"
-                    if AZURE_SEARCH_USE_SEMANTIC_SEARCH.lower() == "true"
-                    else "simple",
-                    "semanticConfiguration": AZURE_SEARCH_SEMANTIC_SEARCH_CONFIG
-                    if AZURE_SEARCH_USE_SEMANTIC_SEARCH.lower() == "true"
-                    and AZURE_SEARCH_SEMANTIC_SEARCH_CONFIG
-                    else "",
+                    "queryType": (
+                        "semantic"
+                        if AZURE_SEARCH_USE_SEMANTIC_SEARCH.lower() == "true"
+                        else "simple"
+                    ),
+                    "semanticConfiguration": (
+                        AZURE_SEARCH_SEMANTIC_SEARCH_CONFIG
+                        if AZURE_SEARCH_USE_SEMANTIC_SEARCH.lower() == "true"
+                        and AZURE_SEARCH_SEMANTIC_SEARCH_CONFIG
+                        else ""
+                    ),
                     "roleInformation": AZURE_OPENAI_SYSTEM_MESSAGE,
                 },
             }
@@ -241,26 +263,38 @@ def stream_without_data(response):
 
 
 def conversation_without_data(request):
-    openai.api_type = "azure"
-    openai.api_base = f"https://{AZURE_OPENAI_RESOURCE}.openai.azure.com/"
-    openai.api_version = "2023-03-15-preview"
-    openai.api_key = AZURE_OPENAI_KEY
+    azure_endpoint = f"https://{AZURE_OPENAI_RESOURCE}.openai.azure.com/"
+    if AZURE_AUTH_TYPE == "rbac":
+        openai_client = AzureOpenAI(
+            azure_endpoint=azure_endpoint,
+            api_version=AZURE_OPENAI_API_VERSION,
+            azure_ad_token_provider=AZURE_TOKEN_PROVIDER,
+        )
+    else:
+        openai_client = AzureOpenAI(
+            azure_endpoint=azure_endpoint,
+            api_version=AZURE_OPENAI_API_VERSION,
+            api_key=AZURE_OPENAI_KEY,
+        )
 
     request_messages = request.json["messages"]
     messages = [{"role": "system", "content": AZURE_OPENAI_SYSTEM_MESSAGE}]
 
     for message in request_messages:
         messages.append({"role": message["role"], "content": message["content"]})
 
-    response = openai.ChatCompletion.create(
-        engine=AZURE_OPENAI_MODEL,
+    # Azure Open AI takes the deployment name as the model name, "AZURE_OPENAI_MODEL" means deployment name.
+    response = openai_client.chat.completions.create(
+        model=AZURE_OPENAI_MODEL,
         messages=messages,
         temperature=float(AZURE_OPENAI_TEMPERATURE),
         max_tokens=int(AZURE_OPENAI_MAX_TOKENS),
         top_p=float(AZURE_OPENAI_TOP_P),
-        stop=AZURE_OPENAI_STOP_SEQUENCE.split("|")
-        if AZURE_OPENAI_STOP_SEQUENCE
-        else None,
+        stop=(
+            AZURE_OPENAI_STOP_SEQUENCE.split("|")
+            if AZURE_OPENAI_STOP_SEQUENCE
+            else None
+        ),
         stream=SHOULD_STREAM,
     )
 
@@ -314,13 +348,13 @@ def conversation_azure_byod():
 
 
 def get_message_orchestrator():
-    from utilities.helpers.OrchestratorHelper import Orchestrator
+    from backend.batch.utilities.helpers.OrchestratorHelper import Orchestrator
 
     return Orchestrator()
 
 
 def get_orchestrator_config():
-    from utilities.helpers.ConfigHelper import ConfigHelper
+    from backend.batch.utilities.helpers.ConfigHelper import ConfigHelper
 
     return ConfigHelper.get_active_config_or_default().orchestrator