feat: add chat profiles

backend/chainlit/__init__.py

@@ -41,7 +41,7 @@
 from chainlit.oauth_providers import get_configured_oauth_providers
 from chainlit.sync import make_async, run_sync
 from chainlit.telemetry import trace
-from chainlit.types import FileSpec
+from chainlit.types import ChatProfile, FileSpec
 from chainlit.user_session import user_session
 from chainlit.utils import make_module_getattr, wrap_user_function
 from chainlit.version import __version__
@@ -150,6 +150,24 @@ def on_chat_start(func: Callable) -> Callable:
     return func
 
 
+@trace
+def set_chat_profiles(
+    func: Callable[[Optional["AppUser"]], List["ChatProfile"]]
+) -> Callable:
+    """
+    Programmatic declaration of the available chat profiles (can depend on the AppUser from the session if authentication is setup).
+
+    Args:
+        func (Callable[[Optional["AppUser"]], List["ChatProfile"]]): The function declaring the chat profiles.
+
+    Returns:
+        Callable[[Optional["AppUser"]], List["ChatProfile"]]: The decorated function.
+    """
+
+    config.code.set_chat_profiles = wrap_user_function(func)
+    return func
+
+
 @trace
 def on_chat_end(func: Callable) -> Callable:
     """

backend/chainlit/config.py

@@ -13,6 +13,8 @@
 if TYPE_CHECKING:
     from chainlit.action import Action
     from chainlit.client.base import AppUser
+    from chainlit.types import ChatProfile
+
 
 BACKEND_ROOT = os.path.dirname(__file__)
 PACKAGE_ROOT = os.path.dirname(os.path.dirname(BACKEND_ROOT))
@@ -171,6 +173,9 @@ class CodeSettings:
     on_file_upload: Optional[Callable[[str], Any]] = None
     author_rename: Optional[Callable[[str], str]] = None
     on_settings_update: Optional[Callable[[Dict[str, Any]], Any]] = None
+    set_chat_profiles: Optional[
+        Callable[[Optional["AppUser"]], List["ChatProfile"]]
+    ] = None
 
 
 @dataclass()

backend/chainlit/server.py

@@ -440,12 +440,18 @@ async def project_settings(
     current_user: Annotated[Union[AppUser, PersistedAppUser], Depends(get_current_user)]
 ):
     """Return project settings. This is called by the UI before the establishing the websocket connection."""
+    profiles = []
+    if config.code.set_chat_profiles:
+        chat_profiles = await config.code.set_chat_profiles(current_user)
+        if chat_profiles:
+            profiles = [p.to_dict() for p in chat_profiles]
     return JSONResponse(
         content={
             "ui": config.ui.to_dict(),
             "userEnv": config.project.user_env,
             "dataPersistence": config.data_persistence,
             "markdown": get_markdown_str(config.root),
+            "chatProfiles": profiles,
         }
     )
 

backend/chainlit/session.py

@@ -20,16 +20,19 @@ def __init__(
         user: Optional[Union["AppUser", "PersistedAppUser"]],
         # Logged-in user token
         token: Optional[str],
+        # User specific environment variables. Empty if no user environment variables are required.
         user_env: Optional[Dict[str, str]],
         # Last message at the root of the chat
         root_message: Optional["Message"] = None,
-        # User specific environment variables. Empty if no user environment variables are required.
+        # Chat profile selected before the session was created
+        chat_profile: Optional[str] = None,
     ):
         self.user = user
         self.token = token
         self.root_message = root_message
         self.has_user_message = False
         self.user_env = user_env or {}
+        self.chat_profile = chat_profile
 
         self.id = id
         self.conversation_id: Optional[str] = None
@@ -110,9 +113,16 @@ def __init__(
         token: Optional[str],
         # Last message at the root of the chat
         root_message: Optional["Message"] = None,
+        # Chat profile selected before the session was created
+        chat_profile: Optional[str] = None,
     ):
         super().__init__(
-            id=id, user=user, token=token, user_env=user_env, root_message=root_message
+            id=id,
+            user=user,
+            token=token,
+            user_env=user_env,
+            root_message=root_message,
+            chat_profile=chat_profile,
         )
 
         self.socket_id = socket_id

backend/chainlit/socket.py

@@ -47,7 +47,9 @@ def load_user_env(user_env):
 @socket.on("connect")
 async def connect(sid, environ, auth):
     if not config.code.on_chat_start and not config.code.on_message:
-        raise ConnectionRefusedError("No websocket endpoint configured")
+        raise ConnectionRefusedError(
+            "You need to configure at least an on_chat_start or an on_message callback"
+        )
 
     user = None
     token = None
@@ -91,6 +93,7 @@ def ask_user_fn(data, timeout):
         user_env=user_env,
         user=user,
         token=token,
+        chat_profile=environ.get("HTTP_X_CHAINLIT_CHAT_PROFILE"),
     )
 
     trace_event("connection_successful")

backend/chainlit/types.py

@@ -69,3 +69,12 @@ class GetConversationsRequest(BaseModel):
 class Theme(str, Enum):
     light = "light"
     dark = "dark"
+
+
+@dataclass
+class ChatProfile(DataClassJsonMixin):
+    """Specification for a chat profile that can be chosen by the user at the conversation start."""
+
+    name: str
+    markdown_description: str
+    icon: Optional[str] = None

backend/chainlit/user_session.py

@@ -13,6 +13,7 @@ class UserSessionDict(TypedDict):
     headers: Dict[str, str]
     user: Optional[Union["AppUser", "PersistedAppUser"]]
     root_message: Optional["Message"]
+    chat_profile: Optional[str]
 
 
 user_sessions: Dict[str, UserSessionDict] = {}
@@ -39,6 +40,7 @@ def get(self, key, default=None):
         user_session["env"] = context.session.user_env
         user_session["chat_settings"] = context.session.chat_settings
         user_session["user"] = context.session.user
+        user_session["chat_profile"] = context.session.chat_profile
 
         if context.session.root_message:
             user_session["root_message"] = context.session.root_message

cypress.config.ts

@@ -1,26 +1,26 @@
-import { defineConfig } from "cypress";
+import { defineConfig } from 'cypress';
 
 export default defineConfig({
-  projectId: "ij1tyk",
+  projectId: 'ij1tyk',
   component: {
     devServer: {
-      framework: "react",
-      bundler: "vite",
-    },
+      framework: 'react',
+      bundler: 'vite'
+    }
   },
 
   e2e: {
     supportFile: false,
     defaultCommandTimeout: 10000,
     video: false,
-    baseUrl: "http://127.0.0.1:8000",
+    baseUrl: 'http://127.0.0.1:8000',
     setupNodeEvents(on, config) {
-      on("task", {
+      on('task', {
         log(message) {
           console.log(message);
           return null;
-        },
+        }
       });
-    },
-  },
+    }
+  }
 });

cypress/e2e/ask_user/spec.cy.ts

@@ -1,17 +1,16 @@
-import { runTestServer, submitMessage } from "../../support/testUtils";
+import { runTestServer, submitMessage } from '../../support/testUtils';
 
-describe("Ask User", () => {
+describe('Ask User', () => {
   before(() => {
     runTestServer();
   });
 
-  it("should send a new message containing the user input", () => {
-    cy.get("#welcome-screen").should("exist");
-    cy.get(".message").should("have.length", 1);
-    submitMessage("Jeeves");
+  it('should send a new message containing the user input', () => {
+    cy.get('.message').should('have.length', 1);
+    submitMessage('Jeeves');
     cy.wait(2000);
-    cy.get(".message").should("have.length", 3);
+    cy.get('.message').should('have.length', 3);
 
-    cy.get(".message").eq(2).should("contain", "Jeeves");
+    cy.get('.message').eq(2).should('contain', 'Jeeves');
   });
 });

cypress/e2e/audio_element/spec.cy.ts

@@ -1,23 +1,21 @@
-import { runTestServer } from "../../support/testUtils";
+import { runTestServer } from '../../support/testUtils';
 
-describe("audio", () => {
+describe('audio', () => {
   before(() => {
     runTestServer();
   });
 
-  it("should be able to display an audio element", () => {
-    cy.get("#welcome-screen").should("exist");
+  it('should be able to display an audio element', () => {
+    cy.get('.message').should('have.length', 1);
+    cy.get('.message').eq(0).find('.inline-audio').should('have.length', 1);
 
-    cy.get(".message").should("have.length", 1);
-    cy.get(".message").eq(0).find(".inline-audio").should("have.length", 1);
-
-    cy.get(".inline-audio audio")
+    cy.get('.inline-audio audio')
       .then(($el) => {
         const audioElement = $el.get(0) as HTMLAudioElement;
         return audioElement.play().then(() => {
           return audioElement.duration;
         });
       })
-      .should("be.greaterThan", 0);
+      .should('be.greaterThan', 0);
   });
 });

cypress/e2e/avatar/spec.cy.ts

@@ -1,19 +1,17 @@
-import { runTestServer } from "../../support/testUtils";
+import { runTestServer } from '../../support/testUtils';
 
-describe("Avatar", () => {
+describe('Avatar', () => {
   before(() => {
     runTestServer();
   });
 
-  it("should be able to display a nested CoT", () => {
-    cy.get("#welcome-screen").should("exist");
+  it('should be able to display a nested CoT', () => {
+    cy.get('.message').should('have.length', 3);
 
-    cy.get(".message").should("have.length", 3);
+    cy.get('.message').eq(0).find('.message-avatar').should('have.length', 0);
+    cy.get('.message').eq(1).find('.message-avatar').should('have.length', 1);
+    cy.get('.message').eq(2).find('.message-avatar').should('have.length', 0);
 
-    cy.get(".message").eq(0).find(".message-avatar").should("have.length", 0);
-    cy.get(".message").eq(1).find(".message-avatar").should("have.length", 1);
-    cy.get(".message").eq(2).find(".message-avatar").should("have.length", 0);
-
-    cy.get(".element-link").should("have.length", 0);
+    cy.get('.element-link').should('have.length', 0);
   });
 });

cypress/e2e/chat_profiles/.chainlit/config.toml

@@ -0,0 +1,69 @@
+[project]
+# Whether to enable telemetry (default: true). No personal data is collected.
+enable_telemetry = true
+
+# List of environment variables to be provided by each user to use the app.
+user_env = []
+
+# Duration (in seconds) during which the session is saved when the connection is lost
+session_timeout = 3600
+
+# Enable third parties caching (e.g LangChain cache)
+cache = false
+
+# Follow symlink for asset mount (see https://github.com/Chainlit/chainlit/issues/317)
+# follow_symlink = false
+
+[features]
+# Show the prompt playground
+prompt_playground = true
+
+[UI]
+# Name of the app and chatbot.
+name = "Chatbot"
+
+# Description of the app and chatbot. This is used for HTML tags.
+# description = ""
+
+# Large size content are by default collapsed for a cleaner ui
+default_collapse_content = true
+
+# The default value for the expand messages settings.
+default_expand_messages = false
+
+# Hide the chain of thought details from the user in the UI.
+hide_cot = false
+
+# Link to your github repo. This will add a github button in the UI's header.
+# github = ""
+
+# Specify a CSS file that can be used to customize the user interface.
+# The CSS file can be served from the public directory or via an external link.
+# custom_css = "/public/test.css"
+
+# If the app is served behind a reverse proxy (like cloud run) we need to know the base url for oauth
+# base_url = "https://mydomain.com"
+
+# Override default MUI light theme. (Check theme.ts)
+[UI.theme.light]
+    #background = "#FAFAFA"
+    #paper = "#FFFFFF"
+
+    [UI.theme.light.primary]
+        #main = "#F80061"
+        #dark = "#980039"
+        #light = "#FFE7EB"
+
+# Override default MUI dark theme. (Check theme.ts)
+[UI.theme.dark]
+    #background = "#FAFAFA"
+    #paper = "#FFFFFF"
+
+    [UI.theme.dark.primary]
+        #main = "#F80061"
+        #dark = "#980039"
+        #light = "#FFE7EB"
+
+
+[meta]
+generated_by = "0.7.1"

cypress/e2e/chat_profiles/main.py

@@ -0,0 +1,48 @@
+from typing import Optional
+
+import chainlit as cl
+
+
+@cl.set_chat_profiles
+async def chat_profile(current_user: cl.AppUser):
+    if current_user.role != "ADMIN":
+        return None
+
+    return [
+        cl.ChatProfile(
+            name="GPT-3.5",
+            markdown_description="The underlying LLM model is **GPT-3.5**, a *175B parameter model* trained on 410GB of text data.",
+        ),
+        cl.ChatProfile(
+            name="GPT-4",
+            markdown_description="The underlying LLM model is **GPT-4**, a *1.5T parameter model* trained on 3.5TB of text data.",
+            icon="https://picsum.photos/250",
+        ),
+        cl.ChatProfile(
+            name="GPT-5",
+            markdown_description="The underlying LLM model is **GPT-5**.",
+            icon="https://picsum.photos/200",
+        ),
+    ]
+
+
+@cl.password_auth_callback
+def auth_callback(username: str, password: str) -> Optional[cl.AppUser]:
+    if (username, password) == ("admin", "admin"):
+        return cl.AppUser(username="admin", role="ADMIN", provider="credentials")
+    else:
+        return None
+
+
+# @cl.on_message
+# async def on_message(message: str):
+#     await cl.Message(content=f"echo: {message}").send()
+
+
+@cl.on_chat_start
+async def on_chat_start():
+    app_user = cl.user_session.get("user")
+    chat_profile = cl.user_session.get("chat_profile")
+    await cl.Message(
+        content=f"starting chat with {app_user.username} using the {chat_profile} chat profile"
+    ).send()