Bot:Guide/approved productions: Difference between revisions

Content deleted Content added
No edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 2:
 
{{Section separator}}
== Approved functions ==
 
== List of approved functions ==
{| class="wikitable" style="width:100%"
 
|-
=== create_definitions ===
! Function !! Required parameters !! Optional parameters !! Description !! Trigger phrases !! Examples
 
|-
==== Description ====
| <code>create_definitions</code>
 
| None
|
* '''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.
|
* 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 <nowiki>[[Definition:...]]</nowiki> 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..."
Line 27 ⟶ 33:
* "generate definitions about..."
* "make definition pages for..."
 
|
==== Examples ====
 
'''1. Topics and terms:'''
<pre>
Line 52 ⟶ 60:
</pre>
→ topics: ''(none)'' / terms: ''(none)'' / override: no
 
|}
=== create_team_pages ===
 
==== Description ====
 
* Creates standardized team pages on the wiki from organization description documents.
* The user attaches one or more documents (PDF, TXT, etc.) describing teams (roles, missions, org structure, contacts).
* Each document is transformed into a wiki page with an infobox, introduction, org chart, and team table.
* Pages are created at <nowiki>Internal:Teams/{team name}</nowiki> by default, or at a custom path if specified.
* If team names are provided, the bot matches each document to the corresponding name. If not provided, the bot determines the team name from the document content (sentence case, preserving proper nouns).
* By default, existing pages are overwritten (override: yes), since team pages typically represent updated information.
 
==== Required parameters ====
 
* '''documents''' — one or more attached files describing teams. The user must attach the documents to the email.
 
==== Optional parameters ====
 
* '''team_names''' — list of official team names (e.g. "Group tax department", "Group corporate finance"). If not provided, the bot determines the names from the documents.
* '''path''' — wiki path prefix where pages are created. Default: <nowiki>Internal:Teams/</nowiki>. Example: <nowiki>Internal:Teams/AXA Hong Kong/</nowiki> for a subfolder.
* '''override''' — yes or no. If yes, replaces existing pages. Default: yes.
 
==== Trigger phrases ====
 
* "create team pages using the attached..."
* "create team pages for..."
* "generate team pages from..."
* "build team pages from the attached..."
* "update team pages with..."
* "make team pages from..."
 
==== Examples ====
 
'''1. With team names:'''
<pre>
Subject: Create team pages
Body: Hi PlumBot, please create team pages using the attached
documents. The team names are: Group tax department;
Group corporate finance.
</pre>
→ documents: ''(attachments)'' / team_names: Group tax department, Group corporate finance / path: Internal:Teams/ / override: yes
 
'''2. Without team names (auto-detect):'''
<pre>
Subject: Create team pages from attached docs
Body: Hi PlumBot, please create team pages using the attached
documents.
</pre>
→ documents: ''(attachments)'' / team_names: ''(auto-detected)'' / path: Internal:Teams/ / override: yes
 
'''3. With custom path:'''
<pre>
Subject: Create team pages for AXA Hong Kong
Body: Hi PlumBot, please create team pages using the attached
documents under Internal:Teams/AXA Hong Kong/.
The team names are: Corporate finance; Group tax.
</pre>
→ documents: ''(attachments)'' / team_names: Corporate finance, Group tax / path: Internal:Teams/AXA Hong Kong/ / override: yes
 
'''4. Without override:'''
<pre>
Subject: Create team pages (don't overwrite)
Body: Hi PlumBot, please create team pages from the attached
documents. Do not overwrite existing pages.
</pre>
→ documents: ''(attachments)'' / team_names: ''(auto-detected)'' / path: Internal:Teams/ / override: no
 
{{Section separator}}
 
== 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> and <nowiki>[bot_name]</nowiki> with actual values.
 
<pre>
Hello [first namefirst_name],
 
Thank you for your email. I wasn't able to match your request to any of my available functions.
Line 66 ⟶ 159:
Here is what I can currently do:
- Create insurance glossary definitions (from topics, specific terms, or broken links)
- Create team pages from attached organization documents (with optional team names and custom wiki path)
 
Could you rephrase your request, or contact your administrator for help?
 
Best regards,
[bot_name]
[BotName]
</pre>