Summarise articles with ease.
This is my first nodejs & typescript project, which means there can be many unhealthy typescript codes. Thus, be cautious to potential bugs.

I won't release until the codebase is ready.

You should have nodejs installed.

git clone https://github.com/iceBear67/patchouli-bot
cd patchouli-bot
npm install
npm run bot

For the first run, the bot will generate a config.toml file where you can adjust some parameters.
At least the botToken,modelConfig.accessToken, which you can get from @botfather and the provider of backend, should be provided.

Patchouli supports channel posts and general messages (group & DM).

If there are messages that are tagged with hashtagTriggers or replied with /summary, patchouli will try to fetch the first URL it sees in the message and start generating the summary.

By the way, patchouli doesn't handle concurrent requests very well at the moment, so you should be aware of the possible request flooding.

# The token you can get from @botfather
botToken = ""
# only sqlite is supported at this moment.
databasePath = "./data.db"
hashtagTriggers = ["#summary"]
# Should we give up when !=200 is returned from websites
ignoreAbnormalStatusCode = true
# This decides which API client will be used.
# Actually you can use openai's endpoint with `huggingface` as your backend.
backend = "huggingface" # "huggingface" or "openai"
# This matters only if you're using huggingface as backend.
# For example, some models supports summary only while others support text-generation only.
# OpenAI backend ignores this.
mode = "summary" # or "textgen". 
trustedChats = [0] # chatId

[cacheConfig]
# set 0 to disable TTL
summaryCacheTTL = 300

[modelConfig]
accessToken = "your access token to huggingface or openai"
# model name
model = "Shobhank-iiitdwd/Distil_BERT_summary"
endpointUrl = "openai endpoint. can be empty or commented out"
prompt = "Edit your prompt in `prompt.txt`, not this field"

1. summary [url] url is not required if you're using replying feature.
2. invalidate <pattern> invalidate cached summaries in the database cache.
3. id reveals current chat id.

There are currently no permissions to prevent these commands from being abused.