A faster way to build chatbot UIs.
Project description
Welcome to Chainlit 👋
A faster way to build chatbot UIs.
Chainlit lets you create chatbot UIs on top of any Python code in minutes. It’s all Python, open-source, and free! Some of the key features include intermediary steps visualisation, element management & display (images, text, carousel, etc.) as well as cloud deployment.
Installation
Open a terminal and run:
$ pip install chainlit
$ chainlit hello
If this opens the hello app
in your browser, you're all set!
📖 Documentation
Please see here for full documentation on:
- Getting started (installation, simple examples)
- Examples
- Reference (full API docs)
🚀 Quickstart
🐍 Pure Python
Create a new file demo.py
with the following code:
import chainlit as cl
@cl.on_message # this function will be called every time a user inputs a message in the UI
def main(message: str):
# this is an intermediate step
cl.send_message(author="Tool 1", content=f"Response from tool1", indent=1)
# send back the final answer
cl.send_message(content=f"This is the final answer")
Now run it!
$ chainlit run demo.py -w
🔗 With LangChain
Checkout our plug and play integration with LangChain!
🛣 Roadmap
- New UI elements (spreadsheet, video, carousel...)
- Create your own UI elements via component framework
- DAG-based chain-of-thought interface
- Support more LLMs in the prompt playground
- App deployment
Tell us what you would like to see added in Chainlit using the Github issues or on Discord.
💁 Contributing
As an open-source initiative in a rapidly evolving domain, we welcome contributions, be it through the addition of new features or the improvement of documentation.
For detailed information on how to contribute, see here.
License
Chainlit is open-source and licensed under the Apache 2.0 license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.