Skip to main content

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.

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

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.2.1.tar.gz (715.2 kB view details)

Uploaded Source

Built Distribution

chainlit-0.2.1-py3-none-any.whl (726.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chainlit-0.2.1.tar.gz
Algorithm Hash digest
SHA256 dc933a36668eb823585421f37af0db0c2f3b903a6107d476be433c7205272d02
MD5 0c779922662f30dfac8c8ecbf51f9167
BLAKE2b-256 092d7cff8295c910b829474982c3b497c431b63f6e5322a42a857a75456f41e2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for chainlit-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3b766589b7a6a6aae1eb8bb9f54e4c85b52987515b24ec569dc638f93382ef16
MD5 c5806d76e89953efb8773fa0a9be7c83
BLAKE2b-256 bb991256e7e6a17d6e7ce8d18e5ccb70825a546ce7c992f0c344e295766e212b

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