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

.github/CONTRIBUTING.md

@@ -11,6 +11,7 @@
     * features: `'feature/**'`
     * releases: `'releases/**'`
     * bugs: `'bug/**'`
+    * docs: `'docs/**'`
 
 ## Run the Bot
 * Refer to all sections below before running the bot.

CODEOWNERS

@@ -0,0 +1,24 @@
+# The further along the ownership is, the more precedence it has.
+# This to make sure the right people look at certain changes.
+# Last Edited: 11/23/2024
+# Author: Kevin Dang
+
+# These owners will be the default owners 
+# for everything in the repo. However it's
+# only for the rest of the files not declared by the
+# following ownerships below.
+* @kevinthedang @JT2M0L3Y
+
+# Technical/Business Code Ownership
+/src/ @kevinthedang @JT2M0L3Y
+/tests/ @kevinthedang @JT2M0L3Y
+/.github/ @kevinthedang
+
+# Docker Ownership
+Dockerfile @kevinthedang
+docker-compose.yml @kevinthedang
+
+# Documentation Ownership
+/docs/ @kevinthedang
+/imgs/ @kevinthedang
+

README.md

@@ -31,6 +31,11 @@ The project aims to:
   * [ ] Documentation on creating your own LLM
   * [ ] Documentation on web scrapping and cleaning
 
