Skip to content

Latest commit

 

History

History
69 lines (37 loc) · 3.64 KB

README.md

File metadata and controls

69 lines (37 loc) · 3.64 KB
Raw

Summary Bot

Summary Bot - AI Talk chat summarize bot

Summary Bot is an innovative chat bot designed to enhance communication efficiency within the Nextcloud platform. This bot integrates seamlessly with Nextcloud's chat feature, providing users with concise summaries of their conversations.

Ideal for busy professionals or teams who deal with high volumes of messages, the bot uses advanced natural language processing techniques to analyze chat threads and extract the key points.

This ensures that users can quickly grasp the essence of discussions without reading through every message, saving time and improving productivity. The bot is configurable, allowing on-demand and scheduled summaries to be executed.

It can run on only open source or proprietory models either on-premises or in the cloud leveraging apps like Local large language model app or OpenAI and LocalAI integration app.

For more information, refer to the admin documentation.

How To Install

  1. Install AppAPI
  2. Create a deployment daemon according to the instructions of the AppPI
  3. Install the Summary Bot

One-Click Install

  1. Go to the External Apps page and click "Deploy and Enable" for "Summary Bot"

Manual Install

  1. Run the docker image: You can choose if you run the provided docker image from the registry server or if you build it locally yourself

3.1.1 Run the docker image provided by the registry server

sudo docker run -ti -v /etc/localtime:/etc/localtime:ro -v /etc/timezone:/etc/timezone:ro -e APP_ID=summary_bot -e APP_DISPLAY_NAME="Summary Bot" -e APP_HOST=0.0.0.0 -e APP_PORT=9031 -e APP_SECRET=12345 -e APP_VERSION=<APP_VERSION> -e NEXTCLOUD_URL='<YOUR_NEXTCLOUD_URL_REACHABLE_FROM_INSIDE_DOCKER>' -p 9031:9031 ghcr.io/nextcloud/summary_bot:latest

3.2.1 OR: Build the docker image locally

Example assuming you are in the source directory of the cloned repository

docker build --no-cache -f Dockerfile -t ghcr.io/nextcloud/summary_bot:latest .

Deploy the docker image with Bot to docker.

Example assuming you are in the source directory of the cloned repository

sudo docker run -ti -v /etc/localtime:/etc/localtime:ro -v /etc/timezone:/etc/timezone:ro -e APP_ID=summary_bot -e APP_DISPLAY_NAME="Summary Bot" -e APP_HOST=0.0.0.0 -e APP_PORT=9031 -e APP_SECRET=12345 -e APP_VERSION=<APP_VERSION> -e NEXTCLOUD_URL='<YOUR_NEXTCLOUD_URL_REACHABLE_FROM_INSIDE_DOCKER>' -p 9031:9031 ghcr.io/nextcloud/summary_bot:latest
  1. Register the Summary Bot

(Hint: In both cases, registering manually or via makefile, adjust the json dictionary that it fits your environment/needs)

Register manually:

Example assuming you are in the source directory of your nextcloud instance where occ is located and the default user www-data got execution rights on occ

Unregistering Summary Bot

sudo -u www-data php ./occ app_api:app:unregister summary_bot

Registering Summary Bot:

sudo -u www-data php ./occ app_api:app:register summary_bot manual_install --json-info '{ "id": "summary_bot", "name": "Summary Bot", "daemon_config_name": "manual_install", "version": "<APP_VERSION>", "secret": "12345", "host": "192.168.0.199", "port": 9031, "scopes": ["AI_PROVIDERS", "TALK", "TALK_BOT"], "protocol": "http"}' --force-scopes --wait-finish

OR

Register via Makefile:

Example assuming you are in the source directory of the cloned repository

make register_local