feat!: implement chat endpoint switch

.devcontainer/postCreate.sh

@@ -6,6 +6,9 @@ pip install poetry
 
 # https://pypi.org/project/poetry-plugin-export/
 pip install poetry-plugin-export
+
+poetry env use python3.11
+
 poetry config warnings.export false
 
 poetry install --with dev

.env.sample

@@ -57,3 +57,5 @@ AZURE_SPEECH_SERVICE_REGION=
 AZURE_AUTH_TYPE=keys
 USE_KEY_VAULT=true
 AZURE_KEY_VAULT_ENDPOINT=
+# Chat conversation type to decide between custom or byod (bring your own data) conversation type
+CONVERSATION_FLOW=

README.md

@@ -71,7 +71,7 @@ By default, this repo comes with one specific set of RAG configurations includin
 
 The accelerator presented here provides several options, for example:
 * The ability to ground a model using both data and public web pages
-* A backend that mimics the [On Your Data](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/use-your-data) flow, with the ability to switch to a custom backend
+* A backend with support for 'custom' and 'On Your Data' [conversation flows](./docs/conversation_flow_options.md)
 * Advanced prompt engineering capabilities
 * An admin site for ingesting/inspecting/configuring your dataset on the fly
 * Push or Pull model for data ingestion:  See [integrated vectorization](./docs/integrated_vectorization.md) documentation for more details

code/backend/batch/utilities/helpers/config/conversation_flow.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class ConversationFlow(Enum):
+    CUSTOM = "custom"
+    BYOD = "byod"

code/backend/batch/utilities/helpers/env_helper.py

@@ -4,6 +4,7 @@
 from dotenv import load_dotenv
 from azure.identity import DefaultAzureCredential, get_bearer_token_provider
 from azure.keyvault.secrets import SecretClient
+from backend.batch.utilities.helpers.config.conversation_flow import ConversationFlow
 
 logger = logging.getLogger(__name__)
 
@@ -204,6 +205,10 @@ def __load_config(self, **kwargs) -> None:
         self.ORCHESTRATION_STRATEGY = os.getenv(
             "ORCHESTRATION_STRATEGY", "openai_function"
         )
+        # Conversation Type - which chooses between custom or byod
+        self.CONVERSATION_FLOW = os.getenv(
+            "CONVERSATION_FLOW", ConversationFlow.CUSTOM.value
+        )
         # Speech Service
         self.AZURE_SPEECH_SERVICE_NAME = os.getenv("AZURE_SPEECH_SERVICE_NAME", "")
         self.AZURE_SPEECH_SERVICE_REGION = os.getenv("AZURE_SPEECH_SERVICE_REGION")

code/create_app.py

@@ -16,6 +16,7 @@
 from backend.batch.utilities.helpers.env_helper import EnvHelper
 from backend.batch.utilities.helpers.orchestrator_helper import Orchestrator
 from backend.batch.utilities.helpers.config.config_helper import ConfigHelper
+from backend.batch.utilities.helpers.config.conversation_flow import ConversationFlow
 from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient
 from azure.identity import DefaultAzureCredential
 
@@ -333,7 +334,6 @@ def static_file(path):
     def health():
         return "OK"
 
-    @app.route("/api/conversation/azure_byod", methods=["POST"])
     def conversation_azure_byod():
         try:
             if env_helper.should_use_data():
@@ -342,19 +342,16 @@ def conversation_azure_byod():
                 return conversation_without_data(request, env_helper)
         except Exception as e:
             error_message = str(e)
-            logger.exception(
-                "Exception in /api/conversation/azure_byod | %s", error_message
-            )
+            logger.exception("Exception in /api/conversation | %s", error_message)
             return (
                 jsonify(
                     {
-                        "error": "Exception in /api/conversation/azure_byod. See log for more details."
+                        "error": "Exception in /api/conversation. See log for more details."
                     }
                 ),
                 500,
             )
 
-    @app.route("/api/conversation/custom", methods=["POST"])
     async def conversation_custom():
         message_orchestrator = get_message_orchestrator()
 
