Skip to main content

A small example package

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
  • ✅ Custom frontend (build your own agentic experience)
  • ✅ API Endpoint

Full documentation is available here.

Contact us here for Enterprise Support and to get early access to Literal AI, our product to evaluate and monitor LLM applications.

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

example-pkg-Apocrypha-0.0.1.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

example_pkg_Apocrypha-0.0.1-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file example-pkg-Apocrypha-0.0.1.tar.gz.

File metadata

  • Download URL: example-pkg-Apocrypha-0.0.1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for example-pkg-Apocrypha-0.0.1.tar.gz
Algorithm Hash digest
SHA256 daaf9fbecd06d6ade821e80375efe397826261e4f2e27bb61e53dc798b5b74b4
MD5 9c6fce69ff99f3cdb64e9502eabb8fe8
BLAKE2b-256 baff8ad9ce97ffaa04c72710701e5ea17bdc53112da20bfe1f25cb306abf4c2b

See more details on using hashes here.

File details

Details for the file example_pkg_Apocrypha-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for example_pkg_Apocrypha-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 334b6041aa7f34986997002fbf6f4dc377245a4f4bfc0a041d45ff0c529c5ecb
MD5 71018c311ed62d1f80a94334c9502fa0
BLAKE2b-256 9617397aacc4130b293175262cf259563a9c35e055126f44337f0eb29ff14422

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