Add special error (#896)

Author: pamelafox

app/backend/app.py

@@ -44,6 +44,7 @@
 If you are an administrator of the app, view the full error in the logs. See aka.ms/appservice-logs for more information.
 Error type: {error_type}
 """
+ERROR_MESSAGE_FILTER = """Your message contains content that was flagged by the OpenAI content filter."""
 
 bp = Blueprint("routes", __name__, static_folder="static")
 # Fix Windows registry issue with mimetypes
@@ -101,9 +102,18 @@ async def content_file(path: str):
 
 
 def error_dict(error: Exception) -> dict:
+    if isinstance(error, openai.error.InvalidRequestError) and error.code == "content_filter":
+        return {"error": ERROR_MESSAGE_FILTER}
     return {"error": ERROR_MESSAGE.format(error_type=type(error))}
 
 
+def error_response(error: Exception, route: str, status_code: int = 500):
+    logging.exception("Exception in %s: %s", route, error)
+    if isinstance(error, openai.error.InvalidRequestError) and error.code == "content_filter":
+        status_code = 400
+    return jsonify(error_dict(error)), status_code
+
+
 @bp.route("/ask", methods=["POST"])
 async def ask():
     if not request.is_json:
@@ -122,8 +132,7 @@ async def ask():
             )
         return jsonify(r)
     except Exception as error:
-        logging.exception("Exception in /ask: %s", error)
-        return jsonify(error_dict(error)), 500
+        return error_response(error, "/ask")
 
 
 async def format_as_ndjson(r: AsyncGenerator[dict, None]) -> AsyncGenerator[str, None]:
@@ -158,8 +167,7 @@ async def chat():
             response.timeout = None  # type: ignore
             return response
     except Exception as error:
-        logging.exception("Exception in /chat: %s", error)
-        return jsonify(error_dict(error)), 500
+        return error_response(error, "/chat")
 
 
 # Send MSAL.js settings to the client UI

tests/snapshots/test_app/test_ask_handle_exception_contentsafety/client0/result.json

@@ -0,0 +1,3 @@
+{
+    "error": "Your message contains content that was flagged by the OpenAI content filter."
+}

tests/snapshots/test_app/test_ask_handle_exception_contentsafety/client1/result.json

@@ -0,0 +1,3 @@
+{
+    "error": "Your message contains content that was flagged by the OpenAI content filter."
+}

tests/snapshots/test_app/test_chat_handle_exception_contentsafety/client0/result.json

@@ -0,0 +1,3 @@
+{
+    "error": "Your message contains content that was flagged by the OpenAI content filter."
+}

tests/snapshots/test_app/test_chat_handle_exception_contentsafety/client1/result.json

@@ -0,0 +1,3 @@
+{
+    "error": "Your message contains content that was flagged by the OpenAI content filter."
+}

tests/snapshots/test_app/test_chat_handle_exception_contentsafety_streaming/client0/result.jsonlines

@@ -0,0 +1 @@
+{"error": "Your message contains content that was flagged by the OpenAI content filter."}

tests/snapshots/test_app/test_chat_handle_exception_contentsafety_streaming/client1/result.jsonlines

@@ -0,0 +1 @@
+{"error": "Your message contains content that was flagged by the OpenAI content filter."}

tests/test_app.py

@@ -3,6 +3,7 @@
 import os
 from unittest import mock
 
+import openai
 import pytest
 import quart.testing.app
 
@@ -63,6 +64,25 @@ async def test_ask_handle_exception(client, monkeypatch, snapshot, caplog):
     snapshot.assert_match(json.dumps(result, indent=4), "result.json")
 
 
+@pytest.mark.asyncio
+async def test_ask_handle_exception_contentsafety(client, monkeypatch, snapshot, caplog):
+    monkeypatch.setattr(
+        "approaches.retrievethenread.RetrieveThenReadApproach.run",
+        mock.Mock(
+            side_effect=openai.error.InvalidRequestError("The response was filtered", "prompt", code="content_filter")
+        ),
+    )
+
+    response = await client.post(
+        "/ask",
+        json={"messages": [{"content": "How do I do something bad?", "role": "user"}]},
+    )
+    assert response.status_code == 400
+    result = await response.get_json()
+    assert "Exception in /ask: The response was filtered" in caplog.text
+    snapshot.assert_match(json.dumps(result, indent=4), "result.json")
+
+
 @pytest.mark.asyncio
 async def test_ask_rtr_text(client, snapshot):
     response = await client.post(
@@ -178,6 +198,25 @@ async def test_chat_handle_exception(client, monkeypatch, snapshot, caplog):
     snapshot.assert_match(json.dumps(result, indent=4), "result.json")
 
 
+@pytest.mark.asyncio
+async def test_chat_handle_exception_contentsafety(client, monkeypatch, snapshot, caplog):
+    monkeypatch.setattr(
+        "approaches.chatreadretrieveread.ChatReadRetrieveReadApproach.run",
+        mock.Mock(
+            side_effect=openai.error.InvalidRequestError("The response was filtered", "prompt", code="content_filter")
+        ),
+    )
+
+    response = await client.post(
+        "/chat",
+        json={"messages": [{"content": "How do I do something bad?", "role": "user"}]},
+    )
+    assert response.status_code == 400
+    result = await response.get_json()
+    assert "Exception in /chat: The response was filtered" in caplog.text
+    snapshot.assert_match(json.dumps(result, indent=4), "result.json")
+
+
 @pytest.mark.asyncio
 async def test_chat_handle_exception_streaming(client, monkeypatch, snapshot, caplog):
     monkeypatch.setattr(
@@ -194,6 +233,25 @@ async def test_chat_handle_exception_streaming(client, monkeypatch, snapshot, ca
     snapshot.assert_match(result, "result.jsonlines")
 
 
+@pytest.mark.asyncio
+async def test_chat_handle_exception_contentsafety_streaming(client, monkeypatch, snapshot, caplog):
+    monkeypatch.setattr(
+        "openai.ChatCompletion.acreate",
+        mock.Mock(
+            side_effect=openai.error.InvalidRequestError("The response was filtered", "prompt", code="content_filter")
+        ),
+    )
+
+    response = await client.post(
+        "/chat",
+        json={"messages": [{"content": "How do I do something bad?", "role": "user"}], "stream": True},
+    )
+    assert response.status_code == 200
+    assert "Exception while generating response stream: The response was filtered" in caplog.text
+    result = await response.get_data()
+    snapshot.assert_match(result, "result.jsonlines")
+
+
 @pytest.mark.asyncio
 async def test_chat_text(client, snapshot):
     response = await client.post(