config.dist.ini 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. # Copy this file to config.ini and replace the values below to match your needs
  2. #
  3. # The values that are not commented have to be set, everything else comes with
  4. # sensible defaults.
  5. ###############################################################################
  6. [GPTBot]
  7. # Some way for the user to contact you.
  8. # Ideally, either your personal user ID or a support room
  9. # 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
  10. #
  11. Operator = Contact details not set
  12. # Enable debug mode
  13. # Will send error tracebacks to you (= Operator above) if an error occurs processing a message from you
  14. # Defaults to 0 (= off)
  15. #
  16. # Debug = 1
  17. # The default room name used by the !newroom command
  18. # Defaults to GPTBot if not set
  19. #
  20. # DefaultRoomName = GPTBot
  21. # Contents of a special message sent to the GPT API with every request.
  22. # Can be used to give the bot some context about the environment it's running in
  23. #
  24. # SystemMessage = You are a helpful bot.
  25. # Force inclusion of the SystemMessage defined above if one is defined on per-room level
  26. # If no custom message is defined for the room, SystemMessage is always included
  27. #
  28. # ForceSystemMessage = 0
  29. # Path to a custom logo
  30. # Used as room/space image and profile picture
  31. # Defaults to logo.png in assets directory
  32. #
  33. # Logo = assets/logo.png
  34. # Display name for the bot
  35. #
  36. # DisplayName = GPTBot
  37. # A list of allowed users
  38. # If not defined, everyone is allowed to use the bot
  39. # Use the "*:homeserver.matrix" syntax to allow everyone on a given homeserver
  40. #
  41. # AllowedUsers = ["*:matrix.local"]
  42. # Minimum level of log messages that should be printed
  43. # Available log levels in ascending order: trace, debug, info, warning, error, critical
  44. # Defaults to info
  45. #
  46. LogLevel = info
  47. ###############################################################################
  48. [OpenAI]
  49. # The Chat Completion model you want to use.
  50. #
  51. # Unless you are in the GPT-4 beta (if you don't know - you aren't),
  52. # leave this as the default value (gpt-3.5-turbo)
  53. #
  54. # Model = gpt-3.5-turbo
  55. # The Image Generation model you want to use.
  56. #
  57. # ImageModel = dall-e-2
  58. # Your OpenAI API key
  59. #
  60. # Find this in your OpenAI account:
  61. # https://platform.openai.com/account/api-keys
  62. #
  63. APIKey = sk-yoursecretkey
  64. # The maximum amount of input sent to the API
  65. #
  66. # In conjunction with MaxMessage, this determines how much context (= previous
  67. # messages) you can send with your query.
  68. #
  69. # If you set this too high, the responses you receive will become shorter the
  70. # longer the conversation gets.
  71. #
  72. # https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them
  73. #
  74. # MaxTokens = 3000
  75. # The maximum number of messages in the room that will be considered as context
  76. #
  77. # By default, the last (up to) 20 messages will be sent as context, in addition
  78. # to the system message and the current query itself.
  79. #
  80. # MaxMessages = 20
  81. # The base URL of the OpenAI API
  82. #
  83. # Setting this allows you to use a self-hosted AI model for chat completions
  84. # using something like https://github.com/abetlen/llama-cpp-python
  85. #
  86. # BaseURL = https://openai.local/v1
  87. # Whether to force the use of tools in the chat completion model
  88. #
  89. # Currently, only gpt-3.5-turbo supports tools. If you set this to 1, the bot
  90. # will use that model for tools even if you have a different model set as the
  91. # default. It will only generate the final result using the default model.
  92. #
  93. # ForceTools = 0
  94. ###############################################################################
  95. [WolframAlpha]
  96. # An API key for Wolfram|Alpha
  97. # Request one at https://developer.wolframalpha.com
  98. #
  99. # Leave unset to disable Wolfram|Alpha integration (`!gptbot calculate`)
  100. #
  101. #APIKey = YOUR-APIKEY
  102. ###############################################################################
  103. [Matrix]
  104. # The URL to your Matrix homeserver
  105. #
  106. # If you are using Pantalaimon, this should be the URL of your Pantalaimon
  107. # instance, not the Matrix homeserver itself.
  108. #
  109. Homeserver = https://matrix.local
  110. # An Access Token for the user your bot runs as
  111. # Can be obtained using a request like this:
  112. #
  113. # See https://www.matrix.org/docs/guides/client-server-api#login
  114. # for information on how to obtain this value
  115. #
  116. AccessToken = syt_yoursynapsetoken
  117. # The Matrix user ID of the bot (@local:domain.tld)
  118. # Only specify this if the bot fails to figure it out by itself
  119. #
  120. # UserID = @gptbot:matrix.local
  121. ###############################################################################
  122. [Database]
  123. # Path of the main database
  124. # Used to "remember" settings, etc.
  125. #
  126. Path = database.db
  127. # Path of the Crypto Store - required to support encrypted rooms
  128. # (not tested/supported yet)
  129. #
  130. CryptoStore = store.db
  131. ###############################################################################
  132. [TrackingMore]
  133. # API key for TrackingMore
  134. # If not defined, the bot will not be able to provide parcel tracking
  135. #
  136. # APIKey = abcde-fghij-klmnop
  137. ###############################################################################
  138. [Replicate]
  139. # API key for replicate.com
  140. # Can be used to run lots of different AI models
  141. # If not defined, the features that depend on it are not available
  142. #
  143. # APIKey = r8_alotoflettersandnumbershere
  144. ###############################################################################
  145. [HuggingFace]
  146. # API key for Hugging Face
  147. # Can be used to run lots of different AI models
  148. # If not defined, the features that depend on it are not available
  149. #
  150. # APIKey = __________________________
  151. ###############################################################################
  152. [OpenWeatherMap]
  153. # API key for OpenWeatherMap
  154. # If not defined, the bot will be unable to provide weather information
  155. #
  156. # APIKey = __________________________
  157. ###############################################################################