feat: easier usage of ragbits components in custom frontends

examples/chat/offline_chat.py

@@ -22,6 +22,7 @@
 from collections.abc import AsyncGenerator
 from typing import Literal
 
+from fastapi import UploadFile
 from pydantic import BaseModel, ConfigDict, Field
 
 from ragbits.chat.interface import ChatInterface
@@ -150,3 +151,25 @@ async def chat(
             yield self.create_text_response(chunk)
 
         yield self.create_followup_messages(["Example Response 1", "Example Response 2", "Example Response 3"])
+
+    async def upload_handler(self, file: UploadFile) -> None:  # noqa: PLR6301
+        """
+        Handle file uploads.
+
+        Args:
+            file: The uploaded file (FastAPI UploadFile)
+        """
+        # Read the file content
+        content = await file.read()
+        file_size = len(content)
+        filename = file.filename
+
+        # In a real application, you might process the file, ingest it into a vector store, etc.
+        # Here we just print some info to the console.
+        print(f"Received file: {filename}, size: {file_size} bytes")
+
+        # Note: The upload_handler doesn't return a response to the chat stream directly.
+        # The frontend receives a success status.
+        # If you want to notify the user in the chat, the user would usually send a message
+        # mentioning they uploaded a file, or you could potentially trigger something else.
+        # Currently the flow is: UI uploads -> Backend handles -> UI gets 200 OK.

mkdocs.yml

@@ -46,6 +46,7 @@ nav:
         - "Setup guardrails": how-to/guardrails/use_guardrails.md
       - Chatbots:
         - "Setup API & UI": how-to/chatbots/api.md
+        - "Extend and customize the UI": how-to/chatbots/extending-ui.md
       - Evaluate:
           - "Evaluate pipelines": how-to/evaluate/evaluate.md
           - "Agent simulation": how-to/evaluate/agent_simulation.md

packages/ragbits-chat/CHANGELOG.md

@@ -1,6 +1,7 @@
 # CHANGELOG
 
 ## Unreleased
+- Decoupling of components from ragbits specific logic. Introduction of slot based plugin architecture. Minimal history store implementation (#917)
 - Add timezone field to ChatContext, automatically populated from browser (#916)
 - Fix PostgreSQL conversation persistence by ensuring session flush after creating new conversation in SQL storage (#903)
 - Add file upload ingestion support with `upload_handler` in `ChatInterface` and `/api/upload` endpoint in `RagbitsAPI`.

packages/ragbits-chat/src/ragbits/chat/api.py

@@ -267,6 +267,7 @@ async def config() -> JSONResponse:
                     auth_types=auth_types,
                     oauth2_providers=oauth2_providers,
                 ),
+                supports_upload=self.chat_interface.upload_handler is not None,
             )
 
             return JSONResponse(content=config_response.model_dump())

packages/ragbits-chat/src/ragbits/chat/interface/types.py

@@ -901,6 +901,7 @@ class ConfigResponse(BaseModel):
     feedback: FeedbackConfig = Field(..., description="Feedback configuration")
     customization: UICustomization | None = Field(default=None, description="UI customization")
     user_settings: UserSettings = Field(default_factory=UserSettings, description="User settings")
+    supports_upload: bool = Field(default=False, description="Flag indicating whether API supports file upload")
     debug_mode: bool = Field(default=False, description="Debug mode flag")
     conversation_history: bool = Field(default=False, description="Flag to enable conversation history")
     show_usage: bool = Field(default=False, description="Flag to enable usage statistics")