Delete Model Command (#150)

* Add: Delete Model Command

* Update: version increment

* Update: new command to tests

.env.sample

@@ -1,6 +1,9 @@
 # Discord token for the bot
 CLIENT_TOKEN = BOT_TOKEN
 
+# Default model for new users
+MODEL = DEFAULT_MODEL
+
 # ip/port address of docker container, I use 172.18.0.3 for docker, 127.0.0.1 for local
 OLLAMA_IP = IP_ADDRESS
 OLLAMA_PORT = PORT

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.7.3
+    image: kevinthedang/discord-ollama:0.8.0
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
       OLLAMA_IP: ${OLLAMA_IP}

package-lock.json

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

package.json

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

src/client.ts

@@ -25,7 +25,7 @@ export const ollama = new Ollama({
 const messageHistory: Queue<UserMessage> = new Queue<UserMessage>
 
 // register all events
-registerEvents(client, Events, messageHistory, ollama)
+registerEvents(client, Events, messageHistory, ollama, Keys.defaultModel)
 
 // Try to log in the client
 await client.login(Keys.clientToken)

src/commands/deleteModel.ts

@@ -0,0 +1,60 @@
+import { ApplicationCommandOptionType, Client, CommandInteraction } from 'discord.js'
+import { UserCommand, SlashCommand } from '../utils/index.js'
+import { ollama } from '../client.js'
+import { ModelResponse } from 'ollama'
+
+export const DeleteModel: SlashCommand = {
+    name: 'delete-model',
+    description: 'deletes a model from the local list of models. Administrator Only.',
+    
+    // set available user options to pass to the command
+    options: [
+        {
+            name: 'model-name',
+            description: 'the name of the model to delete',
+            type: ApplicationCommandOptionType.String,
+            required: true
+        }
+    ],
+
+    // Delete Model locally stored
+    run: async (client: Client, interaction: CommandInteraction) => {
+        // defer reply to avoid timeout
+        await interaction.deferReply()
+        const modelInput: string = interaction.options.get('model-name')!!.value as string
+
+        // fetch channel and message
+        const channel = await client.channels.fetch(interaction.channelId)
+        if (!channel || !UserCommand.includes(channel.type)) return
+
+        // Admin Command
+        if (!interaction.memberPermissions?.has('Administrator')) {
+            interaction.reply({
+                content: `${interaction.commandName} is an admin command.\n\nPlease contact a server admin to pull the model you want.`,
+                ephemeral: true
+            })
+            return
+        }
+
+        // check if model exists
+        const modelExists: boolean = await ollama.list()
+            .then(response => response.models.some((model: ModelResponse) => model.name.startsWith(modelInput)))
+
+        try {
+            // call ollama to delete model
+            if (modelExists) {
+                await ollama.delete({ model: modelInput })
+                interaction.editReply({
+                    content: `**${modelInput}** was removed from the the library.`
+                })
+            } else
+                throw new Error()
+        } catch (error) {
+            // could not delete the model
+            interaction.reply({
+                content: `Could not delete the **${modelInput}** model. It probably doesn't exist or you spelled it incorrectly.\n\nPlease try again if this is a mistake.`,
+                ephemeral: true
+            })
+        }
+    }
+}

src/commands/index.ts

@@ -1,6 +1,5 @@
 import { SlashCommand } from '../utils/commands.js'
 import { ThreadCreate } from './threadCreate.js'
-import { MessageStyle } from './messageStyle.js'
 import { MessageStream } from './messageStream.js'
 import { Disable } from './disable.js'
 import { Shutoff } from './shutoff.js'
@@ -9,16 +8,17 @@ import { PrivateThreadCreate } from './threadPrivateCreate.js'
 import { ClearUserChannelHistory } from './cleanUserChannelHistory.js'
 import { PullModel } from './pullModel.js'
 import { SwitchModel } from './switchModel.js'
+import { DeleteModel } from './deleteModel.js'
 
 export default [
     ThreadCreate,
     PrivateThreadCreate,
-    MessageStyle,
     MessageStream,
     Disable,
     Shutoff,
     Capacity,
     ClearUserChannelHistory,
     PullModel,
-    SwitchModel
+    SwitchModel,
+    DeleteModel
 ] as SlashCommand[]

src/commands/messageStyle.ts

@@ -1,32 +0,0 @@
-import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
-import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'
-
-export const MessageStyle: SlashCommand = {
-    name: 'message-style',
-    description: 'sets the message style to embed or normal',
-
-    // set available user options to pass to the command
-    options: [
-        {
-            name: 'embed',
-            description: 'toggle embedded or normal message',
-            type: ApplicationCommandOptionType.Boolean,
-            required: true
-        }
-    ],
-
-    // Query for message information and set the style
-    run: async (client: Client, interaction: CommandInteraction) => {
-        // fetch channel and message
-        const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || !UserCommand.includes(channel.type)) return
-
-        // set the message style
-        openConfig(`${interaction.user.username}-config.json`, interaction.commandName, interaction.options.get('embed')?.value)
-
-        interaction.reply({
-            content: `Message style preferences for embed set to: \`${interaction.options.get('embed')?.value}\``,
-            ephemeral: true
-        })
-    }
-}

src/commands/pullModel.ts

@@ -1,12 +1,11 @@
-import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js";
-import { SlashCommand } from "../utils/commands.js";
-import { ollama } from "../client.js";
-import { ModelResponse } from "ollama";
-import { UserCommand } from "../utils/index.js";
+import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js"
+import { ollama } from "../client.js"
+import { ModelResponse } from "ollama"
+import { UserCommand, SlashCommand } from "../utils/index.js"
 
 export const PullModel: SlashCommand = {
     name: 'pull-model',
-    description: 'pulls a model from the ollama model library. Administrator Only',
+    description: 'pulls a model from the ollama model library. Administrator Only.',
 
     // set available user options to pass to the command
     options: [

src/commands/shutoff.ts

@@ -1,6 +1,5 @@
-import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
-import { SlashCommand } from '../utils/commands.js'
-import { AdminCommand } from '../utils/index.js'
+import { Client, CommandInteraction } from 'discord.js'
+import { AdminCommand, SlashCommand } from '../utils/index.js'
 
 export const Shutoff: SlashCommand = {
     name: 'shutoff',

src/commands/switchModel.ts

@@ -1,8 +1,7 @@
-import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js";
-import { SlashCommand } from "../utils/commands.js";
-import { ollama } from "../client.js";
-import { ModelResponse } from "ollama";
-import { openConfig, UserCommand } from "../utils/index.js";
+import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js"
+import { ollama } from "../client.js"
+import { ModelResponse } from "ollama"
+import { openConfig, UserCommand, SlashCommand } from "../utils/index.js"
 
 export const SwitchModel: SlashCommand = {
     name: 'switch-model',

src/events/messageCreate.ts

@@ -1,5 +1,5 @@
 import { TextChannel } from 'discord.js'
-import { embedMessage, event, Events, normalMessage, UserMessage, clean } from '../utils/index.js'
+import { event, Events, normalMessage, UserMessage, clean } from '../utils/index.js'
 import { getChannelInfo, getServerConfig, getUserConfig, openChannelInfo, openConfig, UserConfig, getAttachmentData } from '../utils/index.js'
 
 /** 
@@ -8,7 +8,7 @@ import { getChannelInfo, getServerConfig, getUserConfig, openChannelInfo, openCo
  * 
  * @param message the message received from the channel
  */
-export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client }, message) => {
+export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client, defaultModel }, message) => {
     const clientId = client.user!!.id
     const cleanedMessage = clean(message.content, clientId)
     log(`Message \"${cleanedMessage}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
@@ -21,57 +21,88 @@ export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client
 
     // default stream to false
     let shouldStream = false
+
+    // Params for Preferences Fetching
+    const maxRetries = 3
+    const delay = 1000 // in millisecons
  
     try {
         // Retrieve Server/Guild Preferences
-        await new Promise((resolve, reject) => {
-            getServerConfig(`${message.guildId}-config.json`, (config) => {
-                // check if config.json exists
-                if (config === undefined) {
-                    // Allowing chat options to be available
-                    openConfig(`${message.guildId}-config.json`, 'toggle-chat', true)
-                    reject(new Error('No Server Preferences is set up.\n\nCreating default server preferences file...\nPlease try chatting again.'))
-                    return
-                }
+        let attempt = 0
+        while (attempt < maxRetries) {
+            try {
+                await new Promise((resolve, reject) => {
+                    getServerConfig(`${message.guildId}-config.json`, (config) => {
+                        // check if config.json exists
+                        if (config === undefined) {
+                            // Allowing chat options to be available
+                            openConfig(`${message.guildId}-config.json`, 'toggle-chat', true)
+                            reject(new Error('Failed to locate or create Server Preferences\n\nPlease try chatting again...'))
+                        }
+        
+                        // check if chat is disabled
+                        else if (!config.options['toggle-chat'])
+                            reject(new Error('Admin(s) have disabled chat features.\n\n Please contact your server\'s admin(s).'))
+                        else
+                            resolve(config)
+                    })
+                })
+                break // successful
+            } catch (error) {   
+                ++attempt
+                if (attempt < maxRetries) {
+                    log(`Attempt ${attempt} failed for Server Preferences. Retrying in ${delay}ms...`)
+                    await new Promise(ret => setTimeout(ret, delay))
+                } else 
+                    throw new Error(`Could not retrieve Server Preferences, please try chatting again...`)
+            }
+        }
 
-                // check if chat is disabled
-                if (!config.options['toggle-chat']) {
-                    reject(new Error('Admin(s) have disabled chat features.\n\n Please contact your server\'s admin(s).'))
-                    return
-                }
+        // Reset attempts for User preferences
+        attempt = 0
+        let userConfig: UserConfig | undefined
 
-                resolve(config)
-            })
-        })
+        while (attempt < maxRetries) {
+            try {
+                // Retrieve User Preferences
+                userConfig = await new Promise((resolve, reject) => {
+                    getUserConfig(`${message.author.username}-config.json`, (config) => {
+                        if (config === undefined) {
+                            openConfig(`${message.author.username}-config.json`, 'message-style', false)
+                            openConfig(`${message.author.username}-config.json`, 'switch-model', defaultModel)
+                            reject(new Error('No User Preferences is set up.\n\nCreating preferences file with \`message-style\` set as \`false\` for regular message style.\nPlease try chatting again.'))
+                            return
+                        }
+            
+                        // check if there is a set capacity in config
+                        else if (typeof config.options['modify-capacity'] !== 'number')
+                            log(`Capacity is undefined, using default capacity of ${msgHist.capacity}.`)
+                        else if (config.options['modify-capacity'] === msgHist.capacity)
+                            log(`Capacity matches config as ${msgHist.capacity}, no changes made.`)
+                        else {
+                            log(`New Capacity found. Setting Context Capacity to ${config.options['modify-capacity']}.`)
+                            msgHist.capacity = config.options['modify-capacity']
+                        }
 
-        // Retrieve User Preferences
-        const userConfig: UserConfig = await new Promise((resolve, reject) => {
-            getUserConfig(`${message.author.username}-config.json`, (config) => {
-                if (config === undefined) {
-                    openConfig(`${message.author.username}-config.json`, 'message-style', false)
-                    reject(new Error('No User Preferences is set up.\n\nCreating preferences file with \`message-style\` set as \`false\` for regular message style.\nPlease try chatting again.'))
-                    return
-                }
-    
-                // check if there is a set capacity in config
-                if (typeof config.options['modify-capacity'] !== 'number')
-                    log(`Capacity is undefined, using default capacity of ${msgHist.capacity}.`)
-                else if (config.options['modify-capacity'] === msgHist.capacity)
-                    log(`Capacity matches config as ${msgHist.capacity}, no changes made.`)
-                else {
-                    log(`New Capacity found. Setting Context Capacity to ${config.options['modify-capacity']}.`)
-                    msgHist.capacity = config.options['modify-capacity']
-                }
-    
-                // set stream state
-                shouldStream = config.options['message-stream'] as boolean || false
+                        // set stream state
+                        shouldStream = config.options['message-stream'] as boolean || false
 
-                if (typeof config.options['switch-model'] !== 'string')
-                    reject(new Error(`No Model was set. Please set a model by running \`/switch-model <model of choice>\`.\n\nIf you do not have any models. Run \`/pull-model <model name>\`.`))
-    
-                resolve(config)
-            })
-        })
+                        if (typeof config.options['switch-model'] !== 'string')
+                            reject(new Error(`No Model was set. Please set a model by running \`/switch-model <model of choice>\`.\n\nIf you do not have any models. Run \`/pull-model <model name>\`.`))
+                        
+                        resolve(config)
+                    })
+                })
+                break // successful
+        } catch (error) {
+            ++attempt
+            if (attempt < maxRetries) {
+                log(`Attempt ${attempt} failed for User Preferences. Retrying in ${delay}ms...`)
+                await new Promise(ret => setTimeout(ret, delay))
+            } else
+                throw new Error(`Could not retrieve User Preferences, please try chatting again...`)
+            }
+        }
 
         // need new check for "open/active" threads/channels here!
         let chatMessages: UserMessage[] = await new Promise((resolve) => {
@@ -103,8 +134,8 @@ export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client
             })
         }
 
