# Chatformers

⚡ Chatformers is a Python package designed to simplify the development of chatbot applications that use Large Language Models (LLMs). It offers automatic chat history management using a local vector database (ChromaDB), ensuring efficient context retrieval for ongoing conversations.

## Install

```
pip install chatformers
```

Pypi: [https://pypi.org/project/chatformers](https://pypi.org/project/chatformers/)

Github: <https://github.com/Dipeshpal/chatformers><br>

<mark style="color:orange;">**NOTE:**</mark> If you are using `chatformers<=1.0.3` then refer to FAQ and Usage in [Example v<=1.0.3](https://viznetai.gitbook.io/chatformers/example-v-less-than-1.0.3)

This version will be depreciated in the future. Always use lastest docs.

## Why Choose chatformers?

1. Effortless History Management: You do not need to manage extensive chat history manually; the package automatically handles it.
2. Simple Integration: Build a chatbot with just a few lines of code.
3. Full Customization: Maintain complete control over your data and conversations.
4. Framework Compatibility: Easily integrate with any existing framework or codebase.

## Key Features

1. Easy Chatbot Creation: Set up a chatbot with minimal code.
2. Automated History Management: Automatically stores and fetches chat history for context-aware conversations.

## How It Works

1. Project Setup: Create a basic project structure.
2. Automatic Storage: Chatformers store your conversations (user inputs and AI outputs) in Chroma DB, Qdrant or Pgvector.
3. Contextual Conversations: The chatbot fetches relevant chat history whenever you engage with the LLM.

## Prerequisites-

1. Python: Ensure Python is installed on your system.
2. GenAI Knowledge: Familiarity with Generative AI models.