mirror of
https://github.com/kevinthedang/discord-ollama.git
synced 2025-12-12 19:56:06 -05:00
Compare commits
3 Commits
master
...
feature/lo
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
be6c64be82 | ||
|
|
427c1ecd3d | ||
|
|
5eda32b185 |
@@ -7,7 +7,7 @@ services:
|
|||||||
build: ./ # find docker file in designated path
|
build: ./ # find docker file in designated path
|
||||||
container_name: discord
|
container_name: discord
|
||||||
restart: always # rebuild container always
|
restart: always # rebuild container always
|
||||||
image: kevinthedang/discord-ollama:0.8.7
|
image: kevinthedang/discord-ollama:0.8.6
|
||||||
environment:
|
environment:
|
||||||
CLIENT_TOKEN: ${CLIENT_TOKEN}
|
CLIENT_TOKEN: ${CLIENT_TOKEN}
|
||||||
OLLAMA_IP: ${OLLAMA_IP}
|
OLLAMA_IP: ${OLLAMA_IP}
|
||||||
|
|||||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "discord-ollama",
|
"name": "discord-ollama",
|
||||||
"version": "0.8.7",
|
"version": "0.8.5",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "discord-ollama",
|
"name": "discord-ollama",
|
||||||
"version": "0.8.7",
|
"version": "0.8.5",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"discord.js": "^14.20.0",
|
"discord.js": "^14.20.0",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "discord-ollama",
|
"name": "discord-ollama",
|
||||||
"version": "0.8.7",
|
"version": "0.8.6",
|
||||||
"description": "Ollama Integration into discord",
|
"description": "Ollama Integration into discord",
|
||||||
"main": "build/index.js",
|
"main": "build/index.js",
|
||||||
"exports": "./build/index.js",
|
"exports": "./build/index.js",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { Client, GatewayIntentBits } from 'discord.js'
|
import { Client, GatewayIntentBits } from 'discord.js'
|
||||||
import { Ollama } from 'ollama'
|
import { Ollama } from 'ollama'
|
||||||
import { Queue } from './queues/queue.js'
|
import { Queue } from './components/index.js'
|
||||||
import { UserMessage, registerEvents } from './utils/index.js'
|
import { UserMessage, registerEvents } from './utils/index.js'
|
||||||
import Events from './events/index.js'
|
import Events from './events/index.js'
|
||||||
import Keys from './keys.js'
|
import Keys from './keys.js'
|
||||||
@@ -23,11 +23,8 @@ export const ollama = new Ollama({
|
|||||||
// Create Queue managed by Events
|
// Create Queue managed by Events
|
||||||
const messageHistory: Queue<UserMessage> = new Queue<UserMessage>
|
const messageHistory: Queue<UserMessage> = new Queue<UserMessage>
|
||||||
|
|
||||||
// Create Channel History Queue managed by Events
|
|
||||||
const channelMessageHistory: Queue<UserMessage> = new Queue<UserMessage>
|
|
||||||
|
|
||||||
// register all events
|
// register all events
|
||||||
registerEvents(client, Events, messageHistory, channelMessageHistory, ollama, Keys.defaultModel)
|
registerEvents(client, Events, messageHistory, ollama, Keys.defaultModel)
|
||||||
|
|
||||||
// Try to log in the client
|
// Try to log in the client
|
||||||
await client.login(Keys.clientToken)
|
await client.login(Keys.clientToken)
|
||||||
|
|||||||
46
src/components/binder.ts
Normal file
46
src/components/binder.ts
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
|
||||||
|
/**
|
||||||
|
* @class Logger
|
||||||
|
* @description A class to handle logging messages
|
||||||
|
* @method log
|
||||||
|
*/
|
||||||
|
export class Logger {
|
||||||
|
private logPrefix: string = ''
|
||||||
|
private type: string = 'log'
|
||||||
|
|
||||||
|
private constructPrefix(component?: string, method?: string): string {
|
||||||
|
let prefix = this.type.toUpperCase()
|
||||||
|
|
||||||
|
if (component) {
|
||||||
|
prefix += ` [${component}`
|
||||||
|
if (method) prefix += `: ${method}`
|
||||||
|
prefix += ']'
|
||||||
|
}
|
||||||
|
|
||||||
|
return prefix
|
||||||
|
}
|
||||||
|
|
||||||
|
public bind(component?: string, method?: string): CallableFunction {
|
||||||
|
let tempPrefix = this.constructPrefix(component, method)
|
||||||
|
|
||||||
|
if (tempPrefix !== this.logPrefix) this.logPrefix = tempPrefix
|
||||||
|
|
||||||
|
switch (this.type) {
|
||||||
|
case 'warn':
|
||||||
|
return console.warn.bind(console, this.logPrefix)
|
||||||
|
case 'error':
|
||||||
|
return console.error.bind(console, this.logPrefix)
|
||||||
|
case 'log':
|
||||||
|
default:
|
||||||
|
return console.log.bind(console, this.logPrefix)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public log(type: string, message: unknown, component?: string, method?: string): void {
|
||||||
|
if (type && type !== this.type) this.type = type
|
||||||
|
|
||||||
|
let log = this.bind(component, method)
|
||||||
|
|
||||||
|
log(message)
|
||||||
|
}
|
||||||
|
}
|
||||||
2
src/components/index.ts
Normal file
2
src/components/index.ts
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
export * from './queue.js'
|
||||||
|
export * from './binder.js'
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
import { TextChannel } from 'discord.js'
|
import { TextChannel } from 'discord.js'
|
||||||
import { event, Events, normalMessage, UserMessage, clean, addToChannelContext } from '../utils/index.js'
|
|
||||||
import {
|
import {
|
||||||
|
event, Events, normalMessage, UserMessage, clean,
|
||||||
getChannelInfo, getServerConfig, getUserConfig, openChannelInfo,
|
getChannelInfo, getServerConfig, getUserConfig, openChannelInfo,
|
||||||
openConfig, UserConfig, getAttachmentData, getTextFileAttachmentData
|
openConfig, UserConfig, getAttachmentData, getTextFileAttachmentData
|
||||||
} from '../utils/index.js'
|
} from '../utils/index.js'
|
||||||
@@ -11,7 +11,7 @@ import {
|
|||||||
*
|
*
|
||||||
* @param message the message received from the channel
|
* @param message the message received from the channel
|
||||||
*/
|
*/
|
||||||
export default event(Events.MessageCreate, async ({ log, msgHist, channelHistory, ollama, client, defaultModel }, message) => {
|
export default event(Events.MessageCreate, async ({ log, msgHist, ollama, client, defaultModel }, message) => {
|
||||||
const clientId = client.user!!.id
|
const clientId = client.user!!.id
|
||||||
let cleanedMessage = clean(message.content, clientId)
|
let cleanedMessage = clean(message.content, clientId)
|
||||||
log(`Message \"${cleanedMessage}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
|
log(`Message \"${cleanedMessage}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
|
||||||
@@ -19,61 +19,6 @@ export default event(Events.MessageCreate, async ({ log, msgHist, channelHistory
|
|||||||
// Do not respond if bot talks in the chat
|
// Do not respond if bot talks in the chat
|
||||||
if (message.author.username === message.client.user.username) return
|
if (message.author.username === message.client.user.username) return
|
||||||
|
|
||||||
// Save User Chat even if not for the bot
|
|
||||||
let channelContextHistory: UserMessage[] = await new Promise((resolve) => {
|
|
||||||
getChannelInfo(`${message.channelId}-context.json`, (channelInfo) => {
|
|
||||||
if (channelInfo?.messages)
|
|
||||||
resolve(channelInfo.messages)
|
|
||||||
else {
|
|
||||||
log(`Channel/Thread ${message.channel}-context does not exist. File will be created shortly...`)
|
|
||||||
resolve([])
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
if (channelContextHistory.length === 0) {
|
|
||||||
channelContextHistory = await new Promise((resolve) => {
|
|
||||||
addToChannelContext(message.channelId,
|
|
||||||
message.channel as TextChannel
|
|
||||||
)
|
|
||||||
getChannelInfo(`${message.channelId}-context.json`, (channelInfo) => {
|
|
||||||
if (channelInfo?.messages)
|
|
||||||
resolve(channelInfo.messages)
|
|
||||||
else {
|
|
||||||
log(`Channel/Thread ${message.channel}-context does not exist. File will be created shortly...`)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set Channel History Queue
|
|
||||||
channelHistory.setQueue(channelContextHistory)
|
|
||||||
|
|
||||||
// get message attachment if exists
|
|
||||||
const attachment = message.attachments.first()
|
|
||||||
let messageAttachment: string[] = []
|
|
||||||
|
|
||||||
if (attachment && attachment.name?.endsWith(".txt"))
|
|
||||||
cleanedMessage += ' ' + await getTextFileAttachmentData(attachment)
|
|
||||||
else if (attachment)
|
|
||||||
messageAttachment = await getAttachmentData(attachment)
|
|
||||||
|
|
||||||
while (channelHistory.size() >= channelHistory.capacity) channelHistory.dequeue()
|
|
||||||
|
|
||||||
// push user response to channel history
|
|
||||||
console.log
|
|
||||||
channelHistory.enqueue({
|
|
||||||
role: 'user',
|
|
||||||
content: cleanedMessage,
|
|
||||||
images: messageAttachment || []
|
|
||||||
})
|
|
||||||
|
|
||||||
// Store in Channel Context
|
|
||||||
addToChannelContext(message.channelId,
|
|
||||||
message.channel as TextChannel,
|
|
||||||
channelHistory.getItems()
|
|
||||||
)
|
|
||||||
|
|
||||||
// Only respond if message mentions the bot
|
// Only respond if message mentions the bot
|
||||||
if (!message.mentions.has(clientId)) return
|
if (!message.mentions.has(clientId)) return
|
||||||
|
|
||||||
@@ -194,6 +139,15 @@ export default event(Events.MessageCreate, async ({ log, msgHist, channelHistory
|
|||||||
if (!userConfig)
|
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.`)
|
throw new Error(`Failed to initialize User Preference for **${message.author.username}**.\n\nIt's likely you do not have a model set. Please use the \`switch-model\` command to do that.`)
|
||||||
|
|
||||||
|
// get message attachment if exists
|
||||||
|
const attachment = message.attachments.first()
|
||||||
|
let messageAttachment: string[] = []
|
||||||
|
|
||||||
|
if (attachment && attachment.name?.endsWith(".txt"))
|
||||||
|
cleanedMessage += await getTextFileAttachmentData(attachment)
|
||||||
|
else if (attachment)
|
||||||
|
messageAttachment = await getAttachmentData(attachment)
|
||||||
|
|
||||||
const model: string = userConfig.options['switch-model']
|
const model: string = userConfig.options['switch-model']
|
||||||
|
|
||||||
// set up new queue
|
// set up new queue
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import type { ClientEvents, Awaitable, Client } from 'discord.js'
|
import type { ClientEvents, Awaitable, Client } from 'discord.js'
|
||||||
import { Ollama } from 'ollama'
|
import { Ollama } from 'ollama'
|
||||||
import { Queue } from '../queues/queue.js'
|
import { Queue } from '../components/index.js'
|
||||||
|
|
||||||
// Export events through here to reduce amount of imports
|
// Export events through here to reduce amount of imports
|
||||||
export { Events } from 'discord.js'
|
export { Events } from 'discord.js'
|
||||||
@@ -37,7 +37,6 @@ export interface EventProps {
|
|||||||
client: Client,
|
client: Client,
|
||||||
log: LogMethod,
|
log: LogMethod,
|
||||||
msgHist: Queue<UserMessage>,
|
msgHist: Queue<UserMessage>,
|
||||||
channelHistory: Queue<UserMessage>,
|
|
||||||
ollama: Ollama,
|
ollama: Ollama,
|
||||||
defaultModel: String
|
defaultModel: String
|
||||||
}
|
}
|
||||||
@@ -79,7 +78,6 @@ export function registerEvents(
|
|||||||
client: Client,
|
client: Client,
|
||||||
events: Event[],
|
events: Event[],
|
||||||
msgHist: Queue<UserMessage>,
|
msgHist: Queue<UserMessage>,
|
||||||
channelHistory: Queue<UserMessage>,
|
|
||||||
ollama: Ollama,
|
ollama: Ollama,
|
||||||
defaultModel: String
|
defaultModel: String
|
||||||
): void {
|
): void {
|
||||||
@@ -90,7 +88,7 @@ export function registerEvents(
|
|||||||
|
|
||||||
// Handle Errors, call callback, log errors as needed
|
// Handle Errors, call callback, log errors as needed
|
||||||
try {
|
try {
|
||||||
callback({ client, log, msgHist, channelHistory, ollama, defaultModel }, ...args)
|
callback({ client, log, msgHist, ollama, defaultModel }, ...args)
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
log('[Uncaught Error]', error)
|
log('[Uncaught Error]', error)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -56,39 +56,6 @@ export async function clearChannelInfo(filename: string, channel: TextChannel, u
|
|||||||
return cleanedHistory
|
return cleanedHistory
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function addToChannelContext(filename: string, channel : TextChannel | ThreadChannel, messages: UserMessage[] = []): Promise<void> {
|
|
||||||
const fullFileName = `data/${filename}-context.json`
|
|
||||||
if (fs.existsSync(fullFileName)) {
|
|
||||||
fs.readFile(fullFileName, 'utf8', (error, data) => {
|
|
||||||
if (error)
|
|
||||||
console.log(`[Error: addToChannelContext] Incorrect file format`)
|
|
||||||
else {
|
|
||||||
const object = JSON.parse(data)
|
|
||||||
if (object['messages'].length === 0)
|
|
||||||
object['messages'] = messages as []
|
|
||||||
else if (object['messages'].length !== 0 && messages.length !== 0)
|
|
||||||
object['messages'] = messages as []
|
|
||||||
fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
|
|
||||||
}
|
|
||||||
})
|
|
||||||
} else { // channel context does not exist, create it
|
|
||||||
const object: Configuration = JSON.parse(
|
|
||||||
`{
|
|
||||||
\"id\": \"${channel?.id}\",
|
|
||||||
\"name\": \"${channel?.name}\",
|
|
||||||
\"messages\": []
|
|
||||||
}`
|
|
||||||
)
|
|
||||||
|
|
||||||
const directory = path.dirname(fullFileName)
|
|
||||||
if (!fs.existsSync(directory))
|
|
||||||
fs.mkdirSync(directory, { recursive: true })
|
|
||||||
|
|
||||||
fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
|
|
||||||
console.log(`[Util: addToChannelContext] Created '${fullFileName}' in working directory`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Method to open the channel history
|
* Method to open the channel history
|
||||||
*
|
*
|
||||||
@@ -97,7 +64,7 @@ export async function addToChannelContext(filename: string, channel : TextChanne
|
|||||||
* @param user the user's name
|
* @param user the user's name
|
||||||
* @param messages their messages
|
* @param messages their messages
|
||||||
*/
|
*/
|
||||||
export async function openChannelInfo(filename: string, channel: TextChannel | ThreadChannel, user: string, messages: UserMessage[] = []): Promise<void> {
|
export async function openChannelInfo(this: any, filename: string, channel: TextChannel | ThreadChannel, user: string, messages: UserMessage[] = []): Promise<void> {
|
||||||
const fullFileName = `data/${filename}-${user}.json`
|
const fullFileName = `data/${filename}-${user}.json`
|
||||||
if (fs.existsSync(fullFileName)) {
|
if (fs.existsSync(fullFileName)) {
|
||||||
fs.readFile(fullFileName, 'utf8', (error, data) => {
|
fs.readFile(fullFileName, 'utf8', (error, data) => {
|
||||||
@@ -128,7 +95,7 @@ export async function openChannelInfo(filename: string, channel: TextChannel | T
|
|||||||
|
|
||||||
// only creating it, no need to add anything
|
// only creating it, no need to add anything
|
||||||
fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
|
fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
|
||||||
console.log(`[Util: openChannelInfo] Created '${fullFileName}' in working directory`)
|
console.log(`[Util: ${this.name}] Created '${fullFileName}' in working directory`)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import path from 'path'
|
|||||||
* @param value new value to assign
|
* @param value new value to assign
|
||||||
*/
|
*/
|
||||||
// add type of change (server, user)
|
// add type of change (server, user)
|
||||||
export function openConfig(filename: string, key: string, value: any) {
|
export function openConfig(this: any, filename: string, key: string, value: any) {
|
||||||
const fullFileName = `data/${filename}`
|
const fullFileName = `data/${filename}`
|
||||||
|
|
||||||
// check if the file exists, if not then make the config file
|
// check if the file exists, if not then make the config file
|
||||||
@@ -41,7 +41,7 @@ export function openConfig(filename: string, key: string, value: any) {
|
|||||||
fs.mkdirSync(directory, { recursive: true })
|
fs.mkdirSync(directory, { recursive: true })
|
||||||
|
|
||||||
fs.writeFileSync(`data/${filename}`, JSON.stringify(object, null, 2))
|
fs.writeFileSync(`data/${filename}`, JSON.stringify(object, null, 2))
|
||||||
console.log(`[Util: openConfig] Created '${filename}' in working directory`)
|
console.log(`[Util: ${this.name}] Created '${filename}' in working directory`)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
import { ChatResponse } from "ollama"
|
import { ChatResponse, AbortableAsyncIterator } from "ollama"
|
||||||
import { ChatParams } from "../index.js"
|
import { ChatParams } from "../index.js"
|
||||||
import { AbortableAsyncIterator } from "ollama/src/utils.js"
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Method to query the Ollama client for async generation
|
* Method to query the Ollama client for async generation
|
||||||
|
|||||||
@@ -1,8 +1,7 @@
|
|||||||
import { Message, SendableChannels } from 'discord.js'
|
import { Message, SendableChannels } from 'discord.js'
|
||||||
import { ChatResponse, Ollama } from 'ollama'
|
import { ChatResponse, Ollama, AbortableAsyncIterator } from 'ollama'
|
||||||
import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
|
import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
|
||||||
import { Queue } from '../queues/queue.js'
|
import { Queue } from '../components/index.js'
|
||||||
import { AbortableAsyncIterator } from 'ollama/src/utils.js'
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Method to send replies as normal text on discord like any other user
|
* Method to send replies as normal text on discord like any other user
|
||||||
@@ -11,6 +10,7 @@ import { AbortableAsyncIterator } from 'ollama/src/utils.js'
|
|||||||
* @param msgHist message history between user and model
|
* @param msgHist message history between user and model
|
||||||
*/
|
*/
|
||||||
export async function normalMessage(
|
export async function normalMessage(
|
||||||
|
this: any,
|
||||||
message: Message,
|
message: Message,
|
||||||
ollama: Ollama,
|
ollama: Ollama,
|
||||||
model: string,
|
model: string,
|
||||||
@@ -56,10 +56,6 @@ export async function normalMessage(
|
|||||||
response = await blockResponse(params)
|
response = await blockResponse(params)
|
||||||
result = response.message.content
|
result = response.message.content
|
||||||
|
|
||||||
// check if there is a <think>...</think> sequence from the bot.
|
|
||||||
if (hasThinking(result))
|
|
||||||
result = result.replace(/<think>[\s\S]*?<\/think>/g, '').trim()
|
|
||||||
|
|
||||||
// check if message length > discord max for normal messages
|
// check if message length > discord max for normal messages
|
||||||
if (result.length > 2000) {
|
if (result.length > 2000) {
|
||||||
sentMessage.edit(result.slice(0, 2000))
|
sentMessage.edit(result.slice(0, 2000))
|
||||||
@@ -77,19 +73,14 @@ export async function normalMessage(
|
|||||||
sentMessage.edit(result)
|
sentMessage.edit(result)
|
||||||
}
|
}
|
||||||
} catch (error: any) {
|
} catch (error: any) {
|
||||||
console.log(`[Util: messageNormal] Error creating message: ${error.message}`)
|
console.log(`[Util: ${this.name}] Error creating message: ${error.message}`)
|
||||||
if (error.message.includes('fetch failed'))
|
if (error.message.includes('try pulling it first'))
|
||||||
error.message = 'Missing ollama service on machine'
|
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 if (error.message.includes('try pulling it first'))
|
else
|
||||||
error.message = `You do not have the ${model} downloaded. Ask an admin to pull it using the \`pull-model\` command.`
|
sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
|
||||||
sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
|
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
// return the string representation of ollama query response
|
// return the string representation of ollama query response
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
function hasThinking(message: string): boolean {
|
|
||||||
return /<think>[\s\S]*?<\/think>/i.test(message)
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import { describe, expect, it } from 'vitest'
|
import { describe, expect, it } from 'vitest'
|
||||||
import { Queue } from '../src/queues/queue.js'
|
import { Queue } from '../src/components/index.js'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Queue test suite, tests the Queue class
|
* Queue test suite, tests the Queue class
|
||||||
|
|||||||
Reference in New Issue
Block a user