momegas commited on
Commit
0eed37b
β€’
1 Parent(s): 4283a03

😎 Add features section

Browse files
Files changed (1) hide show
  1. README.md +10 -7
README.md CHANGED
@@ -25,13 +25,16 @@ bot.save_index("index.pickle")
25
  bot = QnABot(directory="./mydata", index="index.pickle")
26
  ```
27
 
28
- ### Future plans
29
-
30
- - [ ] Add support for other models
31
- - [ ] Add support for different prompts
32
- - [ ] Add support for other data sources
33
- - [ ] Add support for other vector databases
34
- - [ ] One line API expose
 
 
 
35
  - [ ] CLI / UI
36
 
37
  ### Here's how it works
 
25
  bot = QnABot(directory="./mydata", index="index.pickle")
26
  ```
27
 
28
+ ### Features
29
+
30
+ - [x] Create a question answering bot over your documents with one line of code using GPT
31
+ - [x] Save / load index to reduce costs (Open AI embedings are used to create the index)
32
+ - [x] Local data source (directory of documents) or S3 data source
33
+ - [x] FAISS for storing vectors / index
34
+ - [ ] Customise prompt
35
+ - [ ] Expose API
36
+ - [ ] Support for LLaMA model
37
+ - [ ] Support for Anthropic models
38
  - [ ] CLI / UI
39
 
40
  ### Here's how it works