Kumi
15a93d8231
Enhanced bot flexibility by enabling the specification of room IDs in the allowed users' list, broadening access control capabilities. This change allows for more granular control over who can interact with the bot, particularly useful in scenarios where the bot's usage needs to be restricted to specific rooms. Additionally, updated documentation and configurations reflect the inclusion of new AI models and self-hosted API support, catering to a wider range of use cases and setups. The README.md and config.dist.ini files have been updated to offer clearer guidance on setup, configuration, and troubleshooting, aiming to improve user experience and ease of deployment. - Introduced the ability for room-specific bot access, enhancing user and room management flexibility. - Expanded AI model support, including `gpt-4o` and `ollama`, increases the bot's versatility and application scenarios. - Updated Python version compatibility to 3.12 to ensure users are leveraging the latest language features and improvements. - Improved troubleshooting documentation to assist users in resolving common issues more efficiently.
215 lines
No EOL
6.3 KiB
INI
215 lines
No EOL
6.3 KiB
INI
# Copy this file to config.ini and replace the values below to match your needs
|
||
#
|
||
# The values that are not commented have to be set, everything else comes with
|
||
# sensible defaults.
|
||
|
||
###############################################################################
|
||
|
||
[GPTBot]
|
||
|
||
# Some way for the user to contact you.
|
||
# Ideally, either your personal user ID or a support room
|
||
# If this is your user ID and Debug is 1, any errors that occur when using the script will be reported to you in detail
|
||
#
|
||
Operator = Contact details not set
|
||
|
||
# Enable debug mode
|
||
# Will send error tracebacks to you (= Operator above) if an error occurs processing a message from you
|
||
# Defaults to 0 (= off)
|
||
#
|
||
# Debug = 1
|
||
|
||
# The default room name used by the !newroom command
|
||
# Defaults to GPTBot if not set
|
||
#
|
||
# DefaultRoomName = GPTBot
|
||
|
||
# Contents of a special message sent to the GPT API with every request.
|
||
# Can be used to give the bot some context about the environment it's running in
|
||
#
|
||
# SystemMessage = You are a helpful bot.
|
||
|
||
# Force inclusion of the SystemMessage defined above if one is defined on per-room level
|
||
# If no custom message is defined for the room, SystemMessage is always included
|
||
#
|
||
# ForceSystemMessage = 0
|
||
|
||
# Path to a custom logo
|
||
# Used as room/space image and profile picture
|
||
# Defaults to logo.png in assets directory
|
||
#
|
||
# Logo = assets/logo.png
|
||
|
||
# Display name for the bot
|
||
#
|
||
# DisplayName = GPTBot
|
||
|
||
# A list of allowed users
|
||
# If not defined, everyone is allowed to use the bot (so you should really define this)
|
||
# Use the "*:homeserver.matrix" syntax to allow everyone on a given homeserver
|
||
# Alternatively, you can also specify a room ID to allow everyone in the room to use the bot within that room
|
||
#
|
||
# AllowedUsers = ["*:matrix.local", "!roomid:matrix.local"]
|
||
|
||
# Minimum level of log messages that should be printed
|
||
# Available log levels in ascending order: trace, debug, info, warning, error, critical
|
||
# Defaults to info
|
||
#
|
||
LogLevel = info
|
||
|
||
###############################################################################
|
||
|
||
[OpenAI]
|
||
|
||
# The Chat Completion model you want to use.
|
||
#
|
||
# Unless you are in the GPT-4 beta (if you don't know - you aren't),
|
||
# leave this as the default value (gpt-3.5-turbo)
|
||
#
|
||
# Model = gpt-3.5-turbo
|
||
|
||
# The Image Generation model you want to use.
|
||
#
|
||
# ImageModel = dall-e-2
|
||
|
||
# Your OpenAI API key
|
||
#
|
||
# Find this in your OpenAI account:
|
||
# https://platform.openai.com/account/api-keys
|
||
#
|
||
# This may not be required for self-hosted models – in that case, just leave it
|
||
# as it is.
|
||
#
|
||
APIKey = sk-yoursecretkey
|
||
|
||
# The maximum amount of input sent to the API
|
||
#
|
||
# In conjunction with MaxMessage, this determines how much context (= previous
|
||
# messages) you can send with your query.
|
||
#
|
||
# If you set this too high, the responses you receive will become shorter the
|
||
# longer the conversation gets.
|
||
#
|
||
# https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them
|
||
#
|
||
# MaxTokens = 3000
|
||
|
||
# The maximum number of messages in the room that will be considered as context
|
||
#
|
||
# By default, the last (up to) 20 messages will be sent as context, in addition
|
||
# to the system message and the current query itself.
|
||
#
|
||
# MaxMessages = 20
|
||
|
||
# The base URL of the OpenAI API
|
||
#
|
||
# Setting this allows you to use a self-hosted AI model for chat completions
|
||
# using something like llama-cpp-python or ollama
|
||
#
|
||
# BaseURL = https://openai.local/v1
|
||
|
||
# Whether to force the use of tools in the chat completion model
|
||
#
|
||
# Currently, only gpt-3.5-turbo supports tools. If you set this to 1, the bot
|
||
# will use that model for tools even if you have a different model set as the
|
||
# default. It will only generate the final result using the default model.
|
||
#
|
||
# ForceTools = 0
|
||
|
||
# Whether to emulate tools in the chat completion model
|
||
#
|
||
# This will make the bot use the default model to *emulate* tools. This is
|
||
# useful if you want to use a model that doesn't support tools, but still want
|
||
# to be able to use tools. However, this may cause all kinds of weird results.
|
||
#
|
||
# EmulateTools = 0
|
||
|
||
###############################################################################
|
||
|
||
[WolframAlpha]
|
||
|
||
# An API key for Wolfram|Alpha
|
||
# Request one at https://developer.wolframalpha.com
|
||
#
|
||
# Leave unset to disable Wolfram|Alpha integration (`!gptbot calculate`)
|
||
#
|
||
#APIKey = YOUR-APIKEY
|
||
|
||
###############################################################################
|
||
|
||
[Matrix]
|
||
|
||
# The URL to your Matrix homeserver
|
||
#
|
||
# If you are using Pantalaimon, this should be the URL of your Pantalaimon
|
||
# instance, not the Matrix homeserver itself.
|
||
#
|
||
Homeserver = https://matrix.local
|
||
|
||
# An Access Token for the user your bot runs as
|
||
#
|
||
# See https://www.matrix.org/docs/guides/client-server-api#login
|
||
# for information on how to obtain this value
|
||
#
|
||
AccessToken = syt_yoursynapsetoken
|
||
|
||
# Instead of an Access Token, you can also use a User ID and password
|
||
# to log in. Upon first run, the bot will automatically turn this into
|
||
# an Access Token and store it in the config file, and remove the
|
||
# password from the config file.
|
||
#
|
||
# This is particularly useful if you are using Pantalaimon, where this
|
||
# is the only (easy) way to generate an Access Token.
|
||
#
|
||
# UserID = @gptbot:matrix.local
|
||
# Password = yourpassword
|
||
|
||
|
||
###############################################################################
|
||
|
||
[Database]
|
||
|
||
# Path of the main database
|
||
# Used to "remember" settings, etc.
|
||
#
|
||
Path = database.db
|
||
|
||
###############################################################################
|
||
|
||
[TrackingMore]
|
||
|
||
# API key for TrackingMore
|
||
# If not defined, the bot will not be able to provide parcel tracking
|
||
#
|
||
# APIKey = abcde-fghij-klmnop
|
||
|
||
###############################################################################
|
||
|
||
[Replicate]
|
||
|
||
# API key for replicate.com
|
||
# Can be used to run lots of different AI models
|
||
# If not defined, the features that depend on it are not available
|
||
#
|
||
# APIKey = r8_alotoflettersandnumbershere
|
||
|
||
###############################################################################
|
||
|
||
[HuggingFace]
|
||
|
||
# API key for Hugging Face
|
||
# Can be used to run lots of different AI models
|
||
# If not defined, the features that depend on it are not available
|
||
#
|
||
# APIKey = __________________________
|
||
|
||
###############################################################################
|
||
|
||
[OpenWeatherMap]
|
||
|
||
# API key for OpenWeatherMap
|
||
# If not defined, the bot will be unable to provide weather information
|
||
#
|
||
# APIKey = __________________________
|
||
|
||
############################################################################### |