commit
1c2bf7e565
@ -0,0 +1,57 @@
|
||||
# ChatGPT Bot :robot:
|
||||
|
||||
<div style="text-align:center">
|
||||
|
||||
|
||||
|
||||
_(^ AI generated illustration from the ChatGPT Logo)_
|
||||
|
||||
**Simple ChatGPT Bot for a small team or personal use.**
|
||||
|
||||
**Quick Deploy, Easy Config, Simple Usage**
|
||||
|
||||
</div>
|
||||
|
||||
## :book: Features
|
||||
|
||||
- Support `Discord` & `Telegram`
|
||||
- Selectable Chat Mode: Group Chat & Individual
|
||||
- Easy to config
|
||||
- Ready to run: :whale: `docker compose` or :gear: `PM2`
|
||||
- Using Azure OpenAI
|
||||
- Lightweight source code
|
||||
- Flexible development design
|
||||
|
||||
## :speech_balloon: Chat Mode
|
||||
|
||||
| Mode | Name | Description |
|
||||
| :--: | :--------: | --------------------------------------------------------------------------------------------------- |
|
||||
| 1 | Default | Discord bot for group chat, Telegram bot for individual. Suitable for a small team/group of people. |
|
||||
| 2 | Individual | Both Discord bot & Telegram bot will separate chat for each user. (1-to-1 chat) |
|
||||
| 3 | Seamless | All chats of Discord bot and Telegram bot will count as the same conversation. Useful for personal. |
|
||||
|
||||
## :hammer_and_pick: Configuration
|
||||
|
||||
| Config Variable | Data Type | Description |
|
||||
| ------------------------ | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `DISCORD_BOT_TOKEN` | string | The token of the Discord bot. If no token is provided, discord bot will be disabled. |
|
||||
| `DISCORD_ALLOW_CHANNELS` | string | A comma-separated (`,`) whitelist of Discord channel IDs. The bot will only responsive in the channels from the list. |
|
||||
| `TELEGRAM_BOT_TOKEN` | string | The token of the Telegram bot. If no token is provided, telegram bot will be disabled. |
|
||||
| `TELEGRAM_ALLOW_USERS` | string | A comma-separated (`,`) whitelist of Telegram user IDs. The bot will only responsive to the users from the list. |
|
||||
| `AZURE_ENDPOINT` | string | The endpoint URL of the Azure OpenAI service. |
|
||||
| `AZURE_DEPLOYMENT_NAME` | string | The deployment name of the Azure OpenAI service. |
|
||||
| `AZURE_KEY` | string | The key of the Azure OpenAI service. |
|
||||
| `CHAT_MODE` | number | Choose the chat mode. Refer to the [Chat Mode](#speech_balloon-chat-mode) section. |
|
||||
| `ALWAYS_SYSTEM_PROMPT` | boolean | Send system prompt to ChatGPT in each request? This can make ChatGPT keep remember the system prompt to provide better responsive in some cases, but more prompt tokens will be used. |
|
||||
| `SYSTEM_PROMPT` | string | The system prompt for ChatGPT (_optional_) |
|
||||
|
||||
## :bulb: How to use?
|
||||
|
||||
1. You must have enabled the Azure OpenAI services
|
||||
2. You must created a Discord Application / Telegram Bot
|
||||
3. git clone to download the source code
|
||||
4. Copy the `sample.env` file and rename as `.env`
|
||||
5. Edit the config in the `.env` file
|
||||
6. If you want to use :gear: **PM2**, run `yarn run init:pm2`
|
||||
7. If you want to use :whale: **docker compose**, run `yarn run docker` (:warning: This project will not build a docker image, it use the node image to run the bot and manage with docker)
|
||||
8. The bot will be run in the background
|
||||
@ -0,0 +1,13 @@
|
||||
version: '3'
|
||||
|
||||
services:
|
||||
chatgpt_bot:
|
||||
container_name: chatgpt-bot
|
||||
image: node:18
|
||||
volumes:
|
||||
- /srv/chatgpt-bot:/app
|
||||
working_dir: /app
|
||||
command: "yarn run init"
|
||||
restart: unless-stopped
|
||||
#environment: # Set the timezone of the container (Not required, only a good practice for any application)
|
||||
# - TZ=
|
||||
@ -0,0 +1,14 @@
|
||||
module.exports = {
|
||||
apps : [{
|
||||
name : "chatgpt-bot",
|
||||
script: 'build/',
|
||||
watch: true,
|
||||
watch_delay: 1000,
|
||||
watch : "build",
|
||||
// ignore_watch : ["node_modules"],
|
||||
exec_mode: "fork",
|
||||
instances: 1,
|
||||
max_memory_restart: "1G",
|
||||
log_date_format: "YYYY-MM-DD HH:mm:ss Z",
|
||||
}]
|
||||
};
|
||||
@ -0,0 +1,27 @@
|
||||
{
|
||||
"name": "chatgpt-bot-discord-telegram-azure",
|
||||
"version": "1.0.0",
|
||||
"main": "build/index.js",
|
||||
"license": "MIT",
|
||||
"author": "jasonfoknxu <nxu@nxu.biz> (https://nxuweb.net)",
|
||||
"repository": "github:jasonfoknxu/chatgpt-bot-discord-telegram-azure",
|
||||
"scripts": {
|
||||
"start": "node build/index.js",
|
||||
"build": "tsc -p tsconfig.json",
|
||||
"pm2": "pm2 start ecosystem.config.js --no-daemon",
|
||||
"pm2:update": "pm2 startOrReload ecosystem.config.js",
|
||||
"docker": "docker compose up -d",
|
||||
"init:pm2": "yarn install && yarn run build && yarn run pm2",
|
||||
"init": "yarn install && yarn run build && yarn run start"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node-telegram-bot-api": "^0.61.8",
|
||||
"typescript": "^5.2.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"@azure/openai": "^1.0.0-beta.6",
|
||||
"discord.js": "^14.13.0",
|
||||
"dotenv": "^16.3.1",
|
||||
"node-telegram-bot-api": "^0.63.0"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,17 @@
|
||||
# Discord Bot Config
|
||||
DISCORD_BOT_TOKEN=
|
||||
DISCORD_ALLOW_CHANNELS=
|
||||
|
||||
# Telegram Bot Config
|
||||
TELEGRAM_BOT_TOKEN=
|
||||
TELEGRAM_ALLOW_USERS=
|
||||
|
||||
# Azure OpenAI Service Config
|
||||
AZURE_ENDPOINT=
|
||||
AZURE_DEPLOYMENT_NAME=
|
||||
AZURE_KEY=
|
||||
|
||||
# GPT Config
|
||||
CHAT_MODE=1
|
||||
ALWAYS_SYSTEM_PROMPT=false
|
||||
SYSTEM_PROMPT=""
|
||||
@ -0,0 +1,42 @@
|
||||
import * as dotenv from 'dotenv';
|
||||
|
||||
const loadConfig = dotenv.config();
|
||||
if (loadConfig.error) {
|
||||
console.error('[ERROR] Cannot load config');
|
||||
throw loadConfig.error;
|
||||
}
|
||||
|
||||
const parsedConfig = loadConfig.parsed;
|
||||
|
||||
if (!parsedConfig) {
|
||||
console.error('[ERROR] Cannot parse config');
|
||||
throw new Error();
|
||||
}
|
||||
|
||||
interface Config {
|
||||
DISCORD_BOT_TOKEN: string;
|
||||
DISCORD_ALLOW_CHANNELS: string[];
|
||||
TELEGRAM_BOT_TOKEN: string;
|
||||
TELEGRAM_ALLOW_USERS: string[];
|
||||
AZURE_ENDPOINT: string;
|
||||
AZURE_DEPLOYMENT_NAME: string;
|
||||
AZURE_KEY: string;
|
||||
CHAT_MODE: number;
|
||||
ALWAYS_SYSTEM_PROMPT: boolean;
|
||||
SYSTEM_PROMPT: string;
|
||||
}
|
||||
|
||||
const config: Config = {
|
||||
DISCORD_BOT_TOKEN: parsedConfig.DISCORD_BOT_TOKEN,
|
||||
DISCORD_ALLOW_CHANNELS: parsedConfig.DISCORD_ALLOW_CHANNELS.split(','),
|
||||
TELEGRAM_BOT_TOKEN: parsedConfig.TELEGRAM_BOT_TOKEN,
|
||||
TELEGRAM_ALLOW_USERS: parsedConfig.TELEGRAM_ALLOW_USERS.split(','),
|
||||
AZURE_ENDPOINT: parsedConfig.AZURE_ENDPOINT,
|
||||
AZURE_DEPLOYMENT_NAME: parsedConfig.AZURE_DEPLOYMENT_NAME,
|
||||
AZURE_KEY: parsedConfig.AZURE_KEY,
|
||||
CHAT_MODE: parseInt(parsedConfig.CHAT_MODE) ?? 0,
|
||||
ALWAYS_SYSTEM_PROMPT: parsedConfig.ALWAYS_SYSTEM_PROMPT==='true',
|
||||
SYSTEM_PROMPT: parsedConfig.SYSTEM_PROMPT,
|
||||
};
|
||||
|
||||
export { config };
|
||||
@ -0,0 +1,35 @@
|
||||
import { Client, GatewayIntentBits } from 'discord.js';
|
||||
import { config } from './config';
|
||||
import { chat } from './gpt';
|
||||
import { message } from './message';
|
||||
|
||||
const discordBot = async () => {
|
||||
if (!config.DISCORD_BOT_TOKEN) {
|
||||
return;
|
||||
}
|
||||
|
||||
const client = new Client({
|
||||
intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages, GatewayIntentBits.MessageContent],
|
||||
});
|
||||
|
||||
client.on('messageCreate', async (msg) => {
|
||||
if (config.DISCORD_ALLOW_CHANNELS.includes(msg.channelId)) {
|
||||
if (msg.author.bot) return;
|
||||
const gptResult = await chat(msg.content, (config.CHAT_MODE === 2) ? msg.author.id : 'discord');
|
||||
if (!gptResult) {
|
||||
msg.reply(message.request_error);
|
||||
return;
|
||||
}
|
||||
msg.reply(gptResult);
|
||||
}
|
||||
});
|
||||
|
||||
try {
|
||||
await client.login(config.DISCORD_BOT_TOKEN);
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
process.exit(1);
|
||||
}
|
||||
};
|
||||
|
||||
export { discordBot };
|
||||
@ -0,0 +1,37 @@
|
||||
import { OpenAIClient, AzureKeyCredential } from '@azure/openai';
|
||||
import { config } from './config';
|
||||
|
||||
interface GPTMessage {
|
||||
role: 'system' | 'user' | 'assistant' | 'user';
|
||||
content: string;
|
||||
}
|
||||
|
||||
let messages: GPTMessage[] = [];
|
||||
|
||||
let firstMessage = true;
|
||||
const client = new OpenAIClient(config.AZURE_ENDPOINT, new AzureKeyCredential(config.AZURE_KEY));
|
||||
const deploymentName = config.AZURE_DEPLOYMENT_NAME;
|
||||
|
||||
const chat = async (userPrompt: string, from: string = 'bot') => {
|
||||
if (config.ALWAYS_SYSTEM_PROMPT || firstMessage) {
|
||||
messages.push({ role: 'system', content: config.SYSTEM_PROMPT });
|
||||
firstMessage = false;
|
||||
}
|
||||
|
||||
if (!userPrompt || userPrompt.trim() === '') {
|
||||
return null;
|
||||
}
|
||||
|
||||
messages.push({ role: 'user', content: userPrompt });
|
||||
|
||||
const result = await client.getChatCompletions(deploymentName, messages, {
|
||||
user: (config.CHAT_MODE === 3) ? 'bot' : from,
|
||||
});
|
||||
if (!result) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return result.choices[0].message?.content;
|
||||
};
|
||||
|
||||
export { chat };
|
||||
@ -0,0 +1,7 @@
|
||||
import { discordBot } from './discord';
|
||||
import { telegramBot } from './telegram';
|
||||
|
||||
(async () => {
|
||||
await discordBot();
|
||||
await telegramBot();
|
||||
})();
|
||||
@ -0,0 +1,8 @@
|
||||
const message = {
|
||||
user_id: 'User ID: ',
|
||||
unauthorized: 'Sorry, you are not authorized to use this bot.',
|
||||
text_only: 'Sorry, this bot only support text message.',
|
||||
request_error: 'Request failed, please try again later.',
|
||||
};
|
||||
|
||||
export { message };
|
||||
@ -0,0 +1,38 @@
|
||||
import TelegramBot from 'node-telegram-bot-api';
|
||||
import { config } from './config';
|
||||
import { chat } from './gpt';
|
||||
import { message } from './message';
|
||||
|
||||
const telegramBot = async () => {
|
||||
if (!config.TELEGRAM_BOT_TOKEN) {
|
||||
return;
|
||||
}
|
||||
|
||||
const bot = new TelegramBot(config.TELEGRAM_BOT_TOKEN, { polling: true });
|
||||
|
||||
bot.on('message', async (msg) => {
|
||||
const chatId = msg.chat.id;
|
||||
const userId = msg.from?.id;
|
||||
|
||||
if (!userId || !config.TELEGRAM_ALLOW_USERS.includes(userId.toString())) {
|
||||
bot.sendMessage(chatId, message.unauthorized + '\n' + message.user_id + userId);
|
||||
return;
|
||||
}
|
||||
|
||||
const text = msg.text;
|
||||
if (!text) {
|
||||
bot.sendMessage(chatId, message.text_only);
|
||||
return;
|
||||
}
|
||||
|
||||
const gptResult = await chat(text, (config.CHAT_MODE === 3) ? 'telegram' : userId.toString());
|
||||
if (!gptResult) {
|
||||
bot.sendMessage(chatId, message.request_error);
|
||||
return;
|
||||
}
|
||||
|
||||
bot.sendMessage(chatId, gptResult);
|
||||
});
|
||||
};
|
||||
|
||||
export { telegramBot };
|
||||
@ -0,0 +1,109 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
/* Visit https://aka.ms/tsconfig to read more about this file */
|
||||
|
||||
/* Projects */
|
||||
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
|
||||
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
|
||||
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
|
||||
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
|
||||
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
|
||||
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
|
||||
|
||||
/* Language and Environment */
|
||||
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
|
||||
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
|
||||
// "jsx": "preserve", /* Specify what JSX code is generated. */
|
||||
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
|
||||
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
|
||||
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
|
||||
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
|
||||
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
|
||||
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
|
||||
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
|
||||
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
|
||||
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
|
||||
|
||||
/* Modules */
|
||||
"module": "commonjs", /* Specify what module code is generated. */
|
||||
"rootDir": "./src", /* Specify the root folder within your source files. */
|
||||
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
|
||||
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
|
||||
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
|
||||
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
|
||||
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
|
||||
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
|
||||
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
|
||||
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
|
||||
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
|
||||
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
|
||||
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
|
||||
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
|
||||
// "resolveJsonModule": true, /* Enable importing .json files. */
|
||||
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
|
||||
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
|
||||
|
||||
/* JavaScript Support */
|
||||
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
|
||||
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
|
||||
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
|
||||
|
||||
/* Emit */
|
||||
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
|
||||
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
|
||||
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
|
||||
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
|
||||
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
|
||||
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
|
||||
"outDir": "./build", /* Specify an output folder for all emitted files. */
|
||||
// "removeComments": true, /* Disable emitting comments. */
|
||||
// "noEmit": true, /* Disable emitting files from a compilation. */
|
||||
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
|
||||
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
|
||||
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
|
||||
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
|
||||
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
|
||||
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
|
||||
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
|
||||
// "newLine": "crlf", /* Set the newline character for emitting files. */
|
||||
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
|
||||
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
|
||||
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
|
||||
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
|
||||
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
|
||||
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
|
||||
|
||||
/* Interop Constraints */
|
||||
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
|
||||
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
|
||||
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
|
||||
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
|
||||
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
|
||||
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
|
||||
|
||||
/* Type Checking */
|
||||
"strict": true, /* Enable all strict type-checking options. */
|
||||
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
|
||||
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
|
||||
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
|
||||
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
|
||||
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
|
||||
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
|
||||
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
|
||||
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
|
||||
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
|
||||
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
|
||||
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
|
||||
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
|
||||
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
|
||||
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
|
||||
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
|
||||
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
|
||||
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
|
||||
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
|
||||
|
||||
/* Completeness */
|
||||
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
|
||||
"skipLibCheck": true /* Skip type checking all .d.ts files. */
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue