Skip to content

Latest commit

Β 

History

History
102 lines (92 loc) Β· 5.24 KB

docs.md

File metadata and controls

102 lines (92 loc) Β· 5.24 KB



πŸ“š Documentation


GEMINI

The bot is highly customizable πŸ€–, allowing you to adjust the prompt according to your needs, resulting in more personalized responses ✍️. You can also configure various settings βš™οΈ, such as the model and the temperature, depending on the context or the type of output you want to generate here.

By default, the following parameters are set:

  • Model: gemini-1.5-flash-001 🧠
  • Temperature: 1 🌑️
  • Top P: 0.95 🎯
  • Top K: 40 πŸ“Š
  • Max Output Tokens: 8192 πŸ“„
  • Response Mime Type: application/json πŸ“™

You can modify these parameters to suit your specific needs, such as increasing the temperature for more creative responses 🎨 or lowering it for more deterministic outputs βœ…. Similarly, Top P, Top K, and Top N can be adjusted to control how broad or narrow the selection of possible next tokens should be during generation.

Warning

Changing the response mime type might change the way gemini formats its response and its response parser.


πŸ•·οΈπŸ€– CRAWLER

Note

Currently, it is not possible to set custom parameters for the crawler 🚧.

The crawler operates with a fixed configuration designed to efficiently retrieve and process data πŸ“‚, but future updates may include options for more granular control βš™οΈ, such as setting intervals ⏲️ or data extraction rules πŸ“‹.


πŸ§‘β€πŸ§‘β€πŸ§’β€πŸ§’ USERS & GROUPS

In terms of user interaction, the bot can be set up to interact either with individual users πŸ‘€ or with users within groups πŸ‘₯. This allows for flexible engagement depending on your needs.

For example, if you set ADMIN_USER_ID=123 where 123 is the user's ID, the bot will be able to interact with this specific user through a private chat πŸ’¬. If you wish to allow multiple users to interact with the bot in separate private chats, you can simply add their IDs, like so: ADMIN_USER_ID=123;456. This way, each user will have the ability to privately communicate with the bot πŸ‘₯πŸ’¬.

Only admin users can add the GemDigest bot to group chats. Once added, GemDigest will interact with everyone in the groupβ€”no admin status needed for standard interactions! However, only admins can issue direct commands to control the bot's features. If a non-admin attempts to:

  • Create a private chat with the bot – GemDigest will simply ignore the message 🀷
  • Add the bot to another group – it will politely leave the chat πŸ‘‹
This setup ensures GemDigest runs smoothly in groups and maintains control with admin users!

Note

To get a user’s ID, follow this guide πŸ“: whoami_bot

With this flexible setup, you can fine-tune how the bot communicates πŸ“ž, whether for one-on-one interactions or group-wide discussions πŸ—¨οΈπŸ’‘.


πŸ“‹ DEFAULT COMMANDS

You can use the following predefined commands to get information about the bot's functionalities:

  • /help: Returns a list of available commands πŸ“œ
  • /tokens: Returns the number of tokens used πŸ”’
  • /info: Returns information such as the current temperature and the model being used πŸ“Š
  • /blacklist: Returns the list of website for which the summary is not needed (e.g. youtube) β›”

Examples of the following commands are provided in the table below:

Command Description Image
/help Displays a list of all available commands, helping you explore the bot's features more easily πŸ› οΈ
/tokens Shows the number of tokens used so far, helping to keep track of the token consumption efficiently πŸ”
/info Provides details about the current bot configuration, including temperature, model, and other settings βš™οΈ
/blacklist Provides the list of websites that will be ignored, such as YouTube β›”


β›” BLACKLIST

To add a website to the blacklist you can edit website_blacklist.txt and add the website you want to blacklist. For example www.youtube.com and www.x.com are already in! Then close the file and restart the bot or the container.