chainlit 1.1.300rc4__py3-none-any.whl → 1.1.300rc5__py3-none-any.whl

chainlit/socket.py

@@ -2,8 +2,8 @@ import asyncio
 import json
 import time
 import uuid
-from urllib.parse import unquote
 from typing import Any, Dict, Literal
+from urllib.parse import unquote
 
 from chainlit.action import Action
 from chainlit.auth import get_current_user, require_login
@@ -13,14 +13,15 @@ from chainlit.data import get_data_layer
 from chainlit.element import Element
 from chainlit.logger import logger
 from chainlit.message import ErrorMessage, Message
-from chainlit.server import socket
+from chainlit.server import sio
 from chainlit.session import WebsocketSession
 from chainlit.telemetry import trace_event
 from chainlit.types import (
     AudioChunk,
     AudioChunkPayload,
     AudioEndPayload,
-    UIMessagePayload,
+    SystemMessagePayload,
+    UserMessagePayload,
 )
 from chainlit.user_session import user_sessions
 
@@ -53,7 +54,7 @@ async def resume_thread(session: WebsocketSession):
     user_is_author = author == session.user.identifier
 
     if user_is_author:
-        metadata = thread.get("metadata", {})
+        metadata = thread.get("metadata") or {}
         user_sessions[session.id] = metadata.copy()
         if chat_profile := metadata.get("chat_profile"):
             session.chat_profile = chat_profile
@@ -98,8 +99,8 @@ def build_anon_user_identifier(environ):
         return str(uuid.uuid5(uuid.NAMESPACE_DNS, ip))
 
 
