https://github.com/Chainlit/chainlit
Build Conversational AI in minutes ⚡️
https://github.com/Chainlit/chainlit
chatgpt langchain llm openai openai-chatgpt python ui
Last synced: 21 days ago
JSON representation
Build Conversational AI in minutes ⚡️
- Host: GitHub
- URL: https://github.com/Chainlit/chainlit
- Owner: Chainlit
- License: apache-2.0
- Created: 2023-03-14T16:54:04.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T12:38:06.000Z (6 months ago)
- Last Synced: 2024-10-29T15:03:56.261Z (6 months ago)
- Topics: chatgpt, langchain, llm, openai, openai-chatgpt, python, ui
- Language: Python
- Homepage: https://docs.chainlit.io
- Size: 5.95 MB
- Stars: 7,081
- Watchers: 53
- Forks: 928
- Open Issues: 282
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - Chainlit/chainlit - Build Conversational AI in minutes ⚡️ (TypeScript)
- awesome-genai - ChainLit
- awesome-langchain-zh - Chainlit
- StarryDivineSky - Chainlit/chainlit
- awesome-langchain - Chainlit
- awesome-chatgpt - Chainlit/chainlit - Build Python LLM apps in minutes ⚡️ (SDK, Libraries, Frameworks / Python)
- awesome-rainmana - Chainlit/chainlit - Build Conversational AI in minutes ⚡️ (TypeScript)
- awesome-llm-and-aigc - Chainlit - like UIs on top of any Python code in minutes! [docs.chainlit.io](https://docs.chainlit.io/overview) (Applications / 提示语(魔法))
- AiTreasureBox - Chainlit/chainlit - 04-07_9161_8](https://img.shields.io/github/stars/Chainlit/chainlit.svg)|Build Conversational AI in minutes ⚡️| (Repos)
README
Welcome to Chainlit by Literal AI 👋
Build python production-ready conversational AI applications in minutes, not weeks ⚡️
Website •
Documentation •
Chainlit Help •
Cookbookhttps://github.com/user-attachments/assets/b3738aba-55c0-42fa-ac00-6efd1ee0d148
## Installation
Open a terminal and run:
```sh
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:
```sh
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:
```python
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!
```sh
chainlit run demo.py -w
```
## 📚 More Examples - Cookbook
You can find various examples of Chainlit apps [here](https://github.com/Chainlit/cookbook) 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](https://discord.gg/k73SQ3FyUh).
## 💁 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](/CONTRIBUTING.md).
## 📃 License
Chainlit is open-source and licensed under the [Apache 2.0](LICENSE) license.