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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fp_chainlit_ui-0.7.1.tar.gz (953.6 kB view details)

Uploaded Source

Built Distribution

fp_chainlit_ui-0.7.1-py3-none-any.whl (972.5 kB view details)

Uploaded Python 3

File details

Details for the file fp_chainlit_ui-0.7.1.tar.gz.

File metadata

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

File hashes

Hashes for fp_chainlit_ui-0.7.1.tar.gz
Algorithm Hash digest
SHA256 bab86b3571e2ffb3d9e59150d2096128d2e1560c5b7c0ee38e8e40bbf9a6e683
MD5 1f371559064e10c531c9a2e306b09e6d
BLAKE2b-256 2007912a5f17a2a97d056deaa9710c08829b68901785381eeffef4a637102cb6

See more details on using hashes here.

File details

Details for the file fp_chainlit_ui-0.7.1-py3-none-any.whl.

File metadata

File hashes

Hashes for fp_chainlit_ui-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2e8e99624f8ac1ea58b1a6495abde107775c1c03c4260ed2d847cb6d34f5b2b9
MD5 b5e4aab8f4734c0e0e956d15bcf0e12f
BLAKE2b-256 c6e8c07fdc228ff268dff932a889dc6e89fe801b27473bf5b802c27d5ed30898

See more details on using hashes here.

Supported by

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