-@socket.on("connect")
-async def connect(sid, environ, auth):
+@sio.on("connect")
+async def connect(sid, environ):
     if (
         not config.code.on_chat_start
         and not config.code.on_message
@@ -124,11 +125,11 @@ async def connect(sid, environ, auth):
 
     # Session scoped function to emit to the client
     def emit_fn(event, data):
-        return socket.emit(event, data, to=sid)
+        return sio.emit(event, data, to=sid)
 
     # Session scoped function to emit to the client and wait for a response
     def emit_call_fn(event: Literal["ask", "call_fn"], data, timeout):
-        return socket.call(event, data, timeout=timeout, to=sid)
+        return sio.call(event, data, timeout=timeout, to=sid)
 
     session_id = environ.get("HTTP_X_CHAINLIT_SESSION_ID")
     if restore_existing_session(sid, session_id, emit_fn, emit_call_fn):
@@ -140,7 +141,9 @@ async def connect(sid, environ, auth):
     client_type = environ.get("HTTP_X_CHAINLIT_CLIENT_TYPE")
     http_referer = environ.get("HTTP_REFERER")
     url_encoded_chat_profile = environ.get("HTTP_X_CHAINLIT_CHAT_PROFILE")
-    chat_profile = unquote(url_encoded_chat_profile) if url_encoded_chat_profile else None
+    chat_profile = (
+        unquote(url_encoded_chat_profile) if url_encoded_chat_profile else None
+    )
 
     ws_session = WebsocketSession(
         id=session_id,
@@ -161,7 +164,7 @@ async def connect(sid, environ, auth):
     return True
 
 
-@socket.on("connection_successful")
+@sio.on("connection_successful")
 async def connection_successful(sid):
     context = init_ws_context(sid)
 
@@ -189,14 +192,14 @@ async def connection_successful(sid):
         context.session.current_task = task
 
 
-@socket.on("clear_session")
+@sio.on("clear_session")
 async def clean_session(sid):
     session = WebsocketSession.get(sid)
     if session:
         session.to_clear = True
 
 
-@socket.on("disconnect")
+@sio.on("disconnect")
 async def disconnect(sid):
     session = WebsocketSession.get(sid)
 
@@ -230,7 +233,7 @@ async def disconnect(sid):
         asyncio.ensure_future(clear_on_timeout(sid))
 
 
-@socket.on("stop")
+@sio.on("stop")
 async def stop(sid):
     if session := WebsocketSession.get(sid):
         trace_event("stop_task")
@@ -245,7 +248,7 @@ async def stop(sid):
             await config.code.on_stop()
 
 
-async def process_message(session: WebsocketSession, payload: UIMessagePayload):
+async def process_message(session: WebsocketSession, payload: UserMessagePayload):
     """Process a message from the user."""
     try:
         context = init_ws_context(session)
@@ -267,8 +270,8 @@ async def process_message(session: WebsocketSession, payload: UIMessagePayload):
         await context.emitter.task_end()
 
 
-@socket.on("ui_message")
-async def message(sid, payload: UIMessagePayload):
+@sio.on("user_message")
+async def message(sid, payload: UserMessagePayload):
     """Handle a message sent by the User."""
     session = WebsocketSession.require(sid)
 
@@ -276,7 +279,24 @@ async def message(sid, payload: UIMessagePayload):
     session.current_task = task
 
 
-@socket.on("audio_chunk")
+@sio.on("system_message")
+async def on_system_message(sid, payload: SystemMessagePayload):
+    """Handle a message sent by the User."""
+    session = WebsocketSession.require(sid)
+
+    init_ws_context(session)
+    message = Message(
+        type="system_message",
+        content=payload["content"],
+        metadata=payload.get("metadata"),
+    )
+    asyncio.create_task(message._create())
+
+    if config.code.on_system_message:
+        await config.code.on_system_message(message)
+
+
+@sio.on("audio_chunk")
 async def audio_chunk(sid, payload: AudioChunkPayload):
     """Handle an audio chunk sent by the user."""
     session = WebsocketSession.require(sid)
@@ -287,7 +307,7 @@ async def audio_chunk(sid, payload: AudioChunkPayload):
         asyncio.create_task(config.code.on_audio_chunk(AudioChunk(**payload)))
 
 
-@socket.on("audio_end")
+@sio.on("audio_end")
 async def audio_end(sid, payload: AudioEndPayload):
     """Handle the end of the audio stream."""
     session = WebsocketSession.require(sid)
@@ -331,7 +351,7 @@ async def process_action(action: Action):
         logger.warning("No callback found for action %s", action.name)
 
 
-@socket.on("action_call")
+@sio.on("action_call")
 async def call_action(sid, action):
     """Handle an action call from the UI."""
     context = init_ws_context(sid)
@@ -358,7 +378,7 @@ async def call_action(sid, action):
         )
 
 
-@socket.on("chat_settings_change")
+@sio.on("chat_settings_change")
 async def change_settings(sid, settings: Dict[str, Any]):
     """Handle change settings submit from the UI."""
     context = init_ws_context(sid)

chainlit/step.py

@@ -295,7 +295,10 @@ class Step:
         tasks = [el.send(for_id=self.id) for el in self.elements]
         await asyncio.gather(*tasks)
 
-        if config.ui.hide_cot and (self.parent_id or "message" not in self.type):
+        if config.ui.hide_cot and self.type not in [
+            "user_message",
+            "assistant_message",
+        ]:
             return True
 
         await context.emitter.update_step(step_dict)
@@ -349,7 +352,10 @@ class Step:
         tasks = [el.send(for_id=self.id) for el in self.elements]
         await asyncio.gather(*tasks)
 
-        if config.ui.hide_cot and (self.parent_id or "message" not in self.type):
+        if config.ui.hide_cot and self.type not in [
+            "user_message",
+            "assistant_message",
+        ]:
             return self
 
         await context.emitter.send_step(step_dict)
@@ -374,7 +380,10 @@ class Step:
 
         assert self.id
 
-        if config.ui.hide_cot and (self.parent_id or "message" not in self.type):
+        if config.ui.hide_cot and self.type not in [
+            "user_message",
+            "assistant_message",
+        ]:
             return
 
         if not self.streaming:

chainlit/teams/__init__.py

@@ -0,0 +1,6 @@
+try:
+    import botbuilder
+except ModuleNotFoundError:
+    raise ValueError(
+        "The botbuilder-core package is required to integrate Chainlit with a Slack app. Run `pip install botbuilder-core --upgrade`"
+    )

chainlit/teams/app.py

@@ -0,0 +1,332 @@
+import asyncio
+import base64
+import mimetypes
+import os
+import uuid
+from typing import TYPE_CHECKING, Dict, List, Literal, Optional, Union
+
+import filetype
+
+if TYPE_CHECKING:
+    from botbuilder.core import TurnContext
+    from botbuilder.schema import Activity
+
+import httpx
+from botbuilder.core import (
+    BotFrameworkAdapter,
+    BotFrameworkAdapterSettings,
+    MessageFactory,
+    TurnContext,
+)
+from botbuilder.schema import (
+    ActionTypes,
+    Activity,
+    ActivityTypes,
+    Attachment,
+    CardAction,
+    ChannelAccount,
+    HeroCard,
+)
+from chainlit.config import config
+from chainlit.context import ChainlitContext, HTTPSession, context_var
+from chainlit.data import get_data_layer
+from chainlit.element import Element, ElementDict
+from chainlit.emitter import BaseChainlitEmitter
+from chainlit.logger import logger
+from chainlit.message import Message, StepDict
+from chainlit.telemetry import trace
+from chainlit.types import Feedback
+from chainlit.user import PersistedUser, User
+from chainlit.user_session import user_session
+
+
+class TeamsEmitter(BaseChainlitEmitter):
+    def __init__(self, session: HTTPSession, turn_context: TurnContext, enabled=False):
+        super().__init__(session)
+        self.turn_context = turn_context
+        self.enabled = enabled
+
+    async def send_element(self, element_dict: ElementDict):
+        if not self.enabled or element_dict.get("display") != "inline":
+            return
+
+        persisted_file = self.session.files.get(element_dict.get("chainlitKey") or "")
+        attachment: Optional[Attachment] = None
+        mime: Optional[str] = None
+
+        element_name: str = element_dict.get("name", "Untitled")
+
+        if mime:
+            file_extension = mimetypes.guess_extension(mime)
+            if file_extension:
+                element_name += file_extension
+
+        if persisted_file:
+            mime = element_dict.get("mime")
+            with open(persisted_file["path"], "rb") as file:
+                dencoded_string = base64.b64encode(file.read()).decode()
+                content_url = f"data:{mime};base64,{dencoded_string}"
+                attachment = Attachment(
+                    content_type=mime, content_url=content_url, name=element_name
+                )
+
+        elif url := element_dict.get("url"):
+            attachment = Attachment(
+                content_type=mime, content_url=url, name=element_name
+            )
+
+        if not attachment:
+            return
+
+        await self.turn_context.send_activity(Activity(attachments=[attachment]))
+
+    async def send_step(self, step_dict: StepDict):
+        if not self.enabled:
+            return
+
+        step_type = step_dict.get("type")
+        is_message = step_type in [
+            "user_message",
+            "assistant_message",
+        ]
+        is_chain_of_thought = bool(step_dict.get("parentId"))
+        is_empty_output = not step_dict.get("output")
+
+        if is_chain_of_thought or is_empty_output or not is_message:
+            return
+        else:
+            reply = MessageFactory.text(step_dict["output"])
+            enable_feedback = not step_dict.get("disableFeedback") and get_data_layer()
+            if enable_feedback:
+                like_button = CardAction(
+                    type=ActionTypes.message_back,
+                    title="👍",
+                    text="like",
+                    value={"feedback": "like", "step_id": step_dict["id"]},
+                )
+                dislike_button = CardAction(
+                    type=ActionTypes.message_back,
+                    title="👎",
+                    text="dislike",
+                    value={"feedback": "dislike", "step_id": step_dict["id"]},
+                )
+                card = HeroCard(buttons=[like_button, dislike_button])
+                attachment = Attachment(
+                    content_type="application/vnd.microsoft.card.hero", content=card
+                )
+                reply.attachments = [attachment]
+
+            await self.turn_context.send_activity(reply)
+
+    async def update_step(self, step_dict: StepDict):
+        if not self.enabled:
+            return
+
+        await self.send_step(step_dict)
+
+
+adapter_settings = BotFrameworkAdapterSettings(
+    app_id=os.environ.get("TEAMS_APP_ID"),
+    app_password=os.environ.get("TEAMS_APP_PASSWORD"),
+)
+adapter = BotFrameworkAdapter(adapter_settings)
+
+
+@trace
+def init_teams_context(
+    session: HTTPSession,
+    turn_context: TurnContext,
+) -> ChainlitContext:
+    emitter = TeamsEmitter(session=session, turn_context=turn_context)
+    context = ChainlitContext(session=session, emitter=emitter)
+    context_var.set(context)
+    user_session.set("teams_turn_context", turn_context)
+    return context
+
+
+users_by_teams_id: Dict[str, Union[User, PersistedUser]] = {}
+
+USER_PREFIX = "teams_"
+
+
+async def get_user(teams_user: ChannelAccount):
+    if teams_user.id in users_by_teams_id:
+        return users_by_teams_id[teams_user.id]
+
+    metadata = {
+        "name": teams_user.name,
+        "id": teams_user.id,
+    }
+    user = User(identifier=USER_PREFIX + str(teams_user.name), metadata=metadata)
+
+    users_by_teams_id[teams_user.id] = user
+
+    if data_layer := get_data_layer():
+        try:
+            persisted_user = await data_layer.create_user(user)
+            if persisted_user:
+                users_by_teams_id[teams_user.id] = persisted_user
+        except Exception as e:
+            logger.error(f"Error creating user: {e}")
+
+    return users_by_teams_id[teams_user.id]
+
+
+async def download_teams_file(url: str):
+    async with httpx.AsyncClient() as client:
+        response = await client.get(url)
+        if response.status_code == 200:
+            return response.content
+        else:
+            return None
+
+
+async def download_teams_files(
+    session: HTTPSession, attachments: Optional[List[Attachment]] = None
+):
+    if not attachments:
+        return []
+
+    attachments = [
+        attachment for attachment in attachments if isinstance(attachment.content, dict)
+    ]
+    download_coros = [
+        download_teams_file(attachment.content.get("downloadUrl"))
+        for attachment in attachments
+    ]
+    file_bytes_list = await asyncio.gather(*download_coros)
+    file_refs = []
+    for idx, file_bytes in enumerate(file_bytes_list):
+        if file_bytes:
+            name = attachments[idx].name
+            mime_type = filetype.guess_mime(file_bytes) or "application/octet-stream"
+            file_ref = await session.persist_file(
+                name=name, mime=mime_type, content=file_bytes
+            )
+            file_refs.append(file_ref)
+
+    files_dicts = [
+        session.files[file["id"]] for file in file_refs if file["id"] in session.files
+    ]
+
+    file_elements = [Element.from_dict(file_dict) for file_dict in files_dicts]
+
+    return file_elements
+
+
+def clean_content(activity: Activity):
+    return activity.text.strip()
+
+
+async def process_teams_message(
+    turn_context: TurnContext,
+    thread_name: str,
+):
+    user = await get_user(turn_context.activity.from_property)
+
+    thread_id = str(
+        uuid.uuid5(uuid.NAMESPACE_DNS, str(turn_context.activity.conversation.id))
+    )
+
+    text = clean_content(turn_context.activity)
+    teams_files = turn_context.activity.attachments
+
+    session_id = str(uuid.uuid4())
+
+    session = HTTPSession(
+        id=session_id,
+        thread_id=thread_id,
+        user=user,
+        client_type="teams",
+    )
+
+    ctx = init_teams_context(
+        session=session,
+        turn_context=turn_context,
+    )
+
+    file_elements = await download_teams_files(session, teams_files)
+
+    msg = Message(
+        content=text,
+        elements=file_elements,
+        type="user_message",
+        author=user.metadata.get("name"),
+    )
+
+    await msg.send()
+
+    ctx.emitter.enabled = True
+
+    if on_chat_start := config.code.on_chat_start:
+        await on_chat_start()
+
+    if on_message := config.code.on_message:
+        await on_message(msg)
+
+    if on_chat_end := config.code.on_chat_end:
+        await on_chat_end()
+
+    if data_layer := get_data_layer():
+        if isinstance(user, PersistedUser):
+            try:
+                await data_layer.update_thread(
+                    thread_id=thread_id,
+                    name=thread_name,
+                    metadata=ctx.session.to_persistable(),
+                    user_id=user.id,
+                )
+            except Exception as e:
+                logger.error(f"Error updating thread: {e}")
+
+    ctx.session.delete()
+
+
+async def handle_message(turn_context: TurnContext):
+    if turn_context.activity.type == ActivityTypes.message:
+        if (
+            turn_context.activity.text == "like"
+            or turn_context.activity.text == "dislike"
+        ):
+            feedback_value: Literal[0, 1] = (
+                0 if turn_context.activity.text == "dislike" else 1
+            )
+            step_id = turn_context.activity.value.get("step_id")
+            if data_layer := get_data_layer():
+                await data_layer.upsert_feedback(
+                    Feedback(forId=step_id, value=feedback_value)
+                )
+            updated_text = "👍" if turn_context.activity.text == "like" else "👎"
+            # Update the existing message to remove the buttons
+            updated_message = Activity(
+                type=ActivityTypes.message,
+                id=turn_context.activity.reply_to_id,
+                text=updated_text,
+                attachments=[],
+            )
+            await turn_context.update_activity(updated_message)
+        else:
+            # Send typing activity
+            typing_activity = Activity(
+                type=ActivityTypes.typing,
+                from_property=turn_context.activity.recipient,
+                recipient=turn_context.activity.from_property,
+                conversation=turn_context.activity.conversation,
+            )
+            await turn_context.send_activity(typing_activity)
+            thread_name = f"{turn_context.activity.from_property.name} Teams DM"
+            await process_teams_message(turn_context, thread_name)
+
+
+async def on_turn(turn_context: TurnContext):
+    await handle_message(turn_context)
+
+
+# Create the main bot class
+class TeamsBot:
+    async def on_turn(self, turn_context: TurnContext):
+        await on_turn(turn_context)
+
+
+# Create the bot instance
+bot = TeamsBot()

chainlit/translations/en-US.json

@@ -20,7 +20,7 @@
         "TaskList": {
           "title": "🗒️ Task List",
           "loading": "Loading...",
-          "error": "An error occured"
+          "error": "An error occurred"
         }
       },
       "attachments": {

chainlit/types.py

@@ -150,11 +150,16 @@ class FileDict(TypedDict):
     type: str
 
 
-class UIMessagePayload(TypedDict):
+class UserMessagePayload(TypedDict):
     message: "StepDict"
     fileReferences: Optional[List[FileReference]]
 
 
+class SystemMessagePayload(TypedDict):
+    content: str
+    metadata: Optional[Dict[str, Any]]
+
+
 class AudioChunkPayload(TypedDict):
     isStart: bool
     mimeType: str
@@ -193,21 +198,6 @@ class AskActionResponse(TypedDict):
     collapsed: bool
 
 
-class GenerationRequest(BaseModel):
-    chatGeneration: Optional[ChatGeneration] = None
-    completionGeneration: Optional[CompletionGeneration] = None
-    userEnv: Dict[str, str]
-
-    @property
-    def generation(self):
-        if self.chatGeneration:
-            return self.chatGeneration
-        return self.completionGeneration
-
-    def is_chat(self):
-        return self.chatGeneration is not None
-
-
 class DeleteThreadRequest(BaseModel):
     threadId: str
 
@@ -259,8 +249,8 @@ class FeedbackDict(TypedDict):
 @dataclass
 class Feedback:
     forId: str
-    threadId: Optional[str]
     value: Literal[0, 1]
+    threadId: Optional[str] = None
     id: Optional[str] = None
     comment: Optional[str] = None
 

chainlit/user.py

@@ -4,7 +4,15 @@ from dataclasses_json import DataClassJsonMixin
 from pydantic.dataclasses import Field, dataclass
 
 Provider = Literal[
-    "credentials", "header", "github", "google", "azure-ad", "okta", "auth0", "descope"
+    "credentials",
+    "header",
+    "github",
+    "google",
+    "azure-ad",
+    "azure-ad-hybrid",
+    "okta",
+    "auth0",
+    "descope",
 ]
 
 

chainlit/utils.py

@@ -1,12 +1,16 @@
 import functools
 import importlib
 import inspect
+import os
 from asyncio import CancelledError
 from typing import Callable
 
+import click
+from chainlit.auth import ensure_jwt_secret
 from chainlit.context import context
 from chainlit.logger import logger
 from chainlit.message import ErrorMessage
+from fastapi import FastAPI
 from packaging import version
 
 
@@ -87,3 +91,41 @@ def check_module_version(name, required_version):
     except ModuleNotFoundError:
         return False
     return version.parse(module.__version__) >= version.parse(required_version)
+
+
+def check_file(target: str):
+    # Define accepted file extensions for Chainlit
+    ACCEPTED_FILE_EXTENSIONS = ("py", "py3")
+
+    _, extension = os.path.splitext(target)
+
+    # Check file extension
+    if extension[1:] not in ACCEPTED_FILE_EXTENSIONS:
+        if extension[1:] == "":
+            raise click.BadArgumentUsage(
+                "Chainlit requires raw Python (.py) files, but the provided file has no extension."
+            )
+        else:
+            raise click.BadArgumentUsage(
+                f"Chainlit requires raw Python (.py) files, not {extension}."
+            )
+
+    if not os.path.exists(target):
+        raise click.BadParameter(f"File does not exist: {target}")
+
+
+def mount_chainlit(app: FastAPI, target: str, path="/chainlit"):
+    os.environ["CHAINLIT_ROOT_PATH"] = path
+    from chainlit.config import config, load_module
+    from chainlit.server import combined_asgi_app as chainlit_app
+
+    config.run.root_path = path
+
+    check_file(target)
+    # Load the module provided by the user
+    config.run.module_name = target
+    load_module(config.run.module_name)
+
+    ensure_jwt_secret()
+
+    app.mount("/", chainlit_app)