Skip to main content

A faster way to build chatbot UIs.

Project description

Welcome to Chainlit 👋

Build Python LLM apps in minutes ⚡️

Chainlit lets you create ChatGPT-like UIs on top of any Python code in minutes! Some of the key features include intermediary steps visualisation, element management & display (images, text, carousel, etc.) as well as cloud deployment.

Twitter CI

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
async def main(message: str):
    # this is an intermediate step
    await cl.Message(author="Tool 1", content=f"Response from tool1", indent=1).send()

    # send back the final answer
    await cl.Message(content=f"This is the final answer").send()

Now run it!

$ chainlit run demo.py -w

Quick Start

🔗 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.

Source Distribution

chainlit-0.4.0.tar.gz (737.2 kB view details)

Uploaded Source

Built Distribution

chainlit-0.4.0-py3-none-any.whl (748.0 kB view details)

Uploaded Python 3

File details

Details for the file chainlit-0.4.0.tar.gz.

File metadata

  • Download URL: chainlit-0.4.0.tar.gz
  • Upload date:
  • Size: 737.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for chainlit-0.4.0.tar.gz
Algorithm Hash digest
SHA256 faab5c431952a983b5ed3ec367e3fa5f37a527bd017e86f0672dc7bb445dd3b9
MD5 5973f206929c479e50dc1436665ec4c8
BLAKE2b-256 b49711203b76e5d8f1a4d02afffb3a9e7bdb5dd332470a14d8b85d08537e8589

See more details on using hashes here.

File details

Details for the file chainlit-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: chainlit-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 748.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for chainlit-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 12c904742efa1abb0eb499d8539557dbf83658759f137a1509f4b74139750faf
MD5 630e0a56673dd2bbfe6a314e321c0d16
BLAKE2b-256 771c5d039a7d2419a26730acb8dfa0078247c214d99859789d9cd8407016f0a4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page