Merge branch 'master' into release

Upgrade v2.3.0 from upstream.

Author: takuya-o

.github/workflows/docker-image.yml

@@ -2,7 +2,6 @@ name: Docker Image CI
 
 on:
   push:
-    branches: [ "master" ]
     tags: [ 'v*.*.*' ]
 
 env:

README.md

@@ -44,6 +44,7 @@ or when [running the docker image](#using-the-ready-made-docker-image) or when c
 | MATTERMOST_URL       | yes      | `https://mattermost.server`  | The URL to the server. This is used for connecting the bot to the Mattermost API                                                                                                                   |
 | MATTERMOST_TOKEN     | yes      | `abababacdcdcd`              | The authentication token from the logged in mattermost bot                                                                                                                                         |
 | OPENAI_API_KEY       | yes      | `sk-234234234234234234`      | The OpenAI API key to authenticate with OpenAI                                                                                                                                                     |
+| OPENAI_API_BASE      | no       | `http://example.com:8080/v1` | The address of an OpenAI compatible API. Overrides the default base path (`https://api.openai.com`)          |
 | OPENAI_MODEL_NAME    | no       | `gpt-3.5-turbo`              | The OpenAI language model to use, defaults to `gpt-3.5-turbo`                                                                                                                                      |
 | OPENAI_MAX_TOKENS    | no       | `2000`                       | The maximum number of tokens to pass to the OpenAI API, defaults to 2000                                                                                                                           |
 | OPENAI_TEMPERATURE   | no       | `0.2`                        | The sampling temperature to use, between 0 and 2, defaults to 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. |
@@ -66,6 +67,7 @@ or when [running the docker image](#using-the-ready-made-docker-image) or when c
 | PLUGINS              | no       | `graph-plugin, image-plugin` | The enabled plugins of the bot. By default all plugins (grpah-plugin and image-plugin) are enabled.                                                                                                |
 | DEBUG_LEVEL          | no       | `TRACE`                      | a debug level used for logging activity, defaults to `INFO`                                                                                                                                        |
 | BOT_CONTEXT_MSG      | no       | `15`                         | The number of previous messages which are appended to the conversation with ChatGPT, defaults to 100                                                                                               |
+| BOT_INSTRUCTION      | no       | `Act like Elon Musk`         | Extra instruction to give your assistance. How should the assistant behave? |
 
 > **Note**
 > The `YFILES_SERVER_URL` is used for automatically converting text information created by the bot into diagrams.

helm/chatgpt-mattermost-bot/Chart.yaml

@@ -2,6 +2,6 @@ apiVersion: v2
 name: chatgpt-mattermost-bot
 description: A ChatGPT-powered Chatbot for Mattermost
 type: application
-version: 2.1.2
-appVersion: v2.1.2
+version: 2.3.0
+appVersion: v2.3.0
 

helm/chatgpt-mattermost-bot/templates/chatbot-config.yaml

@@ -17,5 +17,4 @@ data:
   DEBUG_LEVEL: "{{ .Values.config.DEBUG_LEVEL | default "INFO"  }}"
   BOT_CONTEXT_MSG: "{{ .Values.config.BOT_CONTEXT_MSG | default "100"  }}"
   NODE_ENV: "{{ .Values.config.NODE_ENV | default "production"  }}"
-
-
+  BOT_INSTRUCTION: "{{ .Values.config.BOT_INSTRUCTION | default ""  }}"

helm/chatgpt-mattermost-bot/values.yaml

@@ -3,7 +3,7 @@ image:
   repository: chatgpt-mattermost-bot
   pullPolicy: IfNotPresent
   # Overrides the image tag whose default is the chart appVersion.
-  tag: "v2.1.2"
+  tag: ""
 
 imagePullSecrets: []
 
@@ -26,6 +26,7 @@ config:                   #   required:   example:                    descriptio
   DEBUG_LEVEL: ""         #   no	        TRACE	                      a debug level used for logging activity, defaults to INFO
   BOT_CONTEXT_MSG: ""     #   no	        15	                        The number of previous messages which are appended to the conversation with ChatGPT, defaults to 100
   NODE_ENV: ""            #   no          development                 The mode NodeJS runs in. Defaults to production
+  BOT_INSTRUCTION: ""     #   no          Act like Elon Musk          Extra instruction to give your assistance. How should the assistant behave?
 
 
 serviceAccount:

package-lock.json

@@ -1,7 +1,6 @@
 {
   "name": "chatgpt-mattermost-bot",
-  "version": "2.1.2",
-  "description": "ChatGPT bot on mattermost",
+  "version": "2.3.0",
   "private": true,
   "keywords": [
     "chatgpt",

package.json

@@ -27,8 +27,9 @@ if (!global.FormData) {
 
 const name = process.env['MATTERMOST_BOTNAME'] || '@chatgpt'
 const contextMsgCount = Number(process.env['BOT_CONTEXT_MSG'] ?? 100)
-export const SYSTEM_MESSAGE_HEADER = '// BOT System Message: '
-export const LIMIT_TOKENS = Number(process.env['MAX_PROMPT_TOKENS'] ?? 2000)
+const additionalBotInstructions = process.env['BOT_INSTRUCTION'] || "You are a helpful assistant. Whenever users asks you for help you will " +
+    "provide them with succinct answers formatted using Markdown. You know the user's name as it is provided within the " +
+    "meta data of the messages."
 
 /* List of all registered plugins */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -41,12 +42,8 @@ const plugins: PluginBase<any>[] = [
 ]
 
 /* The main system instruction for GPT */
-const botInstructions =
-  'Your name is ' +
-  name +
-  ' and you are a helpful assistant. Whenever users asks you for help you will ' +
-  "provide them with succinct answers formatted using Markdown. You know the user's name as it is provided within the " +
-  'meta data of the messages.'
+const botInstructions = "Your name is " + name + ". " + additionalBotInstructions
+botLog.debug({botInstructions: botInstructions})
 
 async function onClientMessage(msg: WebSocketMessage<JSONMessageData>, meId: string) {
   if ((msg.event !== 'posted' && msg.event !== 'post_edited') || !meId) {

src/botservice.ts

@@ -4,9 +4,13 @@ import { PluginBase } from './plugins/PluginBase.js'
 
 import { openAILog as log } from './logging.js'
 
-const apiKey = process.env['OPENAI_API_KEY']
-const azureOpenAiApiKey = process.env['AZURE_OPENAI_API_KEY']
-const azureOpenAiApiVersion = process.env['AZURE_OPENAI_API_VERSION'] ?? '2023-09-01-preview'
+const apiKey = process.env['OPENAI_API_KEY'];
+const basePath = process.env['OPENAI_API_BASE'];
+log.trace({apiKey, basePath})
+
+const configuration = new Configuration({ apiKey, basePath })
+
+const openai = new OpenAIApi(configuration)
 
 const model = process.env['OPENAI_MODEL_NAME'] ?? 'gpt-3.5-turbo'
 const MAX_TOKENS = Number(process.env['OPENAI_MAX_TOKENS'] ?? 2000)