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.

  • ✅ ChatGPT-like application
  • ✅ Embedded Chatbot & Software Copilot
  • ✅ Slack & Discord
  • ✅ Custom frontend (build your own agentic experience)
  • ✅ API Endpoint

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

[!NOTE]
Check out Literal AI, our product to monitor and evaluate LLM applications! It works with any Python or TypeScript applications and seamlessly with Chainlit by adding a LITERAL_API_KEY in your project.

Chainlit is developed and maintained by the Literal AI team, which is currently focused on expanding the capabilities of Literal AI. While we continue to support and maintain Chainlit, we are also committed to enabling the community to contribute, particularly in areas like integrations and data layers.

Chainlit user interface

Installation

Open a terminal and run:

pip install chainlit
chainlit hello

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

🚀 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

🎉 Key Features and Integrations

Full documentation is available here. Key features:

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.

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

Uploaded Source

Built Distribution

chainlit-1.3.0-py3-none-any.whl (4.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chainlit-1.3.0.tar.gz
  • Upload date:
  • Size: 4.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for chainlit-1.3.0.tar.gz
Algorithm Hash digest
SHA256 d45d1b92ff3632eae6ba59e246fc5ade660d26a1bbc71a61a2c136bcad8b86ff
MD5 e5a3a633a4228e9450180e9c8f05f9af
BLAKE2b-256 b4cd949b57415ca76240bcaa7d30e382faebdd6a820ca962dcc4fd370cdc8d1e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chainlit-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for chainlit-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f16d869e730a6fc560e31ad100775f705296b22e5303fcf82a4505fc1d1204fd
MD5 c8e21f11d56ce6e9d27338643408eaa9
BLAKE2b-256 7f4c4998d270b624ab2e86c71a5aedc5ea6dbbe0ec5a60b1459964b9bdb066b2

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