aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorterminaldweller <devi@terminaldweller.com>2024-06-09 23:26:15 +0000
committerterminaldweller <devi@terminaldweller.com>2024-06-09 23:26:15 +0000
commit5f5ea88cf8a0d147c7ff1cc9332ebd1430ca78e8 (patch)
tree8be77fbf54a19a1b8116f534ee243473c3b23259 /README.md
parentupdated the example lua script in the readme (diff)
downloadmilla-5f5ea88cf8a0d147c7ff1cc9332ebd1430ca78e8.tar.gz
milla-5f5ea88cf8a0d147c7ff1cc9332ebd1430ca78e8.zip
fixes #33
Diffstat (limited to '')
-rw-r--r--README.md25
1 files changed, 13 insertions, 12 deletions
diff --git a/README.md b/README.md
index cbc3ff0..393ea5b 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,7 @@
Milla is an IRC bot that:
-- sends things over to an LLM when you ask it questions and prints the answer with optional syntax-highlighting.<br/>
- Currently supported providers:
-
-* Ollama
-* Openai
-* Gemini
-
+- sends things over to an LLM when you ask it questions and prints the answer with optional syntax-highlighting.Currently supported providers: Ollama, Openai, Gemini <br/>
- Milla can run more than one instance of itself
- Each instance can connect to a different ircd, and will get the full set of configs, e.g. different proxies, different postgres instance, ...
- You can define custom commands in the form of SQL queries to the database with the SQL query result being passed to the bot along with the given prompt and an optional limit so you don't go bankrupt(unless you are running ollama locally like the smart cookie that you are).<br/>
@@ -247,13 +241,20 @@ Custom commands let you define a command that does a SQL query to the database a
```toml
[ircd.devinet_terra.customCommands.digest]
-sql = "select log from liberanet_milla_us_market_news;"
-limit = 10
-prompt = "give me digest of the provided news"
+sql = "select log from liberanet_milla_us_market_news order by log desc;"
+limit = 300
+context = ["you are a sentiment-analysis bot"]
+prompt= "i have provided to you news headlines in the form of previous conversations between you and me using the user role. please provide the digest of the news for me."
[ircd.devinet_terra.customCommands.summarize]
-sql= "select log from liberanet_milla_us_market_news;"
+sql= "select log from liberanet_milla_us_market_news order by log desc;"
limit= 300
-prompt= "given all the data, summarize the news for me"
+context = ["you are a sentiment-analysis bot"]
+prompt= "i have provided to you news headlines in the form of previous conversations between you and me using the user role. please summarize the provided news for me. provide some details."
+[ircd.devinet_terra.customCommands.canada]
+sql= "select log from liberanet_milla_us_market_news order by log desc;"
+limit= 300
+context = ["you are a canadian news anchor", "you only care about news that is relevant to canada"]
+prompt= "i have provided to you news headlines in the form of previous conversations between you and me using the user role. please summarize the provided news for me. provide some details."
```
In the above example digest and summarize will be the names of the commands: `milla: /cmd summarize`.<br/>