momegas commited on
Commit
51eee05
β€’
1 Parent(s): 507e0ff

πŸ€— Update readme

Browse files
Files changed (1) hide show
  1. README.md +18 -0
README.md CHANGED
@@ -12,9 +12,27 @@ import os
12
 
13
  os.environ["OPENAI_API_KEY"] = "my key"
14
 
 
15
  bot = QnABot(directory="./mydata")
 
 
 
 
 
 
 
 
 
16
  ```
17
 
 
 
 
 
 
 
 
 
18
  ### Here's how it works
19
 
20
  High level overview what is happening under the hood:
 
12
 
13
  os.environ["OPENAI_API_KEY"] = "my key"
14
 
15
+ # Create a bot
16
  bot = QnABot(directory="./mydata")
17
+
18
+ # Ask a question
19
+ answer = bot.ask("How do I use this bot?")
20
+
21
+ # Save the index to save costs (GPT is used to create the index)
22
+ bot.save_index("index.pickle")
23
+
24
+ # Load the index from a previous run
25
+ bot = QnABot(directory="./mydata", index="index.pickle")
26
  ```
27
 
28
+ ### Future plans
29
+
30
+ - [ ] Add support for other models
31
+ - [ ] Add support for other data sources
32
+ - [ ] Add support for other vector databases
33
+ - [ ] One line API expose
34
+ - [ ] CLI / UI
35
+
36
  ### Here's how it works
37
 
38
  High level overview what is happening under the hood: