🔧(backend) make frontend ai bot configurable

We make the AI bot configurable with settings.
We will be able to have different AI bot name
per instance.

Author: AntoLC

docs/env.md

@@ -82,6 +82,7 @@ These are the environment variables you can set for the `impress-backend` contai
 | ALLOW_LOGOUT_GET_METHOD                         | Allow get logout method                                                                       | true                                                    |
 | AI_API_KEY                                      | AI key to be used for AI Base url                                                             |                                                         |
 | AI_BASE_URL                                     | OpenAI compatible AI base url                                                                 |                                                         |
+| AI_BOT                                          | Information to give to the frontend about the AI bot                                          | { "name": "Docs AI", "color": "#8bc6ff" }               |
 | AI_MODEL                                        | AI Model to use                                                                               |                                                         |
 | AI_ALLOW_REACH_FROM                             | Users that can use AI must be this level. options are "public", "authenticated", "restricted" | authenticated                                           |
 | AI_FEATURE_ENABLED                              | Enable AI options                                                                             | false                                                   |

src/backend/core/api/viewsets.py

@@ -1805,6 +1805,7 @@ def get(self, request):
             Return a dictionary of public settings.
         """
         array_settings = [
+            "AI_BOT",
             "AI_FEATURE_ENABLED",
             "COLLABORATION_WS_URL",
             "COLLABORATION_WS_NOT_CONNECTED_READY_ONLY",

src/backend/core/tests/test_api_config.py

@@ -18,6 +18,7 @@
 
 
 @override_settings(
+    AI_BOT={"name": "Test Bot", "color": "#000000"},
     AI_FEATURE_ENABLED=False,
     COLLABORATION_WS_URL="http://testcollab/",
     COLLABORATION_WS_NOT_CONNECTED_READY_ONLY=True,
@@ -41,6 +42,8 @@ def test_api_config(is_authenticated):
     response = client.get("/api/v1.0/config/")
     assert response.status_code == HTTP_200_OK
     assert response.json() == {
+        "AI_BOT": {"name": "Test Bot", "color": "#000000"},
+        "AI_FEATURE_ENABLED": False,
         "COLLABORATION_WS_URL": "http://testcollab/",
         "COLLABORATION_WS_NOT_CONNECTED_READY_ONLY": True,
         "CRISP_WEBSITE_ID": "123",
@@ -59,7 +62,6 @@ def test_api_config(is_authenticated):
         "MEDIA_BASE_URL": "http://testserver/",
         "POSTHOG_KEY": {"id": "132456", "host": "https://eu.i.posthog-test.com"},
         "SENTRY_DSN": "https://sentry.test/123",
-        "AI_FEATURE_ENABLED": False,
         "theme_customization": {},
     }
 

src/backend/impress/settings.py

@@ -593,24 +593,32 @@ class Base(Configuration):
         default=True, environ_name="ALLOW_LOGOUT_GET_METHOD", environ_prefix=None
     )
 
-    # AI service
-    AI_FEATURE_ENABLED = values.BooleanValue(
-        default=False, environ_name="AI_FEATURE_ENABLED", environ_prefix=None
-    )
-    AI_API_KEY = values.Value(None, environ_name="AI_API_KEY", environ_prefix=None)
-    AI_BASE_URL = values.Value(None, environ_name="AI_BASE_URL", environ_prefix=None)
-    AI_MODEL = values.Value(None, environ_name="AI_MODEL", environ_prefix=None)
+    # AI settings
     AI_ALLOW_REACH_FROM = values.Value(
         choices=("public", "authenticated", "restricted"),
         default="authenticated",
         environ_name="AI_ALLOW_REACH_FROM",
         environ_prefix=None,
     )
+    AI_API_KEY = values.Value(None, environ_name="AI_API_KEY", environ_prefix=None)
+    AI_BASE_URL = values.Value(None, environ_name="AI_BASE_URL", environ_prefix=None)
+    AI_BOT = values.DictValue(
+        default={
+            "name": _("Docs AI"),
+            "color": "#8bc6ff",
+        },
+        environ_name="AI_BOT",
+        environ_prefix=None,
+    )
     AI_DOCUMENT_RATE_THROTTLE_RATES = {
         "minute": 5,
         "hour": 100,
         "day": 500,
     }
+    AI_FEATURE_ENABLED = values.BooleanValue(
+        default=False, environ_name="AI_FEATURE_ENABLED", environ_prefix=None
+    )
+    AI_MODEL = values.Value(None, environ_name="AI_MODEL", environ_prefix=None)
     AI_USER_RATE_THROTTLE_RATES = {
         "minute": 3,
         "hour": 50,

src/frontend/apps/e2e/__tests__/app-impress/common.ts

@@ -1,6 +1,10 @@
 import { Page, expect } from '@playwright/test';
 
 export const CONFIG = {
+  AI_BOT: {
+    name: 'Docs AI',
+    color: '#8bc6ff',
+  },
   AI_FEATURE_ENABLED: true,
   CRISP_WEBSITE_ID: null,
   COLLABORATION_WS_URL: 'ws://localhost:4444/collaboration/ws/',

src/frontend/apps/impress/src/core/config/api/useConfig.tsx

@@ -12,6 +12,7 @@ interface ThemeCustomization {
 }
 
 export interface ConfigResponse {
+  AI_BOT: { name: string; color: string };
   AI_FEATURE_ENABLED?: boolean;
   COLLABORATION_WS_URL?: string;
   COLLABORATION_WS_NOT_CONNECTED_READY_ONLY?: boolean;

src/frontend/apps/impress/src/features/docs/doc-editor/components/AI/useAI.tsx

@@ -8,6 +8,7 @@ import { CoreMessage } from 'ai';
 import { useMemo } from 'react';
 
 import { fetchAPI } from '@/api';
+import { useConfig } from '@/core';
 import { Doc } from '@/docs/doc-management';
 
 const systemPrompts: Record<
@@ -47,6 +48,8 @@ const client = createBlockNoteAIClient({
  * Custom prompts can be invoked using the pattern !promptName in the AI input field.
  */
 export const useAI = (docId: Doc['id']) => {
+  const agentCursor = useConfig().data?.AI_BOT;
+
   return useMemo(() => {
     const openai = createOpenAI({
       ...client.getProviderSettings('openai'),
@@ -66,10 +69,7 @@ export const useAI = (docId: Doc['id']) => {
     const extension = createAIExtension({
       stream: false,
       model,
-      agentCursor: {
-        name: 'Albert',
-        color: '#8bc6ff',
-      },
+      agentCursor,
       // Create a custom promptBuilder that extends the default one
       promptBuilder: async (editor, opts): Promise<Array<CoreMessage>> => {
         const defaultPromptBuilder = llmFormats.html.defaultPromptBuilder;
@@ -107,5 +107,5 @@ export const useAI = (docId: Doc['id']) => {
     });
 
     return extension;
-  }, [docId]);
+  }, [agentCursor, docId]);
 };