Home

If you have any questions, feel free to open an issue or join our matrix room:
https://matrix.to/#/#public:matrix.qqs.tw

Glossary
*: required

parameter
homeserver*	your matrix server address
user_id*	your matrix account name like @xxx.matrix.org
password	account password
access_token	access_token for specific logged in session, can get it from element web
device_id	your device id(aka session id)(can use a fake one if login via password)
room_id	if a room_id is not set bot will work on the rooms it is in
import_keys_path	location of the E2E room keys
import_keys_password	E2E room keys password
openai_api_key	openai api key
gpt_api_endpoint	official or self-host chatgpt api endpoint
gpt_model	str, gpt-3.5-turbo
max_tokens	int, 4000
top_p	float, 1.0
presence_penalty	float, 0.0
frequency_penalty	float, 0.0
reply_count	int, 1
temperature	float, 0.8
system_prompt	str, You are ChatGPT, a large language model trained by OpenAI. Respond conversationally
lc_admin	list, ["@admin:xxxxx.org", "@admin2:xxxx.org"]
image_generation_endpoint	str, official DALL-E or self-host image generation endpoint
image_generation_backend	str, openai or sdwui or localai
image_generation_size	str, 512x512
image_format	str, jpeg or webp or png, leave blank for jpeg
sdwui_steps	int, 20 by default
sdwui_sampler_name	str, Euler a by default
sdwui_cfg_scale	float, 7 by default
timeout	float, 120.0

Use either access_token or user_id+password to login

E2EE room keys can be exported from element-web.

To make bot works in E2EE room, you should use user_id+password to login and use a fresh device_id and then import E2EE room keys exported from element-web.

---

Want to liberate your hands? Try our matrix-stt-bot