Xenthys/heiryn_commands.md Secret

## heiryn_commands.md

      
    Raw
  

              heiryn_commands.md
            
          
    Commands

Besides AI-powered responses, Heiryn provides the following slash commands.

AI

Ask Heiryn

This is a message context command, not a slash command.

Default permission: Unrestricted
Submit the target message's content to Heiryn's AI, which will to its best to answer.
This will open a modal for you to optionally add more context, which will be appended to the content.
Ask Heiryn (Quick)

This is a message context command, not a slash command.

Default permission: Unrestricted
Submit the target message's content to Heiryn's AI, which will to its best to answer.
This quick variant will not open a modal, and instead submit the content as-is to the AI.
/ask

Default permission: Unrestricted
Arguments:

<question> (string): the question you want to ask to Heiryn, bypassing the channel's history
[ephemeral] (boolean): make Heiryn's answer ephemeral so only you can see it (default: false)

Ask anything to Heiryn, your question will be handled by the AI to obtain an answer.
Note: history is not saved, every question is fully independent from the others.
/ping_author

Default permission: Unrestricted
Argument:

<ping> (boolean): whether Ask Heiryn should mention the message author or not

Check or define if the Ask Heiryn interaction should ping the message author.
The ping will only be added outside of DMs and if the author is different from the interaction user.
/report_mention

Default permission: Manage Roles
Argument:

<mention> (string): the user or role mention(s) to act as the "AI Oversight Committee" for the bot

The bot will use this mention to report bad conduct, prohibited requests, anything that may require staff attention.
Use -, none or disable to disable the report mention feature entirely.
/reset_history

Default permission: Manage Messages
This command will delete the current channel's AI chat history, starting fresh with only the system prompt.
/server_description

Default permission: Manage Server
Argument:

<description> (string): information about your server you want Heiryn to know

The bot will use the provided data to taylor all its responses to your community.
Use -, none or delete to delete your server description.
Block

/block add

Default permission: Moderate Members (timeout)
Arguments:

<user>: the user to block from interacting any further with the bot
[duration]: the duration (ex: 10s, 5m, 6h, 2d, 1y) for which the user will be blocked

Blocked users will not be able to use any command or interact with the AI feature.

It is only possible to block users with a strictly inferior top role than yours.
/block remove

Default permission: Moderate Members (timeout)
Arguments:

<user>: the user to allow to interact again with the bot

Any user with the permission to execute this command can unblock other users.