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.

Key features:

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.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 Tool 1, followed by the final answer.

    Args:
        message: The user's message.

    Returns:
        None.
    """

    # Send an intermediate response from Tool 1.
    await cl.Message(
        author="Tool 1",
        content=f"Response from tool1",
        parent_id=message.id,
    ).send()

    # Send the final answer.
    await cl.Message(content=f"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:

📚 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

  • Selectable chat profiles (at the beginning of a chat)
  • One click chat sharing
  • New clients:
    • Slack
    • Discord
    • Website embbed

Tell us what you would like to see added in Chainlit using the Github issues or on Discord.

🏢 Enterprise support

For entreprise grade features and self hosting, please visit this page and fill the form.

💁 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.7.603.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chainlit-0.7.603-py3-none-any.whl (2.2 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chainlit-0.7.603.tar.gz
Algorithm Hash digest
SHA256 bef2d8648733357a350039318512ba9e70c63bfeb613c3126c519aae8597f656
MD5 c63518cd5ec81b269f630f42ed7a5956
BLAKE2b-256 3bec110cd32e551b02d8048c948beef0a335d075458d409fe96de924966ef246

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for chainlit-0.7.603-py3-none-any.whl
Algorithm Hash digest
SHA256 07496063be7b7076bddd3639f996e4fa70ff0ec5ec613263b0ac56118621c96d
MD5 0a7e56ce68d89180f69b3944614c09c4
BLAKE2b-256 129d5add48f7b439b719c580bb6e29e9db2c95aa62c45802ac276488f5eebbfb

See more details on using hashes here.

Supported by

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