Jump to content

Bot:Guide/approved productions: Difference between revisions

From Insurer Brain
Content deleted Content added
No edit summary
No edit summary
Tag: Reverted
Line 1: Line 1:
'''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.
'''Bot:Guide/approved services''' lists all service functions that service bots can execute on behalf of authorized users. When a user sends an email to a service bot, the bot reads this page to identify which function to run and which parameters to extract.


{{Section separator}}
{{Section separator}}


== List of approved functions ==
== List of approved services ==


=== create_definitions ===
=== get_pdf ===


==== Description ====
==== Description ====


* Converts one or more specified MediaWiki pages into PDF documents and emails them back to the sender as attachments.
* Creates insurance glossary definition pages on the wiki.
* The user provides the title(s) of the wiki page(s) they want as PDF.
* Can generate terms from broad subjects, create specific definition pages, or automatically fill in all missing definitions.
* Pay special attention to terms wrapped in brackets like <nowiki>[[term]]</nowiki> or written in ALL CAPS, as these often indicate the page title.
* 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 ====
==== Required parameters ====


* '''page_title''' — the name of a single wiki page to convert (e.g. "Combined ratio", "Internal:Teams/Group tax department"). The bot normalizes the title to match the wiki page name.
None.
* '''page_titles''' — use this when the user requests multiple pages in a single email. The bot generates one PDF per page and attaches them all in one reply.

Note: use '''page_title''' for a single page, or '''page_titles''' for multiple pages.


==== Optional parameters ====
==== Optional parameters ====


* '''orientation''' — PDF page orientation: "portrait" (default) or "landscape". The user can say "in landscape", "landscape mode", or "landscape orientation" to switch.
* '''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 ====
==== Trigger phrases ====


* "create definitions for..."
* "send me a PDF of..."
* "define these terms..."
* "print this page..."
* "generate glossary entries about..."
* "download the page..."
* "add definitions for..."
* "get a PDF of..."
* "create pages for..."
* "export this page to PDF..."
* "generate definitions about..."
* "can I get a PDF for..."
* "make definition pages for..."
* "email me the PDF of..."


==== Examples ====
==== Examples ====


'''1. Topics and terms:'''
'''1. Simple page request:'''
<pre>
<pre>
Subject: PDF of Combined ratio
Subject: Create definitions for Cyber and specific terms
Body: Hi PlumBot, please create definitions for the topic
Body: Hi, can you send me a PDF of the Combined ratio page?
Cyber insurance. Also define these specific terms:
Ransomware warranty, Silent cyber exposure.
</pre>
</pre>
→ page_title: Combined ratio
→ topics: Cyber insurance / terms: Ransomware warranty, Silent cyber exposure / override: no

'''2. Terms only:'''
<pre>
Subject: Define Combined ratio and Loss ratio
Body: Hi PlumBot, can you create definition pages for:
Combined ratio, Loss ratio, Expense ratio.
</pre>
→ topics: ''(none)'' / terms: Combined ratio, Loss ratio, Expense ratio / override: no