-        // response string for ollama to put its response
-        let response: string
+        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 messageAttachment: string[] = await getAttachmentData(message.attachments.first())
@@ -123,11 +154,8 @@ export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client
             images: messageAttachment || []
         })
         
-        // undefined or false, use normal, otherwise use embed
-        if (userConfig.options['message-style'])
-            response = await embedMessage(message, ollama, model, msgHist, shouldStream)
-        else
-            response = await normalMessage(message, ollama, model, msgHist, shouldStream)
+        // response string for ollama to put its response
+        const response: string = await normalMessage(message, ollama, model, msgHist, shouldStream)
 
         // If something bad happened, remove user query and stop
         if (response == undefined) { msgHist.pop(); return }

src/keys.ts

@@ -4,6 +4,7 @@ export const Keys = {
     clientToken: getEnvVar('CLIENT_TOKEN'),
     ipAddress: getEnvVar('OLLAMA_IP', '127.0.0.1'), // default ollama ip if none
     portAddress: getEnvVar('OLLAMA_PORT', '11434'), // default ollama port if none
+    defaultModel: getEnvVar('MODEL', 'llama3.2')
 } as const // readonly keys
 
 export default Keys

src/utils/configInterfaces.ts

@@ -3,7 +3,6 @@ import { UserMessage } from './index.js'
 
 export interface UserConfiguration {
     'message-stream'?: boolean,
-    'message-style'?: boolean,
     'modify-capacity': number,
     'switch-model': string
 }

