Skip to main content

A faster way to build chatbot UIs.

Project description

Welcome to Chainlit 👋

Twitter CI

Build a production ready Chat GPT like application in minutes ⚡️

Chainlit is an open-source async Python framework that makes it incredibly fast to build Chat GPT like applications with your own business logic and data.

Contact us here for Enterprise Support and to get early access to the Analytics & Observability product.

https://github.com/Chainlit/chainlit/assets/13104895/8882af90-fdfa-4b24-8200-1ee96c6c7490

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.step
def tool():
    return "Response from the tool!"


@cl.on_message  # this function will be called every time a user inputs a message in the UI
async def main(message: cl.Message):
    """
    This function is called every time a user inputs a message in the UI.
    It sends back an intermediate response from the tool, followed by the final answer.

    Args:
        message: The user's message.

    Returns:
        None.
    """

    # Call the tool
    tool()

    # Send the final answer.
    await cl.Message(content="This is the final answer").send()

Now run it!

$ chainlit run demo.py -w

Quick Start

🔗 Integrations

Chainlit is compatible with all Python programs and libraries. That being said, it comes with integrations for:

🎨 Custom Frontend

Chainlit allows you to create a custom frontend for your application, offering you the flexibility to design a unique user experience. By integrating your frontend with Chainlit's backend, you can harness the full power of Chainlit's features, including:

  • Abstractions for easier development
  • Monitoring and observability
  • Seamless integrations with various tools
  • Robust authentication mechanisms
  • Support for multi-user environments
  • Efficient data streaming capabilities

To build and connect your own frontend, check out our Custom Frontend Cookbook.

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

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-1.0.101.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

chainlit-1.0.101-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chainlit-1.0.101.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for chainlit-1.0.101.tar.gz
Algorithm Hash digest
SHA256 a81bed3a893a2907bcc446e864687fa5f83f9b8467f4a01e7fd064293b6f04c5
MD5 9931a8b873b89c15f228aa4a4be42b7d
BLAKE2b-256 ac5dfcc4d55ab423c9888c0ab818c41c4a4e6c8312fb9595940f7ca02de9b6f2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chainlit-1.0.101-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for chainlit-1.0.101-py3-none-any.whl
Algorithm Hash digest
SHA256 648aa2c7ab405b9c35aba5995295abd451c40fa00ecf0ad5734d27aa9da9fc90
MD5 be668fe4b1d3fc9fed1f2397229589fa
BLAKE2b-256 4814faac39dc35e86272ef4a7bfdcf75172b261a109b735315cf8e9431023b49

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