Skip to main content

Build Conversational AI.

Project description

Welcome to Chainlit by Literal AI 👋

Twitter PyPI - Downloads GitHub Contributors CI

Build production-ready Conversational AI applications in minutes, not weeks ⚡️

Chainlit is an open-source async Python framework which allows developers to build scalable Conversational AI or agentic applications.

Full documentation is available here. You can ask Chainlit related questions to Chainlit Help, an app built using Chainlit!

https://github.com/user-attachments/assets/b3738aba-55c0-42fa-ac00-6efd1ee0d148

Installation

Open a terminal and run:

pip install chainlit
chainlit hello

If this opens the hello app in your browser, you're all set!

Development version

The latest in-development version can be installed straight from GitHub with:

pip install git+https://github.com/Chainlit/chainlit.git#subdirectory=backend/

(Requires Node and pnpm installed on the system.)

🚀 Quickstart

🐍 Pure Python

Create a new file demo.py with the following code:

import chainlit as cl


@cl.step(type="tool")
async def tool():
    # Fake tool
    await cl.sleep(2)
    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_res = await tool()

    await cl.Message(content=tool_res).send()

Now run it!

chainlit run demo.py -w

Quick Start

📚 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-2.0.2.tar.gz (4.6 MB view details)

Uploaded Source

Built Distribution

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

chainlit-2.0.2-py3-none-any.whl (4.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chainlit-2.0.2.tar.gz
  • Upload date:
  • Size: 4.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for chainlit-2.0.2.tar.gz
Algorithm Hash digest
SHA256 ec60a83884029dfa9e2f8215a81d99627c465407ac33ef37b19c7d515d9c0e7a
MD5 f9866eec3f91c3d34170effba5fcff57
BLAKE2b-256 4233c9a2060f499ef2c196405f80be9e03fa212e56307e0345fffacc5641fb03

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chainlit-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for chainlit-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 58fe3da65e892058a8e8ad97bb9dc4177173857d8c288a3de4a73271fc1b18be
MD5 a7d3590cef6cdcbe7019ddd1312b323a
BLAKE2b-256 72e4563dbf1bc21dcda915d15ea27d739a8afff5ee861f40bc4adb67c33c56cd

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