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]
Contact us here for Enterprise Support. 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.

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

    final_answer = await cl.Message(content="").send()

    # Call the tool
    final_answer.content = await tool()

    await final_answer.update()

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.1.300rc2.tar.gz (4.2 MB view details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

Details for the file chainlit-1.1.300rc2.tar.gz.

File metadata

  • Download URL: chainlit-1.1.300rc2.tar.gz
  • Upload date:
  • Size: 4.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for chainlit-1.1.300rc2.tar.gz
Algorithm Hash digest
SHA256 be56202a3249f7d09fc729eacaae7233b723dd4bb9db2f1349a00a1873494344
MD5 a30bf26bd1e388d4e1bb47ad347e97d0
BLAKE2b-256 c6762deaa159c09925b6085509aecb72e241678f2072522aa3e468f1f3c721c8

See more details on using hashes here.

File details

Details for the file chainlit-1.1.300rc2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for chainlit-1.1.300rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 b8c2b66c9b1714c241c2b548fb15d269deff1f3f8469a93a369a7f1b962ceb86
MD5 c9fd9be84852b2b74f1ee02023eeeff7
BLAKE2b-256 8887edea295e97027702ae48d17770fedee6b2598ee0ecc043c3cb9ba81ecb25

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