Jump to content

Bot:Guide/approved services: Difference between revisions

From Insurer Brain
Content deleted Content added
No edit summary
No edit summary
Line 9: Line 9:
==== Description ====
==== Description ====


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


==== Required parameters ====
==== Required parameters ====


* '''page_title''' — the name of the 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_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 ====
==== Optional parameters ====


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


==== Trigger phrases ====
==== Trigger phrases ====
Line 53: Line 56:
</pre>
</pre>
→ page_title: Loss ratio
→ page_title: Loss ratio

'''4. Multiple pages in one email:'''
<pre>
Subject: PDFs needed
Body: Hi, can you send me PDFs of Combined ratio, Loss ratio, and Internal:Teams/Group tax department?
</pre>
→ page_titles: ["Combined ratio", "Loss ratio", "Internal:Teams/Group tax department"]

'''5. Landscape orientation:'''
<pre>
Subject: PDF request
Body: Can you send me a PDF of the FY25 results summary in landscape?
</pre>
→ page_title: FY25 results summary
→ orientation: landscape

{{Section separator}}

=== retrieve ===

==== Description ====

* Searches the wiki and answers the user's question using the content found on relevant pages.
* The bot reads one or more wiki pages and composes a natural language answer, citing sources.
* This service is used when the user asks a question about wiki content rather than requesting a file or PDF.

==== Required parameters ====

* '''query''' — the user's question in natural language (e.g. "Who is the head of Group tax?", "What is the CSM rollforward of AXA in FY25?").

==== Optional parameters ====

* '''page_hints''' — explicit page titles mentioned by the user (e.g. if the user says "look at the Thomas Buberl page", the page_hint is "Thomas Buberl").

==== Trigger phrases ====

* "find me..."
* "tell me about..."
* "what is..."
* "who is..."
* "give me..."
* "show me..."
* "I need to know..."
* "can you look up..."
* "search for..."
* "I need information on..."
* "help me find..."

==== Examples ====

'''1. Contact lookup:'''
<pre>
Subject: Contact at Group tax
Body: Hi BananaBot, I'm working at AXA XL and need to find a contact at Group tax. Help me find.
</pre>
→ query: "find a contact at Group tax"
→ search_terms: ["Group tax department", "Group tax"]
→ suggested_paths: ["Internal:Teams/"]

'''2. Financial data retrieval:'''
<pre>
Subject: CSM rollforward
Body: Hi BananaBot, give me the CSM rollforward of AXA in FY25.
</pre>
→ query: "CSM rollforward of AXA in FY25"
→ search_terms: ["CSM rollforward", "AXA FY25 results"]
→ suggested_paths: ["Web:AXA/results/"]

'''3. Definition question:'''
<pre>
Subject: Quick question
Body: What is combined ratio?
</pre>
→ query: "What is combined ratio?"
→ search_terms: ["Combined ratio"]
→ suggested_paths: ["Definition:"]

'''4. Person lookup:'''
<pre>
Subject: Info needed
Body: Tell me about Thomas Buberl
</pre>
→ query: "Tell me about Thomas Buberl"
→ search_terms: ["Thomas Buberl"]
→ page_hints: ["Thomas Buberl"]

'''5. Market intelligence:'''
<pre>
Subject: M&A trends
Body: What are the latest M&A trends in insurance?
</pre>
→ query: "latest M&A trends in insurance"
→ search_terms: ["M&A insurance", "M&A trends"]
→ suggested_paths: ["Web:Watch"]


{{Section separator}}
{{Section separator}}
Line 86: Line 183:
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
- Convert a wiki page to PDF and email it back to you
- Search the wiki and answer your questions about its content


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 00:36, 2 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

~*~

retrieve

Description

  • Searches the wiki and answers the user's question using the content found on relevant pages.
  • The bot reads one or more wiki pages and composes a natural language answer, citing sources.
  • This service is used when the user asks a question about wiki content rather than requesting a file or PDF.

Required parameters

  • query — the user's question in natural language (e.g. "Who is the head of Group tax?", "What is the CSM rollforward of AXA in FY25?").

Optional parameters

  • page_hints — explicit page titles mentioned by the user (e.g. if the user says "look at the Thomas Buberl page", the page_hint is "Thomas Buberl").

Trigger phrases

  • "find me..."
  • "tell me about..."
  • "what is..."
  • "who is..."
  • "give me..."
  • "show me..."
  • "I need to know..."
  • "can you look up..."
  • "search for..."
  • "I need information on..."
  • "help me find..."

Examples

1. Contact lookup:

Subject: Contact at Group tax
Body: Hi BananaBot, I'm working at AXA XL and need to find a contact at Group tax. Help me find.

→ query: "find a contact at Group tax" → search_terms: ["Group tax department", "Group tax"] → suggested_paths: ["Internal:Teams/"]

2. Financial data retrieval:

Subject: CSM rollforward
Body: Hi BananaBot, give me the CSM rollforward of AXA in FY25.

→ query: "CSM rollforward of AXA in FY25" → search_terms: ["CSM rollforward", "AXA FY25 results"] → suggested_paths: ["Web:AXA/results/"]

3. Definition question:

Subject: Quick question
Body: What is combined ratio?

→ query: "What is combined ratio?" → search_terms: ["Combined ratio"] → suggested_paths: ["Definition:"]

4. Person lookup:

Subject: Info needed
Body: Tell me about Thomas Buberl

→ query: "Tell me about Thomas Buberl" → search_terms: ["Thomas Buberl"] → page_hints: ["Thomas Buberl"]

5. Market intelligence:

Subject: M&A trends
Body: What are the latest M&A trends in insurance?

→ query: "latest M&A trends in insurance" → search_terms: ["M&A insurance", "M&A trends"] → suggested_paths: ["Web:Watch"]

~*~

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
- Search the wiki and answer your questions about its content

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

Best regards,
[bot_name]