chainlit 1.2.0__py3-none-any.whl → 1.2.0rc0__py3-none-any.whl

chainlit/__init__.py

@@ -16,6 +16,8 @@ from typing import TYPE_CHECKING, Any, Dict
 
 import chainlit.input_widget as input_widget
 from chainlit.action import Action
+from chainlit.assistant import Assistant
+from chainlit.assistant_settings import AssistantSettings
 from chainlit.cache import cache
 from chainlit.chat_context import chat_context
 from chainlit.chat_settings import ChatSettings
@@ -61,6 +63,8 @@ from .callbacks import (
     on_chat_end,
     on_chat_resume,
     on_chat_start,
+    on_create_assistant,
+    on_list_assistants,
     on_logout,
     on_message,
     on_settings_update,
@@ -134,6 +138,10 @@ __all__ = [
     "TaskStatus",
     "Video",
     "ChatSettings",
+    # Experimental
+    "AssistantSettings",
+    # Experimental
+    "Assistant",
     "input_widget",
     "Message",
     "ErrorMessage",
@@ -153,6 +161,8 @@ __all__ = [
     "action_callback",
     "author_rename",
     "on_settings_update",
+    "on_create_assistant",
+    "on_list_assistants",
     "password_auth_callback",
     "header_auth_callback",
     "sleep",

chainlit/assistant.py

@@ -0,0 +1,16 @@
+from typing import List, Dict
+from chainlit.input_widget import InputWidget
+
+class Assistant:
+    input_widgets: List[InputWidget] = []
+    settings_values: Dict = {}
+
+    def __init__(self, input_widgets: List[InputWidget], settings_values: Dict):
+        self.input_widgets = input_widgets
+        self.settings_values = settings_values
+    
+    def to_dict(self):
+        return {
+            "input_widgets": [widget.__repr__() for widget in self.input_widgets],
+            "settings_values": self.settings_values
+        }

chainlit/assistant_settings.py

@@ -0,0 +1,35 @@
+import logging
+from typing import List
+
+from chainlit.context import context
+from chainlit.input_widget import InputWidget
+from pydantic.dataclasses import Field, dataclass
+
+
+@dataclass
+class AssistantSettings:
+    """Useful to create chat settings that the user can change."""
+
+    inputs: List[InputWidget] = Field(default_factory=list, exclude=True)
+
+    def __init__(
+        self,
+        inputs: List[InputWidget],
+    ) -> None:
+        self.inputs = inputs
+
+    def settings(self):
+        return dict(
+            [(input_widget.id, input_widget.initial) for input_widget in self.inputs]
+        )
+
+    async def send(self):
+        settings = self.settings()
+        context.emitter.set_assistant_settings(settings)
+
+        inputs_content = [input_widget.to_dict() for input_widget in self.inputs]
+        # logging.info(f"Sending assistant settings: {inputs_content}")
+        await context.emitter.emit("assistant_settings", inputs_content)
+
+        # logging.info(f"Assistant settings sent: {settings}")
+        return settings

chainlit/callbacks.py

@@ -1,7 +1,10 @@
+import functools
 import inspect
 from typing import Any, Awaitable, Callable, Dict, List, Optional
 
 from chainlit.action import Action
+from chainlit.assistant import Assistant
+from chainlit.assistant_settings import AssistantSettings
 from chainlit.config import config
 from chainlit.message import Message
 from chainlit.oauth_providers import get_configured_oauth_providers
@@ -14,6 +17,15 @@ from fastapi import Request, Response
 from starlette.datastructures import Headers
 
 
+def experimental(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        print(f"\033[1;33mexperimental feature: {func.__name__}\033[0m")
+        return func(*args, **kwargs)
+
+    return wrapper
+
+
 @trace
 def password_auth_callback(
     func: Callable[[str, str], Awaitable[Optional[User]]]
@@ -306,3 +318,23 @@ def on_settings_update(
 
     config.code.on_settings_update = wrap_user_function(func, with_task=True)
     return func
+
+
+# Experimental
+@trace
+@experimental
+def on_create_assistant(
+    func: Callable[[Optional[User], AssistantSettings], Any]
+) -> Callable[[Optional[User], AssistantSettings], Any]:
+    config.code.on_create_assistant = wrap_user_function(func)
+    return func
+
+
+# Experimental
+@trace
+@experimental
+def on_list_assistants(
+    func: Callable[[Optional[User]], List[Assistant]]
+) -> Callable[[Optional[User]], List[Assistant]]:
+    config.code.on_list_assistants = wrap_user_function(func)
+    return func

chainlit/cli/__init__.py

@@ -183,7 +183,7 @@ def chainlit_run(
         no_cache = True
         # This is required to have OpenAI LLM providers available for the CI run
         os.environ["OPENAI_API_KEY"] = "sk-FAKE-OPENAI-API-KEY"
-        # This is required for authenticationt tests
+        # This is required for authentication tests
         os.environ["CHAINLIT_AUTH_SECRET"] = "SUPER_SECRET"
     else:
         trace_event("chainlit run")

chainlit/config.py

@@ -28,13 +28,13 @@ from ._utils import is_path_inside
 
 if TYPE_CHECKING:
     from chainlit.action import Action
+    from chainlit.assistant import Assistant
     from chainlit.element import ElementBased
     from chainlit.message import Message
     from chainlit.types import AudioChunk, ChatProfile, Starter, ThreadDict
     from chainlit.user import User
     from fastapi import Request, Response
 
-
 BACKEND_ROOT = os.path.dirname(__file__)
 PACKAGE_ROOT = os.path.dirname(os.path.dirname(BACKEND_ROOT))
 TRANSLATIONS_DIR = os.path.join(BACKEND_ROOT, "translations")
@@ -285,9 +285,9 @@ class CodeSettings:
     password_auth_callback: Optional[
         Callable[[str, str], Awaitable[Optional["User"]]]
     ] = None
-    header_auth_callback: Optional[
-        Callable[[Headers], Awaitable[Optional["User"]]]
-    ] = None
+    header_auth_callback: Optional[Callable[[Headers], Awaitable[Optional["User"]]]] = (
+        None
+    )
     oauth_callback: Optional[
         Callable[[str, str, Dict[str, str], "User"], Awaitable[Optional["User"]]]
     ] = None
@@ -305,9 +305,13 @@ class CodeSettings:
     set_chat_profiles: Optional[
         Callable[[Optional["User"]], Awaitable[List["ChatProfile"]]]
     ] = None
-    set_starters: Optional[
-        Callable[[Optional["User"]], Awaitable[List["Starter"]]]
-    ] = None
+    set_starters: Optional[Callable[[Optional["User"]], Awaitable[List["Starter"]]]] = (
+        None
+    )
+
+    # assistant-related callback function
+    on_create_assistant: Optional[Callable[[Optional["User"], Any], Any]] = None
+    on_list_assistants: Optional[Callable[[Optional["User"]], List["Assistant"]]] = None
 
 
 @dataclass()