src/utils/events.ts

@@ -36,7 +36,8 @@ export interface EventProps {
     client: Client
     log: LogMethod
     msgHist: Queue<UserMessage>
-    ollama: Ollama
+    ollama: Ollama,
+    defaultModel: String
 }
 export type EventCallback<T extends EventKeys> = (
     props: EventProps,
@@ -64,7 +65,8 @@ export function registerEvents(
     client: Client, 
     events: Event[], 
     msgHist: Queue<UserMessage>,
-    ollama: Ollama
+    ollama: Ollama,
+    defaultModel: String
 ): void {
     for (const { key, callback } of events) {
         client.on(key, (...args) => {
@@ -73,7 +75,7 @@ export function registerEvents(
 
             // Handle Errors, call callback, log errors as needed
             try {
-                callback({ client, log, msgHist, ollama }, ...args)
+                callback({ client, log, msgHist, ollama, defaultModel }, ...args)
             } catch (error) {
                 log('[Uncaught Error]', error)
             }

src/utils/index.ts

@@ -1,7 +1,6 @@
 // Centralized import index
 export * from './env.js'
 export * from './events.js'
-export * from './messageEmbed.js'
 export * from './messageNormal.js'
 export * from './commands.js'
 export * from './configInterfaces.js'

src/utils/messageEmbed.ts

@@ -1,129 +0,0 @@
-import { EmbedBuilder, Message, SendableChannels } from 'discord.js'
-import { ChatResponse, Ollama } from 'ollama'
-import { ChatParams, UserMessage, streamResponse, blockResponse } from './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
- * @param message message sent by the user
- * @param model name of model to run query
- * @param msgHist message history between user and model
- */
-export async function embedMessage(
-    message: Message,
-    ollama: Ollama,
-    model: string,
-    msgHist: Queue<UserMessage>,
-    stream: boolean
-): Promise<string> {
-    // bot response
-    let response: ChatResponse | AbortableAsyncIterator<ChatResponse>
-    let result: string = ''
-
-    // initial message to client
-    const botMessage = new EmbedBuilder()
-    .setTitle(`Responding to ${message.author.tag}`)
-    .setDescription('Generating Response . . .')
-    .setColor('#00FF00')
-
-    // send the message
-    const channel = message.channel as SendableChannels
-    const sentMessage = await channel.send({ embeds: [botMessage] })
-
-    // create params
-    const params: ChatParams = {
-        model: model,
-        ollama: ollama,
-        msgHist: msgHist.getItems()
-    }
-
-    try {
-        // check if embed needs to stream
-        if (stream) {
-            response = await streamResponse(params)
-
-            for await (const portion of response) {
-                result += portion.message.content
-
-                // exceeds handled length
-                if (result.length > 5000) {
-                    const errorEmbed = new EmbedBuilder()
-                        .setTitle(`Responding to ${message.author.tag}`)
-                        .setDescription(`Response length ${result.length} has exceeded Discord maximum.\n\nLong Stream messages not supported.`)
-                        .setColor('#00FF00')
-
-                    // send error
-                    channel.send({ embeds: [errorEmbed] })
-                    break // cancel loop and stop
-                }
-
-                // new embed per token...
-                const streamEmbed = new EmbedBuilder()
-                .setTitle(`Responding to ${message.author.tag}`)
-                .setDescription(result || 'No Content Yet...')
-                .setColor('#00FF00')
-
-                // edit the message
-                sentMessage.edit({ embeds: [streamEmbed] })
-            }
-        } else {
-            response = await blockResponse(params)
-            result = response.message.content
-
-            // long message, split into different embeds sadly.
-            if (result.length > 5000) {
-                const firstEmbed = new EmbedBuilder()
-                .setTitle(`Responding to ${message.author.tag}`)
-                .setDescription(result.slice(0, 5000) || 'No Content to Provide...')
-                .setColor('#00FF00')
-
-                // replace first embed
-                sentMessage.edit({ embeds: [firstEmbed] })
-
-                // take the rest out
-                result = result.slice(5000)
-
-                // handle the rest
-                while (result.length > 5000) {
-                    const whileEmbed = new EmbedBuilder()
-                    .setTitle(`Responding to ${message.author.tag}`)
-                    .setDescription(result.slice(0, 5000) || 'No Content to Provide...')
-                    .setColor('#00FF00')
-
-                    channel.send({ embeds: [whileEmbed] })
-                    result = result.slice(5000)
-                }
-
-                const lastEmbed = new EmbedBuilder()
-                .setTitle(`Responding to ${message.author.tag}`)
-                .setDescription(result || 'No Content to Provide...')
-                .setColor('#00FF00')
-
-                // rest of the response
-                channel.send({ embeds: [lastEmbed] })
-            } else {
-                // only need to create 1 embed, handles 6000 characters
-                const newEmbed = new EmbedBuilder()
-                .setTitle(`Responding to ${message.author.tag}`)
-                .setDescription(result || 'No Content to Provide...')
-                .setColor('#00FF00')
-
-                // edit the message
-                sentMessage.edit({ embeds: [newEmbed] })
-            }
-        }
-    } catch(error: any) {
-        console.log(`[Util: messageEmbed] Error creating message: ${error.message}`)
-        const errorEmbed = new EmbedBuilder()
-            .setTitle(`Responding to ${message.author.tag}`)
-            .setDescription(`**Response generation failed.**\n\nReason: ${error.message}`)
-            .setColor('#00FF00')
-        
-        // send back error
-        sentMessage.edit({ embeds: [errorEmbed] })
-    } 
-
-    // Hope there is a response! undefined otherwie
-    return result
-}

src/utils/messageNormal.ts

@@ -73,7 +73,10 @@ export async function normalMessage(
             }            
         } catch(error: any) {
             console.log(`[Util: messageNormal] Error creating message: ${error.message}`)
-            sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
+            if (error.message.includes('try pulling it first'))
+                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.`)
+            else
+                sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
         }
     })
 

tests/commands.test.ts

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