Summary Command (#194)

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,10 +8,10 @@ assignees: ''
 ---
 
 ## Issue
-A clear and concise description of what the problem/feature is.
+A clear and concise description of what the problem/feature is. PLease describe it as best as possible.
 
 ## Solution
-* Provide steps or ideals to how to implement or investigate this new feature.
+* Provide steps or ideas to how to implement or investigate this new feature.
 
 ## References
 * Provide additional context and external references here

.github/workflows/deploy.yml

@@ -1,9 +1,10 @@
 name: Deploy
 run-name: Deploy Application Latest
-on:
+# on:
-  push:
+#   push:
-    tags:
+#     tags:
-      - 'v*'
+#       - 'v*'
+on: workflow_dispatch
 
 jobs:
   Deploy-Application:

README.md

@@ -4,9 +4,9 @@
     <h3><a href="#"></a>Ollama as your Discord AI Assistant</h3>
     <p><a href="#"></a><a href="https://creativecommons.org/licenses/by/4.0/"><img alt="License" src="https://img.shields.io/badge/License-CC_BY_4.0-darkgreen.svg" /></a>
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/releases/latest"><img alt="Release" src="https://img.shields.io/github/v/release/kevinthedang/discord-ollama?logo=github" /></a>
-    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml"><img alt="Build Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml/badge.svg" /></a>
+    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml"><img alt="Builds" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml/badge.svg" /></a>
-    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml"><img alt="Deploy Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml/badge.svg" /></a>
+    <!-- <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml"><img alt="Deploy Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml/badge.svg" /></a> -->
-    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml"><img alt="Testing Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml/badge.svg" /></a>
+    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml"><img alt="Tests" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml/badge.svg" /></a>
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/coverage.yml"><img alt="Code Coverage" src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/kevinthedang/bc7b5dcfa16561ab02bb3df67a99b22d/raw/coverage.json"></a>
 </div>
 
@@ -18,7 +18,7 @@ The project aims to:
   * [x] Message Persistance
   * [x] Containerization with Docker
   * [x] Slash Commands Compatible
-    * [ ] Summary Command
+    * [x] Summary Command
     * [ ] Model Info Command
     * [ ] List Models Command
     * [x] Pull Model Command

docker-compose.yml

@@ -7,7 +7,7 @@ services:
     build: ./                     # find docker file in designated path
     container_name: discord
     restart: always               # rebuild container always
-    image: kevinthedang/discord-ollama:0.8.6
+    image: kevinthedang/discord-ollama:0.9.0
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
       OLLAMA_IP: ${OLLAMA_IP}

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "discord-ollama",
-  "version": "0.8.5",
+  "version": "0.9.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "discord-ollama",
-      "version": "0.8.5",
+      "version": "0.9.0",
       "license": "ISC",
       "dependencies": {
         "discord.js": "^14.20.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-ollama",
-  "version": "0.8.6",
+  "version": "0.9.0",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",

src/client.ts

@@ -1,6 +1,6 @@
 import { Client, GatewayIntentBits } from 'discord.js'
 import { Ollama } from 'ollama'
-import { Queue } from './components/index.js'
+import { Queue } from './queues/queue.js'
 import { UserMessage, registerEvents } from './utils/index.js'
 import Events from './events/index.js'
 import Keys from './keys.js'
@@ -23,8 +23,11 @@ export const ollama = new Ollama({
 // Create Queue managed by Events
 const messageHistory: Queue<UserMessage> = new Queue<UserMessage>
 
+// Create Channel History Queue managed by Events
+const channelMessageHistory: Queue<UserMessage> = new Queue<UserMessage>
+
 // register all events
-registerEvents(client, Events, messageHistory, ollama, Keys.defaultModel)
+registerEvents(client, Events, messageHistory, channelMessageHistory, ollama, Keys.defaultModel)
 
 // Try to log in the client
 await client.login(Keys.clientToken)

src/commands/index.ts

@@ -9,6 +9,7 @@ import { ClearUserChannelHistory } from './cleanUserChannelHistory.js'
 import { PullModel } from './pullModel.js'
 import { SwitchModel } from './switchModel.js'
 import { DeleteModel } from './deleteModel.js'
+import { Summary } from './summary.js'
 
 export default [
     ThreadCreate,
@@ -20,5 +21,6 @@ export default [
     ClearUserChannelHistory,
     PullModel,
     SwitchModel,
-    DeleteModel
+    DeleteModel,
+    Summary
 ] as SlashCommand[]

src/commands/summary.ts

@@ -0,0 +1,50 @@
+import { Client, CommandInteraction, Message, MessageFlags, SendableChannels } from "discord.js";
+import { accessChannelContext, normalMessage, SlashCommand, summarizeContextHistory, UserCommand, UserMessage } from "../utils/index.js";
+import { ollama } from "../client.js"
+
+export const Summary: SlashCommand = {
+    name: 'summary',
+    description: 'provides a summary of the chat history.',
+
+    // Generate Summary from additional context
+    run: async (client: Client, interaction: CommandInteraction) => {
+        // fetch channel
+        const channel = await client.channels.fetch(interaction.channelId)
+        if (!channel || !UserCommand.includes(channel.type)) return
+
+        // Defer
+        await interaction.deferReply({ flags: MessageFlags.Ephemeral })
+
+        // create summary using context
+        let channelContext: UserMessage[] = await new Promise((resolve) => {
+            accessChannelContext(interaction.channelId, (additionalContext) => {
+                if (additionalContext?.messages)
+                    resolve(additionalContext.messages)
+                else 
+                    resolve([])
+            })
+        })
+
+        if (channelContext.length === 0) {
+            interaction.reply({
+                content: `There are no recent chat messages in this channel.`,
+                flags: MessageFlags.Ephemeral
+            })
+            return
+        }
+
+        // Push summarize prompt
+        channelContext.push({
+            role: "user",
+            content: "Please Summarize everything from the prior messages, provide in bullet point fashion on what people have said prior. For example: \"Someone mentioned/talked about ...\"",
+            images: []
+        })
+
+        // todo: instead of a default of codellama, we can user default model somehow. Look into later.
+        const response: string = await summarizeContextHistory(ollama, "codellama", channelContext)
+
+        console.log(response)
+
+        interaction.editReply({ content: response })
+    }
+}

src/components/binder.ts

@@ -1,46 +0,0 @@
-
-/**
- * @class Logger
- * @description A class to handle logging messages
- * @method log
- */
-export class Logger {
-    private logPrefix: string = ''
-    private type: string = 'log'
-
-    private constructPrefix(component?: string, method?: string): string {
-        let prefix = this.type.toUpperCase()
-
-        if (component) {
-            prefix += ` [${component}`
-            if (method) prefix += `: ${method}`
-            prefix += ']'
-        }
-
-        return prefix
-    }
-
-    public bind(component?: string, method?: string): CallableFunction {
-        let tempPrefix = this.constructPrefix(component, method)
-
-        if (tempPrefix !== this.logPrefix) this.logPrefix = tempPrefix
-
-        switch (this.type) {
-            case 'warn':
-                return console.warn.bind(console, this.logPrefix)
-            case 'error':
-                return console.error.bind(console, this.logPrefix)
-            case 'log':
-            default:
-                return console.log.bind(console, this.logPrefix)
-        }
-    }
-
-    public log(type: string, message: unknown, component?: string, method?: string): void {
-        if (type && type !== this.type) this.type = type
-
-        let log = this.bind(component, method)
-
-        log(message)
-    }
-}

src/components/index.ts

@@ -1,2 +0,0 @@
-export * from './queue.js'
-export * from './binder.js'

src/events/messageCreate.ts

@@ -1,6 +1,6 @@
 import { TextChannel } from 'discord.js'
+import { event, Events, normalMessage, UserMessage, clean, addToChannelContext } from '../utils/index.js'
 import {
-    event, Events, normalMessage, UserMessage, clean,
     getChannelInfo, getServerConfig, getUserConfig, openChannelInfo,
     openConfig, UserConfig, getAttachmentData, getTextFileAttachmentData
 } from '../utils/index.js'
@@ -11,7 +11,7 @@ import {
  * 
  * @param message the message received from the channel
  */
-export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client, defaultModel }, message) => {
+export default event(Events.MessageCreate, async ({ log, msgHist, channelHistory, ollama, client, defaultModel }, message) => {
     const clientId = client.user!!.id
     let cleanedMessage = clean(message.content, clientId)
     log(`Message \"${cleanedMessage}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
@@ -19,6 +19,61 @@ export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client
     // Do not respond if bot talks in the chat
     if (message.author.username === message.client.user.username) return
 
+    // Save User Chat even if not for the bot
+    let channelContextHistory: UserMessage[] = await new Promise((resolve) => {
+        getChannelInfo(`${message.channelId}-context.json`, (channelInfo) => {
+            if (channelInfo?.messages)
+                resolve(channelInfo.messages)
+            else {
+                log(`Channel/Thread ${message.channel}-context does not exist. File will be created shortly...`)
+                resolve([])
+            }
+        })
+    })
+
+    if (channelContextHistory.length === 0) {
+        channelContextHistory = await new Promise((resolve) => {
+            addToChannelContext(message.channelId,
+                message.channel as TextChannel
+            )
+            getChannelInfo(`${message.channelId}-context.json`, (channelInfo) => {
+                if (channelInfo?.messages)
+                    resolve(channelInfo.messages)
+                else {
+                    log(`Channel/Thread ${message.channel}-context does not exist. File will be created shortly...`)
+                }
+            })
+        })
+    }
+
+    // Set Channel History Queue
+    channelHistory.setQueue(channelContextHistory)
+
+    // get message attachment if exists
+    const attachment = message.attachments.first()
+    let messageAttachment: string[] = []
+
+    if (attachment && attachment.name?.endsWith(".txt"))
+        cleanedMessage += ' ' + await getTextFileAttachmentData(attachment)
+    else if (attachment)
+        messageAttachment = await getAttachmentData(attachment)
+
+    while (channelHistory.size() >= channelHistory.capacity) channelHistory.dequeue()
+
+    // push user response to channel history
+    console.log
+    channelHistory.enqueue({
+        role: 'user',
+        content: cleanedMessage,
+        images: messageAttachment || []
+    })
+
+    // Store in Channel Context
+    addToChannelContext(message.channelId,
+        message.channel as TextChannel,
+        channelHistory.getItems()
+    )
+
     // Only respond if message mentions the bot
     if (!message.mentions.has(clientId)) return
 
@@ -139,15 +194,6 @@ export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client
         if (!userConfig)
             throw new Error(`Failed to initialize User Preference for **${message.author.username}**.\n\nIt's likely you do not have a model set. Please use the \`switch-model\` command to do that.`)
 
-        // get message attachment if exists
-        const attachment = message.attachments.first()
-        let messageAttachment: string[] = []
-
-        if (attachment && attachment.name?.endsWith(".txt"))
-            cleanedMessage += await getTextFileAttachmentData(attachment)
-        else if (attachment)
-            messageAttachment = await getAttachmentData(attachment)
-
         const model: string = userConfig.options['switch-model']
 
         // set up new queue

src/utils/events.ts

@@ -1,6 +1,6 @@
 import type { ClientEvents, Awaitable, Client } from 'discord.js'
 import { Ollama } from 'ollama'
-import { Queue } from '../components/index.js'
+import { Queue } from '../queues/queue.js'
 
 // Export events through here to reduce amount of imports
 export { Events } from 'discord.js'
@@ -37,6 +37,7 @@ export interface EventProps {
     client: Client,
     log: LogMethod,
     msgHist: Queue<UserMessage>,
+    channelHistory: Queue<UserMessage>,
     ollama: Ollama,
     defaultModel: String
 }
@@ -78,6 +79,7 @@ export function registerEvents(
     client: Client,
     events: Event[],
     msgHist: Queue<UserMessage>,
+    channelHistory: Queue<UserMessage>,
     ollama: Ollama,
     defaultModel: String
 ): void {
@@ -88,7 +90,7 @@ export function registerEvents(
 
             // Handle Errors, call callback, log errors as needed
             try {
-                callback({ client, log, msgHist, ollama, defaultModel }, ...args)
+                callback({ client, log, msgHist, channelHistory, ollama, defaultModel }, ...args)
             } catch (error) {
                 log('[Uncaught Error]', error)
             }

src/utils/handlers/chatHistoryHandler.ts

@@ -56,6 +56,54 @@ export async function clearChannelInfo(filename: string, channel: TextChannel, u
     return cleanedHistory
 }
 
+export async function addToChannelContext(filename: string, channel : TextChannel | ThreadChannel, messages: UserMessage[] = []): Promise<void> {
+    const fullFileName = `data/${filename}-context.json`
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
+            if (error)
+                console.log(`[Error: addToChannelContext] Incorrect file format`)
+            else {
+                const object = JSON.parse(data)
+                if (object['messages'].length === 0)
+                    object['messages'] = messages as []
+                else if (object['messages'].length !== 0 && messages.length !== 0)
+                    object['messages'] = messages as []
+                fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
+            }
+        })
+    } else { // channel context does not exist, create it
+        const object: Configuration = JSON.parse(
+            `{ 
+                \"id\": \"${channel?.id}\", 
+                \"name\": \"${channel?.name}\", 
+                \"messages\": []
+            }`
+        )
+
+        const directory = path.dirname(fullFileName)
+        if (!fs.existsSync(directory))
+            fs.mkdirSync(directory, { recursive: true })
+
+        fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
+        console.log(`[Util: addToChannelContext] Created '${fullFileName}' in working directory`)
+    }
+}
+
+export async function accessChannelContext(filename: string, callback: (config: Channel | undefined) => void): Promise<void> {
+    const fullFileName = `data/${filename}-context.json`
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
+            if (error) {
+                callback(undefined)
+                return // something went wrong... stop
+            }
+            callback(JSON.parse(data))
+        })
+    } else {
+        callback(undefined) // file not found
+    }
+}
+
 /**
  * Method to open the channel history
  * 
@@ -64,7 +112,7 @@ export async function clearChannelInfo(filename: string, channel: TextChannel, u
  * @param user the user's name
  * @param messages their messages
  */
-export async function openChannelInfo(this: any, filename: string, channel: TextChannel | ThreadChannel, user: string, messages: UserMessage[] = []): Promise<void> {
+export async function openChannelInfo(filename: string, channel: TextChannel | ThreadChannel, user: string, messages: UserMessage[] = []): Promise<void> {
     const fullFileName = `data/${filename}-${user}.json`
     if (fs.existsSync(fullFileName)) {
         fs.readFile(fullFileName, 'utf8', (error, data) => {
@@ -95,7 +143,7 @@ export async function openChannelInfo(this: any, filename: string, channel: Text
 
         // only creating it, no need to add anything
         fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
-        console.log(`[Util: ${this.name}] Created '${fullFileName}' in working directory`)
+        console.log(`[Util: openChannelInfo] Created '${fullFileName}' in working directory`)
     }
 }
 

src/utils/handlers/configHandler.ts

@@ -10,7 +10,7 @@ import path from 'path'
  * @param value new value to assign
  */
 // add type of change (server, user)
-export function openConfig(this: any, filename: string, key: string, value: any) {
+export function openConfig(filename: string, key: string, value: any) {
     const fullFileName = `data/${filename}`
 
     // check if the file exists, if not then make the config file
@@ -41,7 +41,7 @@ export function openConfig(this: any, filename: string, key: string, value: any)
             fs.mkdirSync(directory, { recursive: true })
 
         fs.writeFileSync(`data/${filename}`, JSON.stringify(object, null, 2))
-        console.log(`[Util: ${this.name}] Created '${filename}' in working directory`)
+        console.log(`[Util: openConfig] Created '${filename}' in working directory`)
     }
 }
 

src/utils/handlers/streamHandler.ts

@@ -1,5 +1,6 @@
-import { ChatResponse, AbortableAsyncIterator } from "ollama"
+import { ChatResponse } from "ollama"
 import { ChatParams } from "../index.js"
+import { AbortableAsyncIterator } from "ollama/src/utils.js"
 
 /**
  * Method to query the Ollama client for async generation

src/utils/messageNormal.ts

@@ -1,7 +1,8 @@
 import { Message, SendableChannels } from 'discord.js'
-import { ChatResponse, Ollama, AbortableAsyncIterator } from 'ollama'
+import { ChatResponse, Ollama } from 'ollama'
 import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
-import { Queue } from '../components/index.js'
+import { Queue } from '../queues/queue.js'
+import { AbortableAsyncIterator } from 'ollama/src/utils.js'
 
 /**
  * Method to send replies as normal text on discord like any other user
@@ -10,7 +11,6 @@ import { Queue } from '../components/index.js'
  * @param msgHist message history between user and model
  */
 export async function normalMessage(
-    this: any,
     message: Message,
     ollama: Ollama,
     model: string,
@@ -56,6 +56,10 @@ export async function normalMessage(
                 response = await blockResponse(params)
                 result = response.message.content
 
+                // check if there is a <think>...</think> sequence from the bot.
+                if (hasThinking(result))
+                    result = result.replace(/<think>[\s\S]*?<\/think>/g, '').trim()
+
                 // check if message length > discord max for normal messages
                 if (result.length > 2000) {
                     sentMessage.edit(result.slice(0, 2000))
@@ -73,14 +77,51 @@ export async function normalMessage(
                     sentMessage.edit(result)
             }
         } catch (error: any) {
-            console.log(`[Util: ${this.name}] Error creating message: ${error.message}`)
+            console.log(`[Util: messageNormal] Error creating message: ${error.message}`)
-            if (error.message.includes('try pulling it first'))
+            if (error.message.includes('fetch failed'))
-                sentMessage.edit(`**Response generation failed.**\n\nReason: You do not have the ${model} downloaded. Ask an admin to pull it using the \`pull-model\` command.`)
+                error.message = 'Missing ollama service on machine'
-            else
+            else if (error.message.includes('try pulling it first'))
-                sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
+                error.message = `You do not have the ${model} downloaded. Ask an admin to pull it using the \`pull-model\` command.`
+            sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
         }
     })
 
     // return the string representation of ollama query response
     return result
 }
+
+export async function summarizeContextHistory(
+    ollama: Ollama, 
+    model: string, 
+    msgHist: UserMessage[], 
+): Promise<string> {
+    // todo: this stuff to create a response in a simpler way!
+    try {
+            const params: ChatParams = {
+            model: model,
+            ollama: ollama,
+            msgHist: msgHist
+        }
+        const response: ChatResponse = await blockResponse(params)
+        let result = response.message.content
+
+        if (hasThinking(result))
+            result = result.replace(/<think>[\s\S]*?<\/think>/g, '').trim()
+
+        return result
+    } catch (error: any) {
+        console.log(`[Util: messageNormal] Error creating message: ${error.message}`)
+        if (error.message.includes('fetch failed'))
+            error.message = 'Missing ollama service on machine'
+        else if (error.message.includes('try pulling it first'))
+            error.message = `You do not have the ${model} downloaded. Ask an admin to pull it using the \`pull-model\` command.`
+        return `**Response generation failed.**\n\nReason: ${error.message}`
+    }
+}
+    
+
+// Region: Helpers
+function hasThinking(message: string): boolean {
+    return /<think>[\s\S]*?<\/think>/i.test(message)
+}
+// End Region: Helpers

tests/commands.test.ts

@@ -27,7 +27,7 @@ describe('Commands Existence', () => {
     // test specific commands in the object
     it('references specific commands', () => {
         const commandsString = commands.map(e => e.name).join(', ')
-        const expectedCommands = ['thread', 'private-thread', 'message-stream', 'toggle-chat', 'shutoff', 'modify-capacity', 'clear-user-channel-history', 'pull-model', 'switch-model', 'delete-model']
+        const expectedCommands = ['thread', 'private-thread', 'message-stream', 'toggle-chat', 'shutoff', 'modify-capacity', 'clear-user-channel-history', 'pull-model', 'switch-model', 'delete-model', 'summary']
         expect(commandsString).toBe(expectedCommands.join(', '))
     })
 })

tests/queue.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { Queue } from '../src/components/index.js'
+import { Queue } from '../src/queues/queue.js'
 
 /**
  * Queue test suite, tests the Queue class