@@ -387,13 +384,28 @@ async def conversation_custom():
 
         except Exception as e:
             error_message = str(e)
-            logger.exception(
-                "Exception in /api/conversation/custom | %s", error_message
+            logger.exception("Exception in /api/conversation | %s", error_message)
+            return (
+                jsonify(
+                    {
+                        "error": "Exception in /api/conversation. See log for more details."
+                    }
+                ),
+                500,
             )
+
+    @app.route("/api/conversation", methods=["POST"])
+    async def conversation():
+        conversation_flow = env_helper.CONVERSATION_FLOW
+        if conversation_flow == ConversationFlow.CUSTOM.value:
+            return await conversation_custom()
+        elif conversation_flow == ConversationFlow.BYOD.value:
+            return conversation_azure_byod()
+        else:
             return (
                 jsonify(
                     {
-                        "error": "Exception in /api/conversation/custom. See log for more details."
+                        "error": "Invalid conversation flow configured. Value can only be 'custom' or 'byod'."
                     }
                 ),
                 500,

code/frontend/src/api/api.ts

@@ -1,23 +1,8 @@
 import { ConversationRequest } from "./models";
 
-export async function conversationApi(options: ConversationRequest, abortSignal: AbortSignal): Promise<Response> {
-    const response = await fetch("/api/conversation/azure_byod", {
-        method: "POST",
-        headers: {
-            "Content-Type": "application/json"
-        },
-        body: JSON.stringify({
-            messages: options.messages
-        }),
-        signal: abortSignal
-    });
-
-    return response;
-}
-
 
-export async function customConversationApi(options: ConversationRequest, abortSignal: AbortSignal): Promise<Response> {
-    const response = await fetch("/api/conversation/custom", {
+export async function callConversationApi(options: ConversationRequest, abortSignal: AbortSignal): Promise<Response> {
+    const response = await fetch("/api/conversation", {
         method: "POST",
         headers: {
             "Content-Type": "application/json"

code/frontend/src/pages/chat/Chat.tsx

@@ -21,7 +21,7 @@ import { multiLingualSpeechRecognizer } from "../../util/SpeechToText";
 import {
   ChatMessage,
   ConversationRequest,
-  customConversationApi,
+  callConversationApi,
   Citation,
   ToolMessageContent,
   ChatResponse,
@@ -75,7 +75,7 @@ const Chat = () => {
 
     let result = {} as ChatResponse;
     try {
-      const response = await customConversationApi(
+      const response = await callConversationApi(
         request,
         abortController.signal
       );

code/tests/functional/app_config.py

@@ -1,6 +1,7 @@
 import base64
 import logging
 import os
+from backend.batch.utilities.helpers.config.conversation_flow import ConversationFlow
 
 logger = logging.getLogger(__name__)
 
@@ -69,6 +70,7 @@ class AppConfig:
         "LOAD_CONFIG_FROM_BLOB_STORAGE": "True",
         "LOGLEVEL": "DEBUG",
         "ORCHESTRATION_STRATEGY": "openai_function",
+        "CONVERSATION_FLOW": ConversationFlow.CUSTOM.value,
         "AZURE_SPEECH_RECOGNIZER_LANGUAGES": "en-US,es-ES",
         "TIKTOKEN_CACHE_DIR": f"{os.path.dirname(os.path.realpath(__file__))}/resources",
         "USE_ADVANCED_IMAGE_PROCESSING": "False",

code/tests/functional/tests/backend_api/default/conftest.py

@@ -1,5 +1,6 @@
 import logging
 import pytest
+from backend.batch.utilities.helpers.config.conversation_flow import ConversationFlow
 from tests.functional.app_config import AppConfig
 from tests.functional.tests.backend_api.common import get_free_port, start_app
 from backend.batch.utilities.helpers.config.config_helper import ConfigHelper
@@ -34,6 +35,7 @@ def app_config(make_httpserver, ca):
                 "USE_ADVANCED_IMAGE_PROCESSING": "True",
                 "SSL_CERT_FILE": ca_temp_path,
                 "CURL_CA_BUNDLE": ca_temp_path,
+                "CONVERSATION_FLOW": ConversationFlow.CUSTOM.value,
             }
         )
         logger.info(f"Created app config: {app_config.get_all()}")

code/tests/functional/tests/backend_api/default/test_advanced_image_processing.py

@@ -10,7 +10,7 @@
 
 pytestmark = pytest.mark.functional
 
-path = "/api/conversation/custom"
+path = "/api/conversation"
 body = {
     "conversation_id": "123",
     "messages": [

code/tests/functional/tests/backend_api/default/test_conversation_custom.py → code/tests/functional/tests/backend_api/default/test_conversation.py

@@ -12,7 +12,7 @@
 
 pytestmark = pytest.mark.functional
 
-path = "/api/conversation/custom"
+path = "/api/conversation"
 body = {
     "conversation_id": "123",
     "messages": [
@@ -646,7 +646,7 @@ def test_post_returns_error_when_downstream_fails(
 
     # when
     response = requests.post(
-        f"{app_url}/api/conversation/custom",
+        f"{app_url}/api/conversation",
         json={
             "conversation_id": "123",
             "messages": [
@@ -661,5 +661,5 @@ def test_post_returns_error_when_downstream_fails(
     assert response.status_code == 500
     assert response.headers["Content-Type"] == "application/json"
     assert json.loads(response.text) == {
-        "error": "Exception in /api/conversation/custom. See log for more details."
+        "error": "Exception in /api/conversation. See log for more details."
     }

code/tests/functional/tests/backend_api/default/test_post_prompt_tool.py

@@ -12,7 +12,7 @@
 
 pytestmark = pytest.mark.functional
 
-path = "/api/conversation/custom"
+path = "/api/conversation"
 body = {
     "conversation_id": "123",
     "messages": [

code/tests/functional/tests/backend_api/integrated_vectorization_custom_conversation/test_iv_question_answer_tool.py

@@ -12,7 +12,7 @@
 
 pytestmark = pytest.mark.functional
 
-path = "/api/conversation/custom"
+path = "/api/conversation"
 body = {
     "conversation_id": "123",
     "messages": [
@@ -257,7 +257,7 @@ def test_post_returns_error_when_downstream_fails(
 
     # when
     response = requests.post(
-        f"{app_url}/api/conversation/custom",
+        f"{app_url}/api/conversation",
         json={
             "conversation_id": "123",
             "messages": [
@@ -272,5 +272,5 @@ def test_post_returns_error_when_downstream_fails(
     assert response.status_code == 500
     assert response.headers["Content-Type"] == "application/json"
     assert json.loads(response.text) == {
-        "error": "Exception in /api/conversation/custom. See log for more details."
+        "error": "Exception in /api/conversation. See log for more details."
     }

code/tests/functional/tests/backend_api/sk_orchestrator/test_response_with_search_documents_tool.py

@@ -10,7 +10,7 @@
 
 pytestmark = pytest.mark.functional
 
-path = "/api/conversation/custom"
+path = "/api/conversation"
 body = {
     "conversation_id": "123",
     "messages": [

code/tests/functional/tests/backend_api/sk_orchestrator/test_response_with_text_processing_tool.py

@@ -10,7 +10,7 @@
 
 pytestmark = pytest.mark.functional
 
-path = "/api/conversation/custom"
+path = "/api/conversation"
 body = {
     "conversation_id": "123",
     "messages": [

code/tests/functional/tests/backend_api/sk_orchestrator/test_response_without_tool_call.py

@@ -12,7 +12,7 @@
 
 pytestmark = pytest.mark.functional
 
-path = "/api/conversation/custom"
+path = "/api/conversation"
 body = {
     "conversation_id": "123",
     "messages": [
@@ -264,7 +264,7 @@ def test_post_returns_error_when_downstream_fails(
 
     # when
     response = requests.post(
-        f"{app_url}/api/conversation/custom",
+        f"{app_url}/api/conversation",
         json={
             "conversation_id": "123",
             "messages": [
@@ -279,5 +279,5 @@ def test_post_returns_error_when_downstream_fails(
     assert response.status_code == 500
     assert response.headers["Content-Type"] == "application/json"
     assert json.loads(response.text) == {
-        "error": "Exception in /api/conversation/custom. See log for more details."
+        "error": "Exception in /api/conversation. See log for more details."
     }

code/tests/functional/tests/backend_api/with_byod/conftest.py

@@ -0,0 +1,60 @@
+import logging
+import pytest
+from backend.batch.utilities.helpers.config.conversation_flow import ConversationFlow
+from tests.functional.app_config import AppConfig
+from tests.functional.tests.backend_api.common import get_free_port, start_app
+from backend.batch.utilities.helpers.config.config_helper import ConfigHelper
+from backend.batch.utilities.helpers.env_helper import EnvHelper
+
+logger = logging.getLogger(__name__)
+
+
+@pytest.fixture(scope="package")
+def app_port() -> int:
+    logger.info("Getting free port")
+    return get_free_port()
+
+
+@pytest.fixture(scope="package")
+def app_url(app_port: int) -> str:
+    return f"http://localhost:{app_port}"
+
+
+@pytest.fixture(scope="package")
+def app_config(make_httpserver, ca):
+    logger.info("Creating APP CONFIG")
+    with ca.cert_pem.tempfile() as ca_temp_path:
+        app_config = AppConfig(
+            {
+                "AZURE_OPENAI_ENDPOINT": f"https://localhost:{make_httpserver.port}/",
+                "AZURE_SEARCH_SERVICE": f"https://localhost:{make_httpserver.port}/",
+                "AZURE_CONTENT_SAFETY_ENDPOINT": f"https://localhost:{make_httpserver.port}/",
+                "AZURE_SPEECH_REGION_ENDPOINT": f"https://localhost:{make_httpserver.port}/",
+                "AZURE_STORAGE_ACCOUNT_ENDPOINT": f"https://localhost:{make_httpserver.port}/",
+                "SSL_CERT_FILE": ca_temp_path,
+                "CURL_CA_BUNDLE": ca_temp_path,
+                "CONVERSATION_FLOW": ConversationFlow.BYOD.value,
+            }
+        )
+        logger.info(f"Created app config: {app_config.get_all()}")
+        yield app_config
+
+
+@pytest.fixture(scope="package", autouse=True)
+def manage_app(app_port: int, app_config: AppConfig):
+    app_config.apply_to_environment()
+    EnvHelper.clear_instance()
+    ConfigHelper.clear_config()
+    start_app(app_port)
+    yield
+    app_config.remove_from_environment()
+    EnvHelper.clear_instance()
+    ConfigHelper.clear_config()
+
+
+@pytest.fixture(autouse=True)
+def reset_default_config():
+    """
+    Reset the default config after each test
+    """
+    ConfigHelper.clear_config()

code/tests/functional/tests/backend_api/default/test_azure_byod.py → code/tests/functional/tests/backend_api/with_byod/test_conversation_flow.py

@@ -12,7 +12,7 @@
 
 pytestmark = pytest.mark.functional
 
-path = "/api/conversation/azure_byod"
+path = "/api/conversation"
 body = {
     "conversation_id": "123",
     "messages": [

code/tests/functional/tests/backend_api/without_data/conftest.py

@@ -1,5 +1,6 @@
 import logging
 import pytest
+from backend.batch.utilities.helpers.config.conversation_flow import ConversationFlow
 from tests.functional.app_config import AppConfig
 from tests.functional.tests.backend_api.common import get_free_port, start_app
 from backend.batch.utilities.helpers.config.config_helper import ConfigHelper
@@ -33,6 +34,7 @@ def app_config(make_httpserver, ca):
                 "AZURE_STORAGE_ACCOUNT_ENDPOINT": f"https://localhost:{make_httpserver.port}/",
                 "SSL_CERT_FILE": ca_temp_path,
                 "CURL_CA_BUNDLE": ca_temp_path,
+                "CONVERSATION_FLOW": ConversationFlow.BYOD.value,
             }
         )
         logger.info(f"Created app config: {app_config.get_all()}")