Bot:Guide/approved productions: Difference between revisions

Content deleted Content added

Inline

Revision as of 18:34, 30 March 2026

Bot:Guide/approved productions lists all production functions that production bots (e.g. PlumBot) can execute on behalf of authorized users. When a user sends an email to a production bot, the bot reads this page to identify which function to run and which parameters to extract.

~*~

List of approved functions

create_definitions

Description

Creates insurance glossary definition pages on the wiki.
Can generate terms from broad subjects, create specific definition pages, or automatically fill in all missing definitions.
When both topics and terms are provided, seeds are generated from the topics and merged with the provided terms.
When no parameters are provided, the bot scans for broken [[Definition:...]] links and creates those pages.

Required parameters

None.

Optional parameters

topics — list of broad subjects (e.g. "M&A", "Cyber insurance"). Generates 50 seed terms per topic.
terms — list of specific terms (e.g. "Combined ratio", "Loss ratio"). Creates individual definition pages.
override — yes or no. If yes, replaces existing pages. Default: no.

Trigger phrases

"create definitions for..."
"define these terms..."
"generate glossary entries about..."
"add definitions for..."
"create pages for..."
"generate definitions about..."
"make definition pages for..."

Examples

1. Topics and terms:

Subject: Create definitions for Cyber and specific terms
Body: Hi PlumBot, please create definitions for the topic
Cyber insurance. Also define these specific terms:
Ransomware warranty, Silent cyber exposure.

→ topics: Cyber insurance / terms: Ransomware warranty, Silent cyber exposure / override: no

2. Terms only:

Subject: Define Combined ratio and Loss ratio
Body: Hi PlumBot, can you create definition pages for:
Combined ratio, Loss ratio, Expense ratio.

→ topics: (none) / terms: Combined ratio, Loss ratio, Expense ratio / override: no

3. No parameters:

Subject: Fix broken definition links
Body: Hi PlumBot, please check for any broken definition
links on the wiki and create the missing pages.

→ topics: (none) / terms: (none) / override: no

~*~

Fallback

Required parameters missing

When the bot identifies the function but required parameters are missing, it replies with the following template. The bot replaces [first_name], [function_name], [missing_parameters], and [bot_name] with actual values.

Hello [first_name],

Thank you for your email. I identified your request as "[function_name]", but I'm missing the following required information:

[missing_parameters]

Could you reply with the missing details so I can proceed?

Best regards,
[bot_name]

Rejected

When the bot cannot match the user's request to any approved function, it replies with the following template. The bot replaces [first_name], [list_of_functions], and [bot_name] with actual values.

Hello [first_name],

Thank you for your email. I wasn't able to match your request to any of my available functions.

Here is what I can currently do:
[list_of_functions]

Could you rephrase your request, or contact your administrator for help?

Best regards,
[bot_name]

@@ Line 2: / Line 2: @@
 {{Section separator}}
+== List of approved functions ==
-== create_definitions ==
-=== Description ===
+=== create_definitions ===
+==== Description ====
 * Creates insurance glossary definition pages on the wiki.
@@ Line 11: / Line 13: @@
 * When no parameters are provided, the bot scans for broken <nowiki>[[Definition:...]]</nowiki> links and creates those pages.
-=== Required parameters ===
+==== Required parameters ====
 None.
-=== Optional parameters ===
+==== Optional parameters ====
 * '''topics''' — list of broad subjects (e.g. "M&A", "Cyber insurance"). Generates 50 seed terms per topic.
@@ Line 21: / Line 23: @@
 * '''override''' — yes or no. If yes, replaces existing pages. Default: no.
-=== Trigger phrases ===
+==== Trigger phrases ====
 * "create definitions for..."
@@ Line 31: / Line 33: @@
 * "make definition pages for..."
-=== Examples ===
+==== Examples ====
 '''1. Topics and terms:'''
@@ Line 61: / Line 63: @@
 == Fallback ==
+=== Required parameters missing ===
-If the user's request does not match any approved function above, the bot should reply:
+When the bot identifies the function but required parameters are missing, it replies with the following template. The bot replaces <nowiki>[first_name]</nowiki>, <nowiki>[function_name]</nowiki>, <nowiki>[missing_parameters]</nowiki>, and <nowiki>[bot_name]</nowiki> with actual values.
+<pre>
+Hello [first_name],
+Thank you for your email. I identified your request as "[function_name]", but I'm missing the following required information:
+[missing_parameters]
+Could you reply with the missing details so I can proceed?
+Best regards,
+[bot_name]
+</pre>
+=== Rejected ===
+When the bot cannot match the user's request to any approved function, it replies with the following template. The bot replaces <nowiki>[first_name]</nowiki>, <nowiki>[list_of_functions]</nowiki>, and <nowiki>[bot_name]</nowiki> with actual values.
 <pre>
-Hello [first name],
+Hello [first_name],
-Thank you for your email. I wasn't able to match your request
+Thank you for your email. I wasn't able to match your request to any of my available functions.
-to any of my available functions.
 Here is what I can currently do:
+[list_of_functions]
-- Create insurance glossary definitions (from topics, specific terms, or broken links)
 Could you rephrase your request, or contact your administrator for help?
 Best regards,
+[bot_name]
-[BotName]
 </pre>