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

https://github.com/Chainlit/chainlit/assets/13104895/e347e52c-35b2-4c35-8a88-f8ac02dd198e

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

Check out our plug-and-play integration with LangChain!

📚 More Examples - Cookbook

You can find various examples of Chainlit apps here that leverage tools and services such as OpenAI, Anthropiс, LangChain, LlamaIndex, ChromaDB, Pinecone and more.

🛣 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.3.tar.gz (710.2 kB view details)

Uploaded Source

Built Distribution

chainlit-0.4.3-py3-none-any.whl (723.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chainlit-0.4.3.tar.gz
  • Upload date:
  • Size: 710.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.3.tar.gz
Algorithm Hash digest
SHA256 2545a9101e0f362b82a6e8eb6b1c73714d1fc446dc95073289f859dbd3ac8e81
MD5 9391f381740360a6c0ccc7f5199b388c
BLAKE2b-256 34c48c8ee516281877ce8337441867762b5f1a880919f300d682bca0e7c68404

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chainlit-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 723.8 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 430e65008ba5e04b5d25f84a9d4e91b46ac7e67246fc33ec4a08b571e3e61c55
MD5 0c168b67eb4bab02faf0156e37a61c61
BLAKE2b-256 3ddb0635cf9a7ca963de6bb6cba197fb825781d35b9499bd7c45a24daa8817ec

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