+## Documentation
+These are guides to the feature set included and the events triggered in this app.
+* [User Slash Commands](./docs/commands-guide.md)
+* [Client Events](./docs/events-guide.md)
+
 ## Environment Setup
 * Clone this repo using `git clone https://github.com/kevinthedang/discord-ollama.git` or just use [GitHub Desktop](https://desktop.github.com/) to clone the repo.
 * You will need a `.env` file in the root of the project directory with the bot's token. There is a `.env.sample` is provided for you as a reference for what environment variables.
@@ -41,6 +46,7 @@ The project aims to:
     * [Docker Setup for Servers and Local Machines](./docs/setup-docker.md)
         * Nvidia is recommended for now, but support for other GPUs should be development.
         * Local use is not recommended.
+
 ## Resources
 * [NodeJS](https://nodejs.org/en)
     * This project runs on `lts\hydrogen`. 

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

docs/commands-guide.md

@@ -0,0 +1,105 @@
+## Commands Guide
+This is a guide to all of the slash commands for the app.
+
+* Action Commands are commands that do not affect a user's `preference file`.
+* Guild Commands can also be considered action commands.
+
+> [!NOTE]
+> Administrator commands are only usable by actual administrators on the Discord server.
+
+### Guild Commands (Administrator)
+1. Disable (or Toggle Chat)  
+    This command will `enable` or `disable` whether or not the app will respond to users.  
+
+    ```
+    /toggle-chat enabled true
+    ```
+
+2. Shutoff  
+    This command will shutoff the app so no users can converse with it.  
+    The app must be manually restarted upon being shutoff.
+
+    Below shuts off the app by putting `true` in the `are-your-sure` field.
+
+    ```
+    /shutoff are-you-sure true
+    ```
+
+### Action Commands
+1. Clear Channel (Message) History  
+    This command will clear the history of the current channel for the user that calls it.  
+    Running the command in any channel will clear the message history.
+
+    ```
+    /clear-user-channel-history
+    ```
+
+2. Pull Model  
+    This command will pull a model that exists on the [Ollama Model Library](https://ollama.com/library). If it does not exist there, it will throw a hissy fit.
+
+    Below trys to pull the `codellama` model.
+
+    ```
+    /pull-model model-to-pull codellama
+    ```
+
+3. Thread Create  
+    This command creates a public thread to talk with the app instead of using a `GuildText` channel.
+
+    ```
+    /thread
+    ```
+
+4. (Private) Thread Create  
+    This command creates a private thread to talk with the bot privately.  
+    Invite others to the channel and they will be able to talk to the app as well.
+
+    ```
+    /private-thread
+    ```
+
+### User Preference Commands
+1. Capacity  
+    This command changes how much context it will keep in conversations with the app.  
+    This is applied for all of existing chats when interacting with the app.  
+
+    Below sets the message history capacity to at most 5 messages at once.
+
+    ```
+    /modify-capacity context-capacity 5
+    ```
+
+2. Message Stream  
+    This command will toggle whether or not the app will "stream" a response.  
+    (think of how ChatGPT and other interfaces do this)
+
+    Below sets the `stream` to true to make the app respond in increments.
+
+    ```
+    /message-stream stream true
+    ```
+    > [!NOTE]
+    > This is a very slow progress on Discord because "spamming" changes within 5 seconds is not allowed.
+
+3. Message Style  
+    This command allows a user to select whether to embed the app's response. 
+
+    ```
+    /message-style embed true
+    ```
+
+    This allows the app to respond as a user would normally respond.
+
+    ```
+    /message-style embed false
+    ```
+
+4. Switch Model  
+    This command will switch the user-preferred model so long as it exists in within the local ollama service or from the [Ollama Model Library](https://ollama.com/library).  
+    If it cannot be found locally, it will attempt to find it in the model library.
+
+    Below we are trying to switch to a specific model size. 
+
+    ```
+    /switch-model model-to-use llama3.2:1.3b
+    ```

docs/events-guide.md

@@ -0,0 +1,27 @@
+## Events Guide
+This is a guide to all of the client events for the app.
+
+> [!NOTE] Each of these is logged to the console for a developer to track.
+
+1. ClientReady  
+    This event signifies that the Discord app is online.  
+    Here the app's activity is set and its commands are registered.
+
+2. InteractionCreate  
+    This event signifies that a user interacted from Discord in some way.  
+    Here commands are selected from a knowledge bank and executed if found.
+
+    > [!NOTE] Possible interactions include commands, buttons, menus, etc.
+
+3. MessageCreate  
+    This event signifies that a message was sent.  
+    Here user questions and comments for the LLM are processed.  
+    1. check message is from a user and mentions the app
+    2. check for interaction preferences
+    3. add the message to a queue
+    4. check the response for success
+    5.  send a response back to the user.
+
+4. ThreadDelete  
+    This event signifies that a Discord Thread was deleted.  
+    Here any preferences set for interaction within the thread are cleared away.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-ollama",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",
@@ -26,17 +26,17 @@
   "author": "Kevin Dang",
   "license": "ISC",
   "dependencies": {
-    "discord.js": "^14.15.3",
+    "discord.js": "^14.16.3",
     "dotenv": "^16.4.5",
     "ollama": "^0.5.9"
   },
   "devDependencies": {
-    "@types/node": "^22.7.5",
+    "@types/node": "^22.9.0",
-    "@vitest/coverage-v8": "^2.1.2",
+    "@vitest/coverage-v8": "^2.1.4",
     "ts-node": "^10.9.2",
-    "tsx": "^4.19.1",
+    "tsx": "^4.19.2",
     "typescript": "^5.6.3",
-    "vitest": "^2.1.2"
+    "vitest": "^2.1.4"
   },
   "type": "module",
   "engines": {

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/capacity.ts

@@ -1,15 +1,15 @@
-import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
+import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
-import { openConfig, SlashCommand } from '../utils/index.js'
+import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'
 
 export const Capacity: SlashCommand = {
     name: 'modify-capacity',
-    description: 'number of messages bot will hold for context.',
+    description: 'maximum amount messages bot will hold for context.',
 
     // set available user options to pass to the command
     options: [
         {
             name: 'context-capacity',
-            description: 'a number to set capacity',
+            description: 'number of allowed messages to remember',
             type: ApplicationCommandOptionType.Number,
             required: true
         }
@@ -19,13 +19,13 @@ export const Capacity: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== (ChannelType.PrivateThread && ChannelType.PublicThread && ChannelType.GuildText)) return
+        if (!channel || !UserCommand.includes(channel.type)) return
 
         // set state of bot chat features
         openConfig(`${interaction.user.username}-config.json`, interaction.commandName, interaction.options.get('context-capacity')?.value)
 
         interaction.reply({
-            content: `Message History Capacity has been set to \`${interaction.options.get('context-capacity')?.value}\``,
+            content: `Max message history is now set to \`${interaction.options.get('context-capacity')?.value}\``,
             ephemeral: true
         })
     }

src/commands/cleanUserChannelHistory.ts

@@ -1,17 +1,17 @@
-import { ChannelType, Client, CommandInteraction, TextChannel } from 'discord.js'
+import { Channel, Client, CommandInteraction, TextChannel } from 'discord.js'
-import { clearChannelInfo, SlashCommand } from '../utils/index.js'
+import { clearChannelInfo, SlashCommand, UserCommand } from '../utils/index.js'
 
 export const ClearUserChannelHistory: SlashCommand = {
     name: 'clear-user-channel-history',
-    description: 'clears history for user running this command in current channel',
+    description: 'clears history for user in the current channel',
 
     // Clear channel history for intended user
     run: async (client: Client, interaction: CommandInteraction) => {
         // fetch current channel
-        const channel = await client.channels.fetch(interaction.channelId)
+        const channel: Channel | null = await client.channels.fetch(interaction.channelId)
 
         // if not an existing channel or a GuildText, fail command
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || !UserCommand.includes(channel.type)) return
 
         // clear channel info for user
         const successfulWipe = await clearChannelInfo(interaction.channelId, 
@@ -21,12 +21,12 @@ export const ClearUserChannelHistory: SlashCommand = {
         // check result of clearing history
         if (successfulWipe)
             interaction.reply({ 
-                content: `Channel history in **${channel.name}** cleared for **${interaction.user.username}**.`, 
+                content: `History cleared in **this channel** cleared for **${interaction.user.username}**.`, 
                 ephemeral: true
             })
         else
             interaction.reply({ 
-                content: `Channel history could not be found for **${interaction.user.username}** in **${channel.name}**.\n\nPlease chat with **${client.user?.username}** to start a chat history.`, 
+                content: `History was not be found for **${interaction.user.username}** in **this channel**.\n\nPlease chat with **${client.user?.username}** to start a chat history.`, 
                 ephemeral: true
             })
     }

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/disable.ts

@@ -1,9 +1,9 @@
-import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
+import { Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
-import { openConfig, SlashCommand } from '../utils/index.js'
+import { AdminCommand, openConfig, SlashCommand } from '../utils/index.js'
 
 export const Disable: SlashCommand = {
     name: 'toggle-chat',
-    description: 'toggle all chat features, Adminstrator Only.',
+    description: 'toggle all chat features. Adminstrator Only.',
 
     // set available user options to pass to the command
     options: [
@@ -19,12 +19,12 @@ export const Disable: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || !AdminCommand.includes(channel.type)) return
 
         // check if runner is an admin
         if (!interaction.memberPermissions?.has('Administrator')) {
             interaction.reply({
-                content: `${interaction.commandName} is an Administrator Command.\n\nYou, ${interaction.member?.user.username}, are not an Administrator in this server.\nPlease contact an admin to use this command.`,
+                content: `${interaction.commandName} is an admin command.\n\nPlease contact an admin to use this command for you.`,
                 ephemeral: true
             })
             return
@@ -34,7 +34,7 @@ export const Disable: SlashCommand = {
         openConfig(`${interaction.guildId}-config.json`, interaction.commandName, interaction.options.get('enabled')?.value)
 
         interaction.reply({
-            content: `Chat features has been \`${interaction.options.get('enabled')?.value ?  "enabled" : "disabled" }\``,
+            content: `${client.user?.username} is now **${interaction.options.get('enabled')?.value ?  "enabled" : "disabled" }**.`,
             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/messageStream.ts

@@ -1,15 +1,15 @@
-import { ApplicationCommandOptionType, ChannelType, Client, CommandInteraction } from 'discord.js'
+import { ApplicationCommandOptionType, Client, CommandInteraction } from 'discord.js'
-import { openConfig, SlashCommand } from '../utils/index.js'
+import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'
 
 export const MessageStream: SlashCommand = {
     name: 'message-stream',
-    description: 'change preference on message streaming from ollama. WARNING: can be very slow.',
+    description: 'change preference on message streaming from ollama. WARNING: can be very slow due to Discord limits.',
 
     // user option(s) for setting stream
     options: [
         {
             name: 'stream',
-            description: 'enable or disable stream preference',
+            description: 'enable or disable message streaming',
             type: ApplicationCommandOptionType.Boolean,
             required: true
         }
@@ -19,13 +19,13 @@ export const MessageStream: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // verify channel
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== (ChannelType.PrivateThread && ChannelType.PublicThread && ChannelType.GuildText)) return
+        if (!channel || !UserCommand.includes(channel.type)) return
 
         // save value to json and write to it
         openConfig(`${interaction.user.username}-config.json`, interaction.commandName, interaction.options.get('stream')?.value)
 
         interaction.reply({
-            content: `Message streaming preferences set to: \`${interaction.options.get('stream')?.value}\``,
+            content: `Message streaming is now set to: \`${interaction.options.get('stream')?.value}\``,
             ephemeral: true
         })
     }

src/commands/messageStyle.ts

@@ -1,32 +0,0 @@
-import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
-import { openConfig, SlashCommand } 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 || channel.type !== (ChannelType.PrivateThread && ChannelType.PublicThread && ChannelType.GuildText)) 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,10 +1,11 @@
-import { ApplicationCommandOptionType, ChannelType, Client, CommandInteraction } from "discord.js";
+import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js"
-import { SlashCommand } from "../utils/commands.js";
+import { ollama } from "../client.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',
+    description: 'pulls a model from the ollama model library. Administrator Only.',
 
     // set available user options to pass to the command
     options: [
@@ -24,24 +25,45 @@ export const PullModel: SlashCommand = {
 
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== (ChannelType.PrivateThread && ChannelType.PublicThread && ChannelType.GuildText)) return
+        if (!channel || !UserCommand.includes(channel.type)) return
 
-        try {
+        // Admin Command
-            // call ollama to pull desired model
+        if (!interaction.memberPermissions?.has('Administrator')) {
-            await ollama.pull({
+            interaction.reply({
-                model: modelInput
+                content: `${interaction.commandName} is an admin command.\n\nPlease contact a server admin to pull the model you want.`,
-            })
+                ephemeral: true
-        } catch (error) {
-            // could not resolve pull or model unfound
-            interaction.editReply({
-                content: `Could not pull/locate the **${modelInput}** model within the [Ollama Model Library](https://ollama.com/library).\n\nPlease check the model library and try again.`
             })
             return
         }
 
-        // successful pull
+        // check if model was already pulled
-        interaction.editReply({
+        const modelExists: boolean = await ollama.list()
-            content: `Successfully added **${modelInput}** into your local model library.`
+            .then(response => response.models.some((model: ModelResponse) => model.name.startsWith(modelInput)))
-        })
+
+        try {
+            // call ollama to pull desired model
+            if (!modelExists) {
+                interaction.editReply({
+                    content: `**${modelInput}** could not be found. Please wait patiently as I try to retrieve it...`
+                })
+                await ollama.pull({ model: modelInput })
+            }
+        } catch (error) {
+            // could not resolve pull or model unfound
+            interaction.editReply({
+                content: `Could not retrieve the **${modelInput}** model. You can find models at [Ollama Model Library](https://ollama.com/library).\n\nPlease check the model library and try again.`
+            })
+            return
+        }
+
+        // successful interaction
+        if (modelExists)
+            interaction.editReply({
+                content: `**${modelInput}** is already available.`
+            })
+        else
+            interaction.editReply({
+                content: `Successfully added **${modelInput}**.`
+            })
     }
 }

src/commands/shutoff.ts

@@ -1,28 +1,18 @@
-import { ChannelType, Client, CommandInteraction, ApplicationCommandOptionType } from 'discord.js'
+import { Client, CommandInteraction } from 'discord.js'
-import { SlashCommand } from '../utils/commands.js'
+import { AdminCommand, SlashCommand } from '../utils/index.js'
 
 export const Shutoff: SlashCommand = {
     name: 'shutoff',
     description: 'shutdown the bot. You will need to manually bring it online again. Administrator Only.',
 
-    // set available user options to pass to the command
-    options: [
-        {
-            name: 'are-you-sure',
-            description: 'true = yes, false = I\'m scared',
-            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 || channel.type !== ChannelType.GuildText) return
+        if (!channel || !AdminCommand.includes(channel.type)) return
 
         // log this, this will probably be improtant for logging who did this
-        console.log(`User -> ${interaction.user.tag} attempting to shutdown ${client.user!!.tag}`)
+        console.log(`[Command: shutoff] User ${interaction.user.tag} attempting to shutdown ${client.user!!.tag}`)
 
         // check if admin or false on shutdown
         if (!interaction.memberPermissions?.has('Administrator')) {
@@ -31,19 +21,14 @@ export const Shutoff: SlashCommand = {
                 ephemeral: true
             })
             return // stop from shutting down
-        } else if (!interaction.options.get('are-you-sure')?.value) {
-            interaction.reply({
-                content: `**Shutdown Aborted:**\n\n${interaction.user.tag}, You didn't want to shutoff **${client.user?.tag}**.`,
-                ephemeral: true
-            })
-            return // chickened out
         }
 
         // Shutoff cleared, do it
         interaction.reply({
-            content: `${client.user?.tag} is ${interaction.options.get('are-you-sure')?.value ?  "shutting down now." : "not shutting down." }`,
+            content: `${client.user?.tag} is shutting down.`,
             ephemeral: true
         })
+        console.log(`[Command: shutoff] ${client.user?.tag} is shutting down.`)
 
         // clean up client instance and stop
         client.destroy()

src/commands/switchModel.ts

@@ -1,12 +1,11 @@
-import { ApplicationCommandOptionType, ChannelType, Client, CommandInteraction } from "discord.js";
+import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js"
-import { SlashCommand } from "../utils/commands.js";
+import { ollama } from "../client.js"
-import { ollama } from "../client.js";
+import { ModelResponse } from "ollama"
-import { ModelResponse } from "ollama";
+import { openConfig, UserCommand, SlashCommand } from "../utils/index.js"
-import { openConfig } from "../utils/index.js";
 
 export const SwitchModel: SlashCommand = {
     name: 'switch-model',
-    description: 'switches current model to preferred model to use.',
+    description: 'switches current model to use.',
 
     // set available user options to pass to the command
     options: [
@@ -26,10 +25,10 @@ export const SwitchModel: SlashCommand = {
 
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== (ChannelType.PrivateThread && ChannelType.PublicThread && ChannelType.GuildText)) return
+        if (!channel || !UserCommand.includes(channel.type)) return
 
         try {
-            // Phase 1: Set the model
+            // Phase 1: Switch to the model
             let switchSuccess = false
             await ollama.list()
             .then(response => {
@@ -46,28 +45,21 @@ export const SwitchModel: SlashCommand = {
                     }
                 }
             })
-            if (switchSuccess) return
+            // todo: problem can be here if async messes up
+            if (switchSuccess) {
+                // set model now that it exists
+                openConfig(`${interaction.user.username}-config.json`, interaction.commandName, modelInput)
+                return
+            }
 
-            // Phase 2: Try to get it regardless
+            // Phase 2: Notify user of failure to find model.
             interaction.editReply({
-                content: `Could not find **${modelInput}** in local model library, trying to pull it now...\n\nThis could take a few moments... Please be patient!`
+                content: `Could not find **${modelInput}** in local model library.\n\nPlease contact an server admin for access to this model.`
-            })
+            })  
-
-            await ollama.pull({
-                model: modelInput
-            })
-
-            // set model now that it exists
-            openConfig(`${interaction.user.username}-config.json`, interaction.commandName, modelInput)
-
-            // We got the model!
-            interaction.editReply({
-                content: `Successfully added and set **${modelInput}** as your preferred model.`
-            })
         } catch (error) {
             // could not resolve user model switch
             interaction.editReply({
-                content: `Unable to switch user preferred model to **${modelInput}**.\n\n${error}\n\nPossible solution is to run \`/pull-model ${modelInput}\` and try again.`
+                content: `Unable to switch user preferred model to **${modelInput}**.\n\n${error}\n\nPossible solution is to request an server admin run \`/pull-model ${modelInput}\` and try again.`
             })
             return
         }

src/commands/threadCreate.ts

@@ -1,5 +1,5 @@
 import { ChannelType, Client, CommandInteraction, TextChannel, ThreadChannel } from 'discord.js'
-import { openChannelInfo, SlashCommand } from '../utils/index.js'
+import { AdminCommand, openChannelInfo, SlashCommand } from '../utils/index.js'
 
 export const ThreadCreate: SlashCommand = {
     name: 'thread',
@@ -9,7 +9,7 @@ export const ThreadCreate: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // fetch the channel
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || !AdminCommand.includes(channel.type)) return
 
         const thread = await (channel as TextChannel).threads.create({
             name: `${client.user?.username}-support-${Date.now()}`,
@@ -18,7 +18,7 @@ export const ThreadCreate: SlashCommand = {
         })
 
         // Send a message in the thread
-        thread.send(`Hello ${interaction.user} and others! \n\nIt's nice to meet you. Please talk to me by typing **@${client.user?.username}** with your prompt.`)
+        thread.send(`Hello ${interaction.user} and others! \n\nIt's nice to meet you. Please talk to me by typing **@${client.user?.username}** with your message.`)
 
         // handle storing this chat channel
         openChannelInfo(thread.id, 
@@ -27,7 +27,7 @@ export const ThreadCreate: SlashCommand = {
 
         // user only reply
         return interaction.reply({
-            content: `I can help you in thread **${thread.id}** below.`,
+            content: `I can help you in <#${thread.id}> below.`,
             ephemeral: true
         })
     }

src/commands/threadPrivateCreate.ts

@@ -1,5 +1,5 @@
 import { ChannelType, Client, CommandInteraction, TextChannel, ThreadChannel } from 'discord.js'
-import { openChannelInfo, SlashCommand } from '../utils/index.js'
+import { AdminCommand, openChannelInfo, SlashCommand } from '../utils/index.js'
 
 export const PrivateThreadCreate: SlashCommand = {
     name: 'private-thread',
@@ -9,7 +9,7 @@ export const PrivateThreadCreate: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // fetch the channel
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.GuildText) return
+        if (!channel || !AdminCommand.includes(channel.type)) return
 
         const thread = await (channel as TextChannel).threads.create({
             name: `${client.user?.username}-private-support-${Date.now()}`,
@@ -29,7 +29,7 @@ export const PrivateThreadCreate: SlashCommand = {
 
         // user only reply
         return interaction.reply({
-            content: `I can help you in thread **${thread.id}**. Please refer to the private channel below this one.`,
+            content: `I can help you in <#${thread.id}>.`,
             ephemeral: true
         })
     }

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) => {
+        let attempt = 0
-            getServerConfig(`${message.guildId}-config.json`, (config) => {
+        while (attempt < maxRetries) {
-                // check if config.json exists
+            try {
-                if (config === undefined) {
+                await new Promise((resolve, reject) => {
-                    // Allowing chat options to be available
+                    getServerConfig(`${message.guildId}-config.json`, (config) => {
-                    openConfig(`${message.guildId}-config.json`, 'toggle-chat', true)
+                        // check if config.json exists
-                    reject(new Error('No Server Preferences is set up.\n\nCreating default server preferences file...\nPlease try chatting again.'))
+                        if (config === undefined) {
-                    return
+                            // 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
+        // Reset attempts for User preferences
-                if (!config.options['toggle-chat']) {
+        attempt = 0
-                    reject(new Error('Admin(s) have disabled chat features.\n\n Please contact your server\'s admin(s).'))
+        let userConfig: UserConfig | undefined
-                    return
-                }
 
-                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
+                        // set stream state
-        const userConfig: UserConfig = await new Promise((resolve, reject) => {
+                        shouldStream = config.options['message-stream'] as boolean || false
-            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
 
-                if (typeof config.options['switch-model'] !== 'string')
+                        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>\`.`))
+                            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)
+                        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
+        if (!userConfig)
-        let response: string
+            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
+        // response string for ollama to put its response
-        if (userConfig.options['message-style'])
+        const response: string = await normalMessage(message, ollama, model, msgHist, shouldStream)
-            response = await embedMessage(message, ollama, model, msgHist, shouldStream)
-        else
-            response = 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

@@ -1,8 +1,8 @@
+import { ChannelType } from 'discord.js'
 import { UserMessage } from './index.js'
 
 export interface UserConfiguration {
     'message-stream'?: boolean,
-    'message-style'?: boolean,
     'modify-capacity': number,
     'switch-model': string
 }
@@ -42,6 +42,21 @@ export interface Channel {
     messages: UserMessage[]
 }
 
+/**
+ * The following 2 types is allow for better readability in commands
+ * Admin Command -> Don't run in Threads
+ * User Command -> Used anywhere
+ */
+export const AdminCommand = [
+    ChannelType.GuildText
+]
+
+export const UserCommand = [
+    ChannelType.GuildText,
+    ChannelType.PublicThread,
+    ChannelType.PrivateThread
+]
+
 /**
  * Check if the configuration we are editing/taking from is a Server Config
  * @param key name of command we ran

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/handlers/chatHistoryHandler.ts

@@ -53,7 +53,6 @@ export async function clearChannelInfo(filename: string, channel: TextChannel, u
             }
         })
     })
-    console.log(cleanedHistory)
     return cleanedHistory
 }
 

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,128 +0,0 @@
-import { EmbedBuilder, Message } 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 sentMessage = await message.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
-                    message.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')
-
-                    message.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
-                message.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

@@ -1,4 +1,4 @@
-import { Message } from 'discord.js'
+import { Message, SendableChannels } from 'discord.js'
 import { ChatResponse, Ollama } from 'ollama'
 import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
 import { Queue } from '../queues/queue.js'
@@ -20,8 +20,9 @@ export async function normalMessage(
     // bot's respnse
     let response: ChatResponse | AbortableAsyncIterator<ChatResponse>
     let result: string = ''
+    const channel = message.channel as SendableChannels
 
-    await message.channel.send('Generating Response . . .').then(async sentMessage => {
+    await channel.send('Generating Response . . .').then(async sentMessage => {
         try {
             const params: ChatParams = {
                 model: model,
@@ -39,7 +40,7 @@ export async function normalMessage(
                         result = portion.message.content
 
                         // new message block, wait for it to send and assign new block to respond.
-                        await message.channel.send("Creating new stream block...").then(sentMessage => { messageBlock = sentMessage })
+                        await channel.send("Creating new stream block...").then(sentMessage => { messageBlock = sentMessage })
                     } else {
                         result += portion.message.content
                         
@@ -61,18 +62,21 @@ export async function normalMessage(
 
                     // handle for rest of message that is >2000
                     while (result.length > 2000) {
-                        message.channel.send(result.slice(0, 2000))
+                        channel.send(result.slice(0, 2000))
                         result = result.slice(2000)
                     }
 
                     // last part of message
-                    message.channel.send(result)
+                    channel.send(result)
                 } else // edit the 'generic' response to new message since <2000
                     sentMessage.edit(result)
             }            
         } 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')
     })
 })