Minimalistic chatbot ui using fastapi, fastui and langchain.
Project description
fastui-chat
A minimalistic ChatBot Interface in pure python.
Build on top of FastUI and LangChain Core.
Usage
pip install fastui-chat
from fastui_chat import ChatUI
# chatui inherits from FastAPI so you can use it as a FastAPI app
app = ChatUI()
# Run with:
# uvicorn examples.minimal:app
# for hot reloading:
# uvicorn examples.minimal:app --reload
# or use the built-in method
if __name__ == "__main__":
app.start_with_uvicorn()
Extend FastAPI
You can also only use the router and extend your existing FastAPI app.
from fastapi import FastAPI
from fastui_chat import create_chat_handler, create_history_factory
from fastui_chat.chat import ChatAPIRouter
from fastui_chat.history import InMemoryChatMessageHistory
from fastui_chat.runtime import router as fastui_runtime
# callable that returns a ChatMessageHistory given a session_id
history_factory = create_history_factory(
# swap out with any from langchain_community.chat_message_histories
InMemoryChatMessageHistory,
)
# a chat handler generates an AIMessage based on a given HumanMessage and ChatHistory
chat_handler = create_chat_handler(
llm="openai/gpt-4-turbo-preview",
history_factory=history_factory,
)
# setup your fastapi app
app = FastAPI()
# add the chatui router to your app
app.include_router(
ChatAPIRouter(history_factory, chat_handler),
prefix="/api",
)
# make sure to add the runtime router as latest since it has a catch-all route
app.include_router(fastui_runtime)
# start the server with `uvicorn examples.fastapi_router:app`
Features
- Python Only
- Easy to use
- Minimalistic & Lightweight
- LangChain Compatible
- FastAPI Compatible
- Parallel Chat Sessions
- Switchable ChatHistory Backends
- Insert your custom chat handler
Development Setup
git clone https://github.com/shroominic/fastui-chat.git && cd fastui-chat
./dev-install.sh
Roadmap
If you want to contribute or see whats coming soon checkout the roadmap.todo
file for open todos.
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
fastui_chat-0.3.2.tar.gz
(7.9 kB
view hashes)
Built Distribution
Close
Hashes for fastui_chat-0.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e894f4d61b9c030f38b8c409db05ffeb2e70e788f67d5765ea12c2d50e9452c0 |
|
MD5 | f4011753980790feeb687a86a07fd16e |
|
BLAKE2b-256 | 50d7f861644b4e373c452055fb95649e75b0711810b72ffdad6473b9969b1c64 |