Skip to main content

Build Conversational AI.

Project description

Welcome to Chainlit by Literal AI 👋

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

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!

🚀 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

🎉 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.300rc0.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.300rc0-py3-none-any.whl (4.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chainlit-1.1.300rc0.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.300rc0.tar.gz
Algorithm Hash digest
SHA256 5dbefb8c9408c2893b2fbefc3fd770173e720f0520adaf2e38f5892568c3430b
MD5 7b8bc0bdb668b1473556083d86363c4a
BLAKE2b-256 6e60f6c52eabac9eb1f2f9b8028146ab8573dee33b0bc0900839e76a2c0dec5a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chainlit-1.1.300rc0-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.300rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 ace0ce730297aa1be14afa12b72d3433aa5bdeb22776823f86145db023959b96
MD5 dfa6e364e5291612e01b99705648a4f2
BLAKE2b-256 319ee58d9c0aaa45c0cd25300733364059f3b2ad2091c873f9c80fb72d788f6a

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