diff --git a/README.md b/README.md index aaf8637b..98604747 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,49 @@ embedchain is a framework to easily create LLM powered bots over any dataset. If you want a javascript version, check out [embedchain-js](https://github.com/embedchain/embedchainjs) +# Table of Contents + +- [Latest Updates](#latest-updates) +- [What is embedchain?](#what-is-embedchain) +- [Getting Started](#getting-started) + - [Installation](#installation) + - [Usage](#usage) + - [App Types](#app-types) + - [1. App (uses OpenAI models, paid)](#1-app-uses-openai-models-paid) + - [2. OpenSourceApp (uses opensource models, free)](#2-opensourceapp-uses-opensource-models-free) + - [3. PersonApp (uses OpenAI models, paid)](#3-personapp-uses-openai-models-paid) + - [Add Dataset](#add-dataset) + - [Interface Types](#interface-types) + - [Query Interface](#query-interface) + - [Chat Interface](#chat-interface) + - [Format supported](#format-supported) + - [Youtube Video](#youtube-video) + - [PDF File](#pdf-file) + - [Web Page](#web-page) + - [Doc File](#doc-file) + - [Text](#text) + - [QnA Pair](#qna-pair) + - [Reusing a Vector DB](#reusing-a-vector-db) + - [More Formats coming soon](#more-formats-coming-soon) + - [Testing](#testing) +- [Advanced](#advanced) + - [Configuration](#configuration) + - [Example](#example) + - [Configs](#configs) + - [InitConfig](#initconfig) + - [Add Config](#add-config) + - [Query Config](#query-config) + - [Chat Config](#chat-config) + - [Other methods](#other-methods) + - [Reset](#reset) + - [Count](#count) +- [How does it work?](#how-does-it-work) +- [Tech Stack](#tech-stack) +- [Team](#team) + - [Author](#author) + - [Maintainer](#maintainer) + - [Citation](#citation) + # Latest Updates - Introduce a new interface called `chat`. It remembers the history (last 5 messages) and can be used to powerful stateful bots. You can use it by calling `.chat` on any app instance. Works for both OpenAI and OpenSourceApp.