mirror of
https://github.com/matrixgpt/matrix-chatgpt-bot.git
synced 2024-09-30 13:05:50 +00:00
Added chatgpt temperature environment variable (#162)
* added chatgpt temperature enviroment variable * accidentally use float instead of number * fixed inline * Updated the readme * Updated the env example --------- Co-authored-by: D <>
This commit is contained in:
parent
b11d566ecb
commit
8efd3f9491
@ -13,6 +13,8 @@ CHATGPT_API_MODEL=gpt-3.5-turbo
|
|||||||
#CHATGPT_IGNORE_MEDIA=false
|
#CHATGPT_IGNORE_MEDIA=false
|
||||||
# (Optional) You can change the api url to use another (OpenAI-compatible) API endpoint
|
# (Optional) You can change the api url to use another (OpenAI-compatible) API endpoint
|
||||||
#CHATGPT_REVERSE_PROXY=https://api.openai.com/v1/chat/completions
|
#CHATGPT_REVERSE_PROXY=https://api.openai.com/v1/chat/completions
|
||||||
|
# (Optional) Set the temperature of the model. 0.0 is deterministic, 1.0 is very creative.
|
||||||
|
# CHATGPT_TEMPERATURE=0.8
|
||||||
|
|
||||||
# Set data store settings
|
# Set data store settings
|
||||||
KEYV_BACKEND=file
|
KEYV_BACKEND=file
|
||||||
|
10
README.md
10
README.md
@ -162,6 +162,16 @@ Once the bot has started succesfully, it will output the following information t
|
|||||||
## I use Docker but I don't see any console output
|
## I use Docker but I don't see any console output
|
||||||
You most likely need to view the logs by running `docker logs matrix-chatgpt-bot`
|
You most likely need to view the logs by running `docker logs matrix-chatgpt-bot`
|
||||||
|
|
||||||
|
## How to set the temperature
|
||||||
|
Set the temperature by using CHATGPT_TEMPERATURE in your .env file. The default is 0.8.
|
||||||
|
|
||||||
|
Here are some guidelines for setting the temperature:
|
||||||
|
|
||||||
|
| Temperature Values | Appropriate Tasks | Examples |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Below 0.5 (low) | Tasks requiring a single correct answer or predictable output | Programming |
|
||||||
|
| 0.5-0.9 (medium) | Tasks needing somewhat varied and creative content grounded in reality | E-mail response |
|
||||||
|
| Above 0.9 (high) | Tasks requiring more creative and unpredictable output | Story writing |
|
||||||
|
|
||||||
# Reporting issues
|
# Reporting issues
|
||||||
|
|
||||||
|
@ -36,6 +36,7 @@ export const {
|
|||||||
CHATGPT_PROMPT_PREFIX,
|
CHATGPT_PROMPT_PREFIX,
|
||||||
CHATGPT_IGNORE_MEDIA,
|
CHATGPT_IGNORE_MEDIA,
|
||||||
CHATGPT_REVERSE_PROXY,
|
CHATGPT_REVERSE_PROXY,
|
||||||
|
CHATGPT_TEMPERATURE,
|
||||||
} = parseEnv(process.env, {
|
} = parseEnv(process.env, {
|
||||||
DATA_PATH: { schema: z.string().default("./storage"), description: "Set to /storage/ if using docker, ./storage if running without" },
|
DATA_PATH: { schema: z.string().default("./storage"), description: "Set to /storage/ if using docker, ./storage if running without" },
|
||||||
KEYV_BACKEND: { schema: z.enum(["file", "other"]).default("file"),description: "Set the Keyv backend to 'file' or 'other' if other set KEYV_URL" },
|
KEYV_BACKEND: { schema: z.enum(["file", "other"]).default("file"),description: "Set the Keyv backend to 'file' or 'other' if other set KEYV_URL" },
|
||||||
@ -68,5 +69,6 @@ export const {
|
|||||||
CHATGPT_API_MODEL: { schema: z.string().default(""), description: "The model for the ChatGPT-API to use. Keep in mind that these models will charge your OpenAI account depending on their pricing." },
|
CHATGPT_API_MODEL: { schema: z.string().default(""), description: "The model for the ChatGPT-API to use. Keep in mind that these models will charge your OpenAI account depending on their pricing." },
|
||||||
CHATGPT_PROMPT_PREFIX: { schema: z.string().default('Instructions:\nYou are ChatGPT, a large language model trained by OpenAI.'), description: "Instructions to feed to ChatGPT on startup"},
|
CHATGPT_PROMPT_PREFIX: { schema: z.string().default('Instructions:\nYou are ChatGPT, a large language model trained by OpenAI.'), description: "Instructions to feed to ChatGPT on startup"},
|
||||||
CHATGPT_IGNORE_MEDIA: { schema: z.boolean().default(false), description: "Wether or not the bot should react to non-text messages"},
|
CHATGPT_IGNORE_MEDIA: { schema: z.boolean().default(false), description: "Wether or not the bot should react to non-text messages"},
|
||||||
CHATGPT_REVERSE_PROXY: { schema: z.string().default(""), description: "Change the api url to use another (OpenAI-compatible) API endpoint" }
|
CHATGPT_REVERSE_PROXY: { schema: z.string().default(""), description: "Change the api url to use another (OpenAI-compatible) API endpoint" },
|
||||||
|
CHATGPT_TEMPERATURE: { schema: z.number().default(0.8), description: "Set the temperature for the model" }
|
||||||
});
|
});
|
||||||
|
@ -11,7 +11,7 @@ import {
|
|||||||
DATA_PATH, KEYV_URL, OPENAI_API_KEY, MATRIX_HOMESERVER_URL, MATRIX_ACCESS_TOKEN, MATRIX_AUTOJOIN,
|
DATA_PATH, KEYV_URL, OPENAI_API_KEY, MATRIX_HOMESERVER_URL, MATRIX_ACCESS_TOKEN, MATRIX_AUTOJOIN,
|
||||||
MATRIX_BOT_PASSWORD, MATRIX_BOT_USERNAME, MATRIX_ENCRYPTION, MATRIX_THREADS, CHATGPT_CONTEXT,
|
MATRIX_BOT_PASSWORD, MATRIX_BOT_USERNAME, MATRIX_ENCRYPTION, MATRIX_THREADS, CHATGPT_CONTEXT,
|
||||||
CHATGPT_API_MODEL, KEYV_BOT_STORAGE, KEYV_BACKEND, CHATGPT_PROMPT_PREFIX, MATRIX_WELCOME,
|
CHATGPT_API_MODEL, KEYV_BOT_STORAGE, KEYV_BACKEND, CHATGPT_PROMPT_PREFIX, MATRIX_WELCOME,
|
||||||
CHATGPT_REVERSE_PROXY
|
CHATGPT_REVERSE_PROXY, CHATGPT_TEMPERATURE
|
||||||
} from './env.js'
|
} from './env.js'
|
||||||
import CommandHandler from "./handlers.js"
|
import CommandHandler from "./handlers.js"
|
||||||
import { KeyvStorageProvider } from './storage.js'
|
import { KeyvStorageProvider } from './storage.js'
|
||||||
@ -60,6 +60,7 @@ async function main() {
|
|||||||
const clientOptions = { // (Optional) Parameters as described in https://platform.openai.com/docs/api-reference/completions
|
const clientOptions = { // (Optional) Parameters as described in https://platform.openai.com/docs/api-reference/completions
|
||||||
modelOptions: {
|
modelOptions: {
|
||||||
model: CHATGPT_API_MODEL, // The model is set to gpt-3.5-turbo by default
|
model: CHATGPT_API_MODEL, // The model is set to gpt-3.5-turbo by default
|
||||||
|
temperature: CHATGPT_TEMPERATURE,
|
||||||
},
|
},
|
||||||
promptPrefix: wrapPrompt(CHATGPT_PROMPT_PREFIX),
|
promptPrefix: wrapPrompt(CHATGPT_PROMPT_PREFIX),
|
||||||
debug: false,
|
debug: false,
|
||||||
|
Loading…
Reference in New Issue
Block a user