'''3. No parameters:'''
<pre>
Subject: Fix broken definition links
Body: Hi PlumBot, please check for any broken definition
links on the wiki and create the missing pages.
</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:'''
'''2. Bracketed page title:'''
<pre>
<pre>
Subject: Create team pages
Subject: Print page
Body: Hi PlumBot, please create team pages using the attached
Body: Hi, please send me a PDF of [[Internal:Teams/Group tax department]].
documents. The team names are: Group tax department;
Group corporate finance.
</pre>
</pre>
documents: ''(attachments)'' / team_names: Group tax department, Group corporate finance / path: Internal:Teams/ / override: yes
page_title: Internal:Teams/Group tax department


'''2. Without team names (auto-detect):'''
'''3. Informal request:'''
<pre>
<pre>
Subject: Create team pages from attached docs
Subject: Download page
Body: Could I get a PDF for the LOSS RATIO page? Thanks!
Body: Hi PlumBot, please create team pages using the attached
documents.
</pre>
</pre>
→ page_title: Loss ratio
→ documents: ''(attachments)'' / team_names: ''(auto-detected)'' / path: Internal:Teams/ / override: yes


'''3. With custom path:'''
'''4. Multiple pages in one email:'''
<pre>
<pre>
Subject: Create team pages for AXA Hong Kong
Subject: PDFs needed
Body: Hi, can you send me PDFs of Combined ratio, Loss ratio, and Internal:Teams/Group tax department?
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>
</pre>
→ page_titles: ["Combined ratio", "Loss ratio", "Internal:Teams/Group tax department"]
→ documents: ''(attachments)'' / team_names: Corporate finance, Group tax / path: Internal:Teams/AXA Hong Kong/ / override: yes


'''4. Without override:'''
'''5. Landscape orientation:'''
<pre>
<pre>
Subject: Create team pages (don't overwrite)
Subject: PDF request
Body: Can you send me a PDF of the FY25 results summary in landscape?
Body: Hi PlumBot, please create team pages from the attached
documents. Do not overwrite existing pages.
</pre>
</pre>
→ page_title: FY25 results summary
→ documents: ''(attachments)'' / team_names: ''(auto-detected)'' / path: Internal:Teams/ / override: no
→ orientation: landscape


{{Section separator}}
{{Section separator}}
Line 155: Line 100:
Hello [first_name],
Hello [first_name],


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


Here is what I can currently do:
Here is what I can currently do:
- Convert a wiki page to PDF and email it back to you
- 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?
Could you rephrase your request, or contact your administrator for help?

Revision as of 23:43, 1 April 2026

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

~*~

List of approved services

get_pdf

Description

  • Converts one or more specified MediaWiki pages into PDF documents and emails them back to the sender as attachments.
  • The user provides the title(s) of the wiki page(s) they want as PDF.
  • Pay special attention to terms wrapped in brackets like [[term]] or written in ALL CAPS, as these often indicate the page title.

Required parameters

  • page_title — the name of a single wiki page to convert (e.g. "Combined ratio", "Internal:Teams/Group tax department"). The bot normalizes the title to match the wiki page name.
  • page_titles — use this when the user requests multiple pages in a single email. The bot generates one PDF per page and attaches them all in one reply.

Note: use page_title for a single page, or page_titles for multiple pages.

Optional parameters

  • orientation — PDF page orientation: "portrait" (default) or "landscape". The user can say "in landscape", "landscape mode", or "landscape orientation" to switch.

Trigger phrases

  • "send me a PDF of..."
  • "print this page..."
  • "download the page..."
  • "get a PDF of..."
  • "export this page to PDF..."
  • "can I get a PDF for..."
  • "email me the PDF of..."

Examples

1. Simple page request:

Subject: PDF of Combined ratio
Body: Hi, can you send me a PDF of the Combined ratio page?

→ page_title: Combined ratio

2. Bracketed page title:

Subject: Print page
Body: Hi, please send me a PDF of [[Internal:Teams/Group tax department]].

→ page_title: Internal:Teams/Group tax department

3. Informal request:

Subject: Download page
Body: Could I get a PDF for the LOSS RATIO page? Thanks!

→ page_title: Loss ratio

4. Multiple pages in one email:

Subject: PDFs needed
Body: Hi, can you send me PDFs of Combined ratio, Loss ratio, and Internal:Teams/Group tax department?

→ page_titles: ["Combined ratio", "Loss ratio", "Internal:Teams/Group tax department"]

5. Landscape orientation:

Subject: PDF request
Body: Can you send me a PDF of the FY25 results summary in landscape?

→ page_title: FY25 results summary → orientation: landscape

~*~

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] 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 services.

Here is what I can currently do:
- Convert a wiki page to PDF and email it back to you

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

Best regards,
[bot_name]