Difference between revisions of "Bots Framework"
| Line 27: | Line 27: | ||
The response should be the following: | The response should be the following: | ||
Hi, I'm <Bot's Name>. I was born in <Month> <Year>. | Hi, I'm <Bot's Name>. I was born in <Month> <Year>. | ||
Note: the month and year are needed so you and others can track the version of the bot deployed. | |||
< Short one-line description here. E.g. "I can help you to acquire or to sell your digital art." > | < Short one-line description here. E.g. "I can help you to acquire or to sell your digital art." > | ||
Just say | Just say "<Bot's Name>" and I will guide you. | ||
== Response to XMPP invites == | == Response to XMPP invites == | ||
Revision as of 14:22, 25 August 2022
Bots are important within Ethora ecosystem as they carry out numerous functions.
3rd party developers are encouraged to create their own Bots.
This document covers best practices and rules to follow when implementing your own chat bots.
All rules and recommendations below apply to all Bots used within Ethora ecosystem, within all chat Room the bots are present at.
State (data persistence)
It is recommended that Bots maintain the following aspects of the State (this of course may extend or vary depending on your use case and implementation).
- Rooms - the list of rooms the bot has been invited to
- User-specific states (stage of the conversation)
Names
Please have "bot" or "Bot" in the name of your bot. For example, "Merchant Bot"
This makes it easy for your Bot to react to their name being called, without being triggered when Users mention
Accordingly, have your Bot react to both keywords, any register for the letters. For example, "merchant bot" and "bOt MerchaNt" should both be fine to call the "Merchant Bot".
System (Default) responses
"bot help", "bot info"
Each bot should respond to "bot help", "bots help", "bot info" and "bots info" requests.
The response should be the following:
Hi, I'm <Bot's Name>. I was born in <Month> <Year>.
Note: the month and year are needed so you and others can track the version of the bot deployed.
< Short one-line description here. E.g. "I can help you to acquire or to sell your digital art." >
Just say "<Bot's Name>" and I will guide you.
Response to XMPP invites
Bots should correctly handle invites to join new chat Rooms.
Upon receiving an invite stanza, a Bot should join the Room.
isComposing ("now typing")
Before sending each message from a bot, send "isComposing" messages briefly so that it looks more organic (as if your Bot was typing).
Delay between messages
Have a brief delay before sending consequent messages by your Bot so it looks more organic (don't throw many messages at the User all at once).
Reaction to Users presence
If a user is inactive for 1 minute and starts to post a message or chat after that, presence is triggered and a message is sent to the user.
Also, the presence time is updated if we receive isComposing before the timeout time of 2 minutes if any messages are sent to the user (so we understand that the user is active).
QA
Uptime
The Bot should maintain a 99.99% or higher uptime. I.e. it should be responding to messages from an automated status checker - at least responding to the "bot info" request.
Throughput
Unless allowed by a specific use case, a Bot should be able to maintain conversations with at least 1,000 Users handling 300 incoming messages per second. This should not cause any deterioration or noticeable slowing down of the service.