chainlit 1.1.404__tar.gz → 1.2.0rc0__tar.gz

{chainlit-1.1.404 → chainlit-1.2.0rc0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: chainlit
-Version: 1.1.404
+Version: 1.2.0rc0
 Summary: Build Conversational AI.
 Home-page: https://github.com/Chainlit/chainlit
 License: Apache-2.0 license
@@ -16,8 +16,8 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: aiofiles (>=23.1.0,<24.0.0)
 Requires-Dist: asyncer (>=0.0.7,<0.0.8)
 Requires-Dist: click (>=8.1.3,<9.0.0)
-Requires-Dist: dataclasses_json (>=0.5.7,<0.6.0)
-Requires-Dist: fastapi (>=0.110.1,<0.111.0)
+Requires-Dist: dataclasses_json (>=0.6.7,<0.7.0)
+Requires-Dist: fastapi (>=0.110.1,<0.113)
 Requires-Dist: filetype (>=1.2.0,<2.0.0)
 Requires-Dist: httpx (>=0.23.0)
 Requires-Dist: lazify (>=0.4.0,<0.5.0)
@@ -64,16 +64,16 @@ Full documentation is available [here](https://docs.chainlit.io). You can ask Ch
 > Check out [Literal AI](https://literalai.com), our product to monitor and evaluate LLM applications! It works with any Python or TypeScript applications and [seamlessly](https://docs.chainlit.io/data-persistence/overview) with Chainlit by adding a `LITERAL_API_KEY` in your project.
 
 <p align="center">
-    <img src="https://github.com/Chainlit/chainlit/assets/13104895/0c2cc7a9-766c-41d3-aae2-117a2d0eb8ed" width="80%" />
+    <img src="https://github.com/Chainlit/chainlit/assets/13104895/0c2cc7a9-766c-41d3-aae2-117a2d0eb8ed" alt="Chainlit user interface" width="80%"></img>
 </p>
 
 ## Installation
 
 Open a terminal and run:
 
-```bash
-$ pip install chainlit
-$ chainlit hello
+```sh
+pip install chainlit
+chainlit hello
 ```
 
 If this opens the `hello app` in your browser, you're all set!
@@ -118,8 +118,8 @@ async def main(message: cl.Message):
 
 Now run it!
 
-```
-$ chainlit run demo.py -w
+```sh
+chainlit run demo.py -w
 ```
 
 <img src="/images/quick-start.png" alt="Quick Start"></img>
@@ -129,7 +129,7 @@ $ chainlit run demo.py -w
 Full documentation is available [here](https://docs.chainlit.io). Key features:
 
 - [💬 Multi Modal chats](https://docs.chainlit.io/advanced-features/multi-modal)
-- [💭 Chain of Thought visualisation](https://docs.chainlit.io/concepts/step)
+- [💭 Chain of Thought visualization](https://docs.chainlit.io/concepts/step)
 - [💾 Data persistence + human feedback](https://docs.chainlit.io/data-persistence/overview)
 - [🐛 Debug Mode](https://docs.chainlit.io/data-persistence/enterprise#debug-mode)
 - [👤 Authentication](https://docs.chainlit.io/authentication/overview)

{chainlit-1.1.404 → chainlit-1.2.0rc0}/README.md

@@ -23,16 +23,16 @@ Full documentation is available [here](https://docs.chainlit.io). You can ask Ch
 > Check out [Literal AI](https://literalai.com), our product to monitor and evaluate LLM applications! It works with any Python or TypeScript applications and [seamlessly](https://docs.chainlit.io/data-persistence/overview) with Chainlit by adding a `LITERAL_API_KEY` in your project.
 
 <p align="center">
-    <img src="https://github.com/Chainlit/chainlit/assets/13104895/0c2cc7a9-766c-41d3-aae2-117a2d0eb8ed" width="80%" />
+    <img src="https://github.com/Chainlit/chainlit/assets/13104895/0c2cc7a9-766c-41d3-aae2-117a2d0eb8ed" alt="Chainlit user interface" width="80%"></img>
 </p>
 
 ## Installation
 
 Open a terminal and run:
 
-```bash
-$ pip install chainlit
-$ chainlit hello
+```sh
+pip install chainlit
+chainlit hello
 ```
 
 If this opens the `hello app` in your browser, you're all set!
@@ -77,8 +77,8 @@ async def main(message: cl.Message):
 
 Now run it!
 
-```
-$ chainlit run demo.py -w
+```sh
+chainlit run demo.py -w
 ```
 
 <img src="/images/quick-start.png" alt="Quick Start"></img>
@@ -88,7 +88,7 @@ $ chainlit run demo.py -w
 Full documentation is available [here](https://docs.chainlit.io). Key features:
 
 - [💬 Multi Modal chats](https://docs.chainlit.io/advanced-features/multi-modal)
-- [💭 Chain of Thought visualisation](https://docs.chainlit.io/concepts/step)
+- [💭 Chain of Thought visualization](https://docs.chainlit.io/concepts/step)
 - [💾 Data persistence + human feedback](https://docs.chainlit.io/data-persistence/overview)
 - [🐛 Debug Mode](https://docs.chainlit.io/data-persistence/enterprise#debug-mode)
 - [👤 Authentication](https://docs.chainlit.io/authentication/overview)

chainlit-1.2.0rc0/chainlit/__init__.py

@@ -0,0 +1,199 @@
+import os
+
+from dotenv import load_dotenv
+
+# ruff: noqa: E402
+# Keep this here to ensure imports have environment available.
+env_found = load_dotenv(dotenv_path=os.path.join(os.getcwd(), ".env"))
+
+from chainlit.logger import logger
+
+if env_found:
+    logger.info("Loaded .env file")
+
+import asyncio
+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
+from chainlit.context import context
+from chainlit.element import (
+    Audio,
+    Component,
+    File,
+    Image,
+    Pdf,
+    Plotly,
+    Pyplot,
+    Task,
+    TaskList,
+    TaskStatus,
+    Text,
+    Video,
+)
+from chainlit.message import (
+    AskActionMessage,
+    AskFileMessage,
+    AskUserMessage,
+    ErrorMessage,
+    Message,
+)
+from chainlit.step import Step, step
+from chainlit.sync import make_async, run_sync
+from chainlit.types import AudioChunk, ChatProfile, Starter
+from chainlit.user import PersistedUser, User
+from chainlit.user_session import user_session
+from chainlit.utils import make_module_getattr
+from chainlit.version import __version__
+from literalai import ChatGeneration, CompletionGeneration, GenerationMessage
+from pydantic.dataclasses import dataclass
+
+from .callbacks import (
+    action_callback,
+    author_rename,
+    header_auth_callback,
+    oauth_callback,
+    on_audio_chunk,
+    on_audio_end,
+    on_chat_end,
+    on_chat_resume,
+    on_chat_start,
+    on_create_assistant,
+    on_list_assistants,
+    on_logout,
+    on_message,
+    on_settings_update,
+    on_stop,
+    password_auth_callback,
+    set_chat_profiles,
+    set_starters,
+)
+
+if TYPE_CHECKING:
+    from chainlit.haystack.callbacks import HaystackAgentCallbackHandler
+    from chainlit.langchain.callbacks import (
+        AsyncLangchainCallbackHandler,
+        LangchainCallbackHandler,
+    )
+    from chainlit.llama_index.callbacks import LlamaIndexCallbackHandler
+    from chainlit.mistralai import instrument_mistralai
+    from chainlit.openai import instrument_openai
+
+
+def sleep(duration: int):
+    """
+    Sleep for a given duration.
+    Args:
+        duration (int): The duration in seconds.
+    """
+    return asyncio.sleep(duration)
+
+
+@dataclass()
+class CopilotFunction:
+    name: str
+    args: Dict[str, Any]
+
+    def acall(self):
+        return context.emitter.send_call_fn(self.name, self.args)
+
+
+__getattr__ = make_module_getattr(
+    {
+        "LangchainCallbackHandler": "chainlit.langchain.callbacks",
+        "AsyncLangchainCallbackHandler": "chainlit.langchain.callbacks",
+        "LlamaIndexCallbackHandler": "chainlit.llama_index.callbacks",
+        "HaystackAgentCallbackHandler": "chainlit.haystack.callbacks",
+        "instrument_openai": "chainlit.openai",
+        "instrument_mistralai": "chainlit.mistralai",
+    }
+)
+
+__all__ = [
+    "__version__",
+    "ChatProfile",
+    "Starter",
+    "user_session",
+    "chat_context",
+    "CopilotFunction",
+    "AudioChunk",
+    "Action",
+    "User",
+    "PersistedUser",
+    "Audio",
+    "Pdf",
+    "Plotly",
+    "Image",
+    "Text",
+    "Component",
+    "Pyplot",
+    "File",
+    "Task",
+    "TaskList",
+    "TaskStatus",
+    "Video",
+    "ChatSettings",
+    # Experimental
+    "AssistantSettings",
+    # Experimental
+    "Assistant",
+    "input_widget",
+    "Message",
+    "ErrorMessage",
+    "AskUserMessage",
+    "AskActionMessage",
+    "AskFileMessage",
+    "Step",
+    "step",
+    "ChatGeneration",
+    "CompletionGeneration",
+    "GenerationMessage",
+    "on_logout",
+    "on_chat_start",
+    "on_chat_end",
+    "on_chat_resume",
+    "on_stop",
+    "action_callback",
+    "author_rename",
+    "on_settings_update",
+    "on_create_assistant",
+    "on_list_assistants",
+    "password_auth_callback",
+    "header_auth_callback",
+    "sleep",
+    "run_sync",
+    "make_async",
+    "cache",
+    "context",
+    "LangchainCallbackHandler",
+    "AsyncLangchainCallbackHandler",
+    "LlamaIndexCallbackHandler",
+    "HaystackAgentCallbackHandler",
+    "instrument_openai",
+    "instrument_mistralai",
+    "password_auth_callback",
+    "header_auth_callback",
+    "oauth_callback",
+    "on_logout",
+    "on_message",
+    "on_chat_start",
+    "on_chat_resume",
+    "set_chat_profiles",
+    "set_starters",
+    "on_chat_end",
+    "on_audio_chunk",
+    "on_audio_end",
+    "author_rename",
+    "on_stop",
+    "action_callback",
+    "on_settings_update",
+]
+
+
+def __dir__():
+    return __all__

chainlit-1.2.0rc0/chainlit/_utils.py

@@ -0,0 +1,8 @@
+"""Util functions which are explicitly not part of the public API."""
+
+from pathlib import Path
+
+
+def is_path_inside(child_path: Path, parent_path: Path) -> bool:
+    """Check if the child path is inside the parent path."""
+    return parent_path.resolve() in child_path.resolve().parents

chainlit-1.2.0rc0/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-1.2.0rc0/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