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

This version

0.6.4

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

Uploaded Source

Built Distribution

chainlit-0.6.4-py3-none-any.whl (782.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chainlit-0.6.4.tar.gz
  • Upload date:
  • Size: 763.5 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.4.tar.gz
Algorithm Hash digest
SHA256 b8567f4ee6caf24d47ab586f2f1e29cba31dbbea347d16b241f3588686735c06
MD5 508e960a74a61e35ce977a6f8ed0aa12
BLAKE2b-256 fee8c02c4bdc043317b965df27b106166c28149f83db9f026c2274371dcd1dd0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chainlit-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 782.7 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e7d9c94ed0087f72e539b4491d17ef096f17d20914f62f47f40929886d0ad9dd
MD5 61b84cd44576fe69274370327cc7cdee
BLAKE2b-256 e7ea0079680d04286e125cb586081b0a7080d554d1da126dcb52e24d0be6439d

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