feat: Add Docs for Dynamic Profile Configuration #256
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sandangel
approved these changes
Aug 15, 2025
asvishnyakov
approved these changes
Aug 15, 2025
github-merge-queue bot
pushed a commit
to Chainlit/chainlit
that referenced
this pull request
Aug 18, 2025
## Changes: - Audio.enabled and MCP.enabled now must be explicitly enabled. Before it was inferred if on_audio_chunk and on_mcp_connect existed. This enables selective enablement by ChatProfile now. - Documentation Update PR: Chainlit/docs#256 ## ✅ Backend Implementation Complete - ChainlitConfigOverrides class in config.py - allows specifying UI, features, and project overrides - ChatProfile.config_overrides field - stores profile-specific configuration overrides - /project/settings endpoint enhancement - applies config overrides based on the chat_profile parameter - Proper serialization - removes config_overrides from profiles sent to frontend (they're applied server-side) - Pydantic dataclass rebuild - fixes forward reference issues ## ✅ Frontend Implementation Complete - Enhanced useConfig hook - includes chat_profile parameter in API calls - Automatic re-fetching - clears config when chat profile changes to trigger re-fetch with new profile-specific settings ## 🎯 How It Works - Default state: Frontend calls /project/settings?language=en-US → gets base configuration - Profile selection: User selects "vision-assistant" → chatProfileState updates - Config refresh: Frontend clears config and calls /project/settings?language=en-US&chat_profile=vision-assistant - Server merges: Backend finds vision-assistant profile, applies its config_overrides to base config - Frontend receives: Merged configuration with vision-assistant's UI name, file upload settings, etc. ## Other: - Added "UP007" to ruff ignore because it was flagging these when using Optional[str] which is valid. <img width="474" height="147" alt="image" src="https://github.com/user-attachments/assets/cfbcf0d6-68e6-4bc6-aeee-539014a52b2d" /> Fixes #1502 --------- Co-authored-by: Aleksandr Vishniakov <asvishnyakov@hotmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for https://github.com/Chainlit/chainlit/pull/2388