hardcoded and mentions

* added options to queries

* removed hard coded vals, added message options

* updated importing

* added check for message mentions

* fix missing botID

* updated token to uid

* added contributer

---------

Co-authored-by: JT2M0L3Y <jtsmoley@icloud.com>

.gitignore

@@ -1,10 +1,13 @@
-# Credentials
-.env
-.dev.env
-
 # Created by https://www.toptal.com/developers/gitignore/api/node
 # Edit at https://www.toptal.com/developers/gitignore?templates=node
 
+# dotenv environment variable files
+.env
+.env.dev.local
+.env.test.local
+.env.production.local
+.env.local
+
 ### Node ###
 # Logs
 logs
@@ -80,13 +83,6 @@ web_modules/
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variable files
-.env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
-
 # parcel-bundler cache (https://parceljs.org/)
 .cache
 .parcel-cache

README.md

@@ -32,5 +32,6 @@ Ollama is an AI model management tool that allows users to install and use custo
 
 ## Acknowledgement
 * [Kevin Dang](https://github.com/kevinthedang)
+* [Jonathan Smoley](https://github.com/JT2M0L3Y)
 
 [discord-ollama](https://github.com/kevinthedang/discord-ollama) © 2023 by [Kevin Dang](https://github.com/kevinthedang) is licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/?ref=chooser-v1)

package-lock.json

@@ -12,7 +12,8 @@
         "axios": "^1.6.2",
         "concurrently": "^8.2.2",
         "discord.js": "^14.14.1",
-        "dotenv": "^16.3.1"
+        "dotenv": "^16.3.1",
+        "ollama": "^0.4.3"
       },
       "devDependencies": {
         "@types/node": "^20.10.5",
@@ -1312,6 +1313,14 @@
         "node": ">=0.10.0"
       }
     },
+    "node_modules/ollama": {
+      "version": "0.4.3",
+      "resolved": "https://registry.npmjs.org/ollama/-/ollama-0.4.3.tgz",
+      "integrity": "sha512-l8RtRp5uKhvqbAmA9n5PS4ZW1RPbA2CPSlNinJ+jVQYD36UjxPQphEPxp0etH/wqY26nHyM6HQEHatIfrW0+Tw==",
+      "dependencies": {
+        "whatwg-fetch": "^3.6.20"
+      }
+    },
     "node_modules/picomatch": {
       "version": "2.3.1",
       "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz",
@@ -1598,6 +1607,11 @@
       "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==",
       "dev": true
     },
+    "node_modules/whatwg-fetch": {
+      "version": "3.6.20",
+      "resolved": "https://registry.npmjs.org/whatwg-fetch/-/whatwg-fetch-3.6.20.tgz",
+      "integrity": "sha512-EqhiFU6daOA8kpjOWTL0olhVOF3i7OrFzSYiGsEMB8GcXS+RrzauAERX65xMeNWVqxA6HXH2m69Z9LaKKdisfg=="
+    },
     "node_modules/wrap-ansi": {
       "version": "7.0.0",
       "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-ollama",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Ollama Integration into discord",
   "main": "dist/index.js",
   "exports": "./dist/index.js",
@@ -19,7 +19,8 @@
     "axios": "^1.6.2",
     "concurrently": "^8.2.2",
     "discord.js": "^14.14.1",
-    "dotenv": "^16.3.1"
+    "dotenv": "^16.3.1",
+    "ollama": "^0.4.3"
   },
   "devDependencies": {
     "@types/node": "^20.10.5",

src/client.ts

@@ -5,6 +5,7 @@ import Events from "./events/index.js";
 // Import keys/tokens
 import Keys from "./keys.js";
 
+// initialize the client with the following permissions when logging in
 const client = new Client({
     intents: [
         GatewayIntentBits.Guilds,
@@ -16,12 +17,19 @@ const client = new Client({
 
 const messageHistory = [
     {
-        role: 'assistant',
-        content: 'My name is Ollama GU.'
+        role: 'system',
+        content: 'Your name is Ollama GU'
     }
 ]
 
-registerEvents(client, Events, messageHistory)
+/**
+ * register events for bot to listen to in discord
+ * @param messageHistory message history for the llm
+ * @param Events events to register
+ * @param client the bot reference
+ * @param Keys tokens from .env files
+ */
+registerEvents(client, Events, messageHistory, Keys)
 
 // Try to log in the client
 client.login(Keys.clientToken)

src/events/messageCreate.ts

@@ -1,50 +1,39 @@
-import { event, Events } from '../utils/index.js'
-import Axios from 'axios'
+import { embedMessage, event, Events } from '../utils/index.js'
 
-/*
+/** 
  * Max Message length for free users is 2000 characters (bot or not).
+ * @param message the message received from the channel
  */
-export default event(Events.MessageCreate, ({ log, msgHist }, message) => {
+export default event(Events.MessageCreate, async ({ log, msgHist, tokens }, message) => {
     log(`Message created \"${message.content}\" from ${message.author.tag}.`)
 
     // Hard-coded channel to test output there only, in our case "ollama-endpoint"
-    if (message.channelId != '1188262786497785896') return
+    if (message.channelId != tokens.channel) return
 
     // Do not respond if bot talks in the chat
     if (message.author.tag === message.client.user.tag) return
 
+    // Only respond if message mentions the bot
+    if (!message.mentions.has(tokens.botUid)) return
+
     // push user response
     msgHist.push({
         role: 'user',
         content: message.content
     })
 
-    // Reply with something to prompt that ollama is working
-    message.reply("Generating Response . . .").then(sentMessage => {
-        // Request made to API
-        const request = async () => {
-            try {
-                // change this when using an actual hosted server or use ollama.js
-                const response = await Axios.post('http://127.0.0.1:11434/api/chat', {
-                    model: 'llama2',
-                    messages: msgHist,
-                    stream: false
-                })
-                log(response.data)
-    
-                sentMessage.edit(response.data.message.content)
+    // Try to query and send embed
+    const response = await embedMessage(message, tokens, msgHist)
 
-                // push bot response
-                msgHist.push({
-                    role: 'assistant',
-                    content: response.data.message.content
-                })
-            } catch (error) {
-                log(error)
-            }
-        }
+    // Try to query and send message
+    // log(normalMessage(message, tokens, msgHist))
 
-        // Attempt to call ollama's endpoint
-        request()
+    // If something bad happened, remove user query and stop
+    if (response == undefined) { msgHist.pop(); return }
+
+    // successful query, save it as history
+    msgHist.push({
+        role: 'assistant',
+        content: response.message.content
     })
 })

src/keys.ts

@@ -1,7 +1,10 @@
 import { getEnvVar } from "./utils/env.js"
 
 export const Keys = {
-    clientToken: getEnvVar('CLIENT_TOKEN')
+    clientToken: getEnvVar('CLIENT_TOKEN'),
+    channel: getEnvVar('CHANNEL_ID'),
+    model: getEnvVar('MODEL'),
+    botUid: getEnvVar('BOT_UID')
 } as const // readonly keys
 
 export default Keys

src/utils/env.ts

@@ -2,7 +2,7 @@ import { resolve } from "path"
 import { config } from "dotenv"
 
 // Find config - ONLY WORKS WITH NODEMON
-const envFile = process.env.NODE_ENV === "development" ? ".dev.env" : ".env"
+const envFile = process.env.NODE_ENV === "development" ? ".env.dev.local" : ".env"
 
 // resolve config file
 const envFilePath = resolve(process.cwd(), envFile)

src/utils/events.ts

@@ -11,6 +11,11 @@ export interface EventProps {
     client: Client
     log: LogMethod
     msgHist: { role: string, content: string }[]
+    tokens: {
+        channel: string,
+        model: string,
+        botUid: string
+    }
 }
 export type EventCallback<T extends EventKeys> = (
     props: EventProps,
@@ -27,7 +32,16 @@ export function event<T extends EventKeys>(key: T, callback: EventCallback<T>):
     return { key, callback }
 }
 
-export function registerEvents(client: Client, events: Event[], msgHist: { role: string, content: string }[]): void {
+export function registerEvents(
+    client: Client, 
+    events: Event[], 
+    msgHist: { role: string, content: string }[],
+    tokens: {
+        channel: string,
+        model: string,
+        botUid: string
+    }
+): void {
     for (const { key, callback } of events) {
         client.on(key, (...args) => {
             // Create a new log method for this event
@@ -35,7 +49,7 @@ export function registerEvents(client: Client, events: Event[], msgHist: { role:
 
             // Handle Errors, call callback, log errors as needed
             try {
-                callback({ client, log, msgHist }, ...args)
+                callback({ client, log, msgHist, tokens }, ...args)
             } catch (error) {
                 log('[Uncaught Error]', error)
             }

src/utils/index.ts

@@ -1,3 +1,5 @@
 // Centralized import index
-export * from './env.js';
-export * from './events.js';
+export * from './env.js'
+export * from './events.js'
+export * from './messageEmbed.js'
+export * from './messageNormal.js'

src/utils/messageEmbed.ts

@@ -0,0 +1,66 @@
+import { EmbedBuilder, Message } from "discord.js";
+import ollama, { ChatResponse } from "ollama";
+
+/**
+ * Method to send replies as normal text on discord like any other user
+ * @param message message sent by the user
+ * @param tokens tokens to run query
+ * @param msgHist message history between user and model
+ */
+export async function embedMessage(
+    message: Message, 
+    tokens: {
+        channel: string,
+        model: string
+    },
+    msgHist: {
+        role: string,
+        content: string
+    }[]
+) {
+    // bot response
+    let response: ChatResponse
+
+    // 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] })
+
+    try {
+        // Attempt to query model for message
+        response = await ollama.chat({
+            model: tokens.model,
+            messages: msgHist,
+            options: {
+                num_thread: 8, // remove if optimization needed further
+                mirostat: 1,
+                mirostat_tau: 2.0,
+                top_k: 70
+            },
+            stream: false
+        })
+
+        const newEmbed = new EmbedBuilder()
+            .setTitle(`Responding to ${message.author.tag}`)
+            .setDescription(response.message.content)
+            .setColor('#00FF00')
+
+        // edit the message
+        sentMessage.edit({ embeds: [newEmbed] })
+    } catch(error: any) {
+        const errorEmbed = new EmbedBuilder()
+            .setTitle(`Responding to ${message.author.tag}`)
+            .setDescription(error.error)
+            .setColor('#00FF00')
+        
+        // send back error
+        sentMessage.edit({ embeds: [errorEmbed] })
+    } 
+
+    // Hope there is a response! undefined otherwie
+    return response!!
+}

src/utils/messageNormal.ts

@@ -0,0 +1,48 @@
+import { Message } from "discord.js";
+import ollama, { ChatResponse } from "ollama";
+
+/**
+ * Method to send replies as normal text on discord like any other user
+ * @param message message sent by the user
+ * @param tokens tokens to run query
+ * @param msgHist message history between user and model
+ */
+export function normalMessage(
+    message: Message, 
+    tokens: {
+        channel: string,
+        model: string
+    },
+    msgHist: {
+        role: string,
+        content: string
+    }[]
+) {
+    // bot's respnse
+    let response: ChatResponse
+
+    message.reply('Generating Response . . .').then(async sentMessage => {
+        try {
+            // Attempt to query model for message
+            response = await ollama.chat({
+                model: tokens.model,
+                messages: msgHist,
+                options: {
+                    num_thread: 8, // remove if optimization needed further
+                    mirostat: 1,
+                    mirostat_tau: 2.0,
+                    top_k: 70
+                },
+                stream: false
+            })
+            
+            // edit the 'generic' response to new message
+            sentMessage.edit(response.message.content)
+        } catch(error: any) {
+            sentMessage.edit(error.error)
+        }
+    })
+
+    // Hope there is a response, force client to believe
+    return response!!
+}

src/utils/streamParse.ts

@@ -0,0 +1,23 @@
+import { AxiosResponse } from "axios";
+
+/**
+ * When running a /api/chat stream, the output needs to be parsed into an array of objects
+ * @param stream Axios response to from Ollama
+ */
+export function parseStream(stream: AxiosResponse<any, any>) {
+    // split string by newline
+    const keywordObjects: string[] = stream.data.trim().split('\n')
+
+    // parse string and load them into objects
+    const keywordsArray: {
+        model: string,
+        created_at: string,
+        message: {
+            role: string,
+            content: string
+        },
+        done: boolean
+    }[] = keywordObjects.map((keywordString) => JSON.parse(keywordString))
+
+    return keywordsArray
+}