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

Uploaded Source

Built Distribution

chainlit-0.6.402-py3-none-any.whl (782.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chainlit-0.6.402.tar.gz
  • Upload date:
  • Size: 764.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for chainlit-0.6.402.tar.gz
Algorithm Hash digest
SHA256 282896910d5d3a8625572dbc4fe1c9651a9bd243b9f4df710d457d806c9ca2e6
MD5 907e5d24efde914b0c30f0b43c107fc9
BLAKE2b-256 2ef447fded996e7add2529348483a4e6277da0c850de137c56f07256eeabda0b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chainlit-0.6.402-py3-none-any.whl
  • Upload date:
  • Size: 782.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for chainlit-0.6.402-py3-none-any.whl
Algorithm Hash digest
SHA256 1f3a29d3832fcac7e83135bea6884b3091bf4be96e3c5ef1dc283e47e60a798e
MD5 391f76f3320de099a6ffd3f47af8bfc6
BLAKE2b-256 8f5636a6ed8ffee75da5afcbd9608e279d0a5c1f8f9563aa3e7e577d396357ab

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