Agentic-GenUI-Tools 0.2.0__py3-none-any.whl

adaptive_card_tools/examples.py

@@ -0,0 +1,169 @@
+"""Designed compositions, not named rendering templates.
+
+These show how generic elements combine. The builder has no product, expense,
+KPI, or approval special cases. All names/values are illustrative; example.com
+URLs must be replaced by real application URLs. They are not part of the tool
+prompt (which stays short for small models); use them for docs and tests.
+"""
+import copy
+import json
+
+
+BUSINESS_EXAMPLES = {
+    "product_comparison": {
+        "design": "Introduce the decision, put one product in each column, then end with a complete recommendation or trade-off paragraph. Each column can have an optional image, heading, optional badge/rating, full description, facts, and a link. Omit optional elements only when their information was not supplied; never shorten or drop supplied text to fit. The example uses the same feature labels for easy scanning; add a separate table if exact row alignment is important. Rearrange or add elements as appropriate; this is not a fixed product template.",
+        "request": {
+            "title": "Choose a laptop for your team",
+            "elements": [
+                {"type": "text", "text": "Two illustrative options for a hybrid team. Both include a three-year warranty and next-business-day support. Prices exclude tax."},
+                {"type": "columns", "columns": [
+                    {"elements": [
+                        {"type": "image", "url": "https://example.com/images/aurora-air.png", "alt": "Aurora Air laptop with a silver finish"},
+                        {"type": "heading", "text": "Aurora Air 14"},
+                        {"type": "badge", "text": "Best for travel", "tone": "info"},
+                        {"type": "text", "text": "A lightweight laptop for colleagues who move between home, campus, and client meetings. Its smaller chassis prioritizes portability while retaining the connectivity needed for an external display and standard office accessories."},
+                        {"type": "facts", "facts": {"Price": "$1,249 per device", "Memory": "16 GB", "Storage": "512 GB SSD", "Weight": "1.2 kg", "Battery": "Up to 14 hours", "Warranty": "3 years; next-business-day support"}},
+                        {"type": "rating", "value": 4.4, "count": 128},
+                        {"type": "actions", "actions": [{"type": "open_url", "label": "View Aurora Air details", "url": "https://example.com/products/aurora-air"}]}
+                    ]},
+                    {"elements": [
+                        {"type": "image", "url": "https://example.com/images/aurora-pro.png", "alt": "Aurora Pro laptop with a dark finish"},
+                        {"type": "heading", "text": "Aurora Pro 16"},
+                        {"type": "badge", "text": "Best for analysis", "tone": "success"},
+                        {"type": "text", "text": "A larger laptop for analysts who work with several applications, large spreadsheets, and local development environments at the same time. The additional memory and storage provide more headroom, with a heavier device and shorter stated battery life as the trade-offs."},
+                        {"type": "facts", "facts": {"Price": "$1,699 per device", "Memory": "32 GB", "Storage": "1 TB SSD", "Weight": "1.8 kg", "Battery": "Up to 10 hours", "Warranty": "3 years; next-business-day support"}},
+                        {"type": "rating", "value": 4.6, "count": 94},
+                        {"type": "actions", "actions": [{"type": "open_url", "label": "View Aurora Pro details", "url": "https://example.com/products/aurora-pro"}]}
+                    ]}
+                ]},
+                {"type": "section", "title": "Decision guidance", "elements": [
+                    {"type": "text", "text": "Choose Aurora Air when low weight and battery life matter most. Choose Aurora Pro when memory capacity and a larger workspace matter more than portability. Confirm compatibility with your organization's approved software and purchasing standards before placing an order."}
+                ]}
+            ]
+        }
+    },
+    "expense_form": {
+        "design": "Start with the purpose and instructions; group related inputs into sections. Use a single submit button with a clear verb. IDs describe submitted fields. Defaults are included only when known. Descriptive text remains complete and wraps; input max_length is an explicit validation rule, not a text-shortening mechanism.",
+        "request": {
+            "title": "Submit an expense claim",
+            "elements": [
+                {"type": "text", "text": "Enter the details below and link to the receipt. Submission sends the values to your application's expense workflow; this card does not approve or reimburse the expense."},
+                {"type": "section", "title": "Expense details", "elements": [
+                    {"type": "input_text", "id": "employee_name", "label": "Employee name", "required": True},
+                    {"type": "input_date", "id": "expense_date", "label": "Expense date", "required": True},
+                    {"type": "dropdown", "id": "category", "label": "Category", "options": [{"Travel": "travel"}, {"Meals": "meals"}, {"Equipment": "equipment"}], "placeholder": "Select a category", "required": True},
+                    {"type": "input_number", "id": "amount", "label": "Amount (CAD)", "min": 0.01, "required": True},
+                    {"type": "input_text", "id": "receipt_url", "label": "Receipt link", "format": "url", "placeholder": "https://…", "required": True}
+                ]},
+                {"type": "section", "title": "Business purpose", "elements": [
+                    {"type": "input_text", "id": "purpose", "label": "Explain why this expense was needed", "multiline": True, "required": True},
+                    {"type": "input_toggle", "id": "confirmed", "label": "I confirm that these details are accurate", "required": True}
+                ]}
+            ],
+            "submit_label": "Submit expense claim"
+        }
+    },
+    "weekly_business_review": {
+        "design": "Use compact columns for headline facts, a trend chart for change over time, a table for actionable exceptions, and a section for explanatory notes. Use full ISO dates for a line chart. Keep all numbers and narrative supplied by the user; don't infer omitted data points.",
+        "request": {
+            "title": "Weekly service review",
+            "elements": [
+                {"type": "text", "text": "Illustrative operations summary for the week ending 11 September 2026. Counts are taken from the reporting snapshot; reopened tickets remain included in the backlog."},
+                {"type": "columns", "columns": [
+                    {"title": "Volume", "elements": [{"type": "facts", "facts": {"New requests": 142, "Resolved": 156}}]},
+                    {"title": "Service", "elements": [{"type": "facts", "facts": {"SLA achieved": "96%", "Median response": "2.1 hours"}}]},
+                    {"title": "Backlog", "elements": [{"type": "facts", "facts": {"Open requests": 38, "Older than 7 days": 6}}, {"type": "badge", "text": "Follow-up required", "tone": "warning"}]}
+                ]},
+                {"type": "line", "title": "Requests resolved", "x_label": "Week ending", "y_label": "Requests", "series": [{"name": "Resolved", "values": [{"x": "2026-08-28", "y": 130}, {"x": "2026-09-04", "y": 148}, {"x": "2026-09-11", "y": 156}]}]},
+                {"type": "table", "title": "Items needing attention", "rows": [{"Item": "Access approvals", "Owner": "Service desk", "Next step": "Confirm the outstanding approvers and contact each requester with an updated timeline."}, {"Item": "Import failures", "Owner": "Applications team", "Next step": "Review the rejected records and document the correction before scheduling the next import."}]},
+                {"type": "progress_bar", "label": "Quarterly process improvements completed", "value": 7, "max": 10},
+                {"type": "section", "title": "Context", "elements": [{"type": "text", "text": "Resolution volume exceeded incoming demand this week, but six older requests still need individual follow-up. The improvement work remains in progress: seven of ten planned changes are complete, and the remaining three depend on testing and stakeholder review."}]}
+            ]
+        }
+    },
+    "approval_request": {
+        "design": "Present the complete request and decision context, then a comment input and explicit action buttons. Action data identifies the requested decision; the application authorizes and executes it. A nested actions element permits buttons within any section; only one explicit submit action set is needed.",
+        "request": {
+            "title": "Review a software renewal",
+            "elements": [
+                {"type": "badge", "text": "Awaiting review", "tone": "warning"},
+                {"type": "facts", "facts": {"Request": "REQ-1042", "Software": "Illustrative Analytics Suite", "Term": "12 months", "Cost": "$4,800 CAD", "Seats": 12}},
+                {"type": "text", "text": "The renewal maintains access for the reporting team while the replacement platform is assessed. The request includes twelve existing seats and no increase in the licensed user count. The owner has asked for a decision before the current term expires."},
+                {"type": "input_text", "id": "review_comment", "label": "Review comment", "multiline": True},
+                {"type": "actions", "actions": [{"type": "submit", "label": "Approve renewal", "data": {"request_id": "REQ-1042", "decision": "approve"}}, {"type": "submit", "label": "Request changes", "data": {"request_id": "REQ-1042", "decision": "request_changes"}}]}
+            ]
+        }
+    }
+}
+
+BUSINESS_EXAMPLES["business_objectives_form"] = {
+    "design": "This reproduces the fully visible question in the user's reference image. The earlier industry options were outside the image and are not invented. Use question as the label, radio as the type, and options as complete strings. The form receives a Submit button automatically.",
+    "request": {
+        "questions": [{
+            "id": "business_objectives",
+            "type": "radio",
+            "options": [
+                "1. Grow recurring revenue",
+                "2. Increase average revenue per customer (ARPU)",
+                "3. Acquire new enterprise customers",
+                "4. Create strategic differentiation",
+                "5. Improve customer retention",
+                "6. Enter new markets"
+            ],
+            "question": "3. Primary Business Objectives select one:"
+        }]
+    }
+}
+
+BUSINESS_EXAMPLES["kpi_dashboard"] = {
+    "design": "Status badge in the header, big-number metric tiles with coloured changes, a bar chart, and a table. Churn uses lower_is_better so a decrease is shown in green.",
+    "request": {
+        "title": "Weekly sales",
+        "subtitle": "Week ending 11 Sep 2026",
+        "status": "On track",
+        "elements": [
+            {"type": "metrics", "items": [
+                {"label": "Revenue", "value": "$48,200", "change": "+12%", "note": "vs last week"},
+                {"label": "Orders", "value": "312", "change": "-3%", "note": "vs last week"},
+                {"label": "Churn", "value": "2.1%", "change": "-0.4 pts", "lower_is_better": True}]},
+            {"type": "chart", "chart_type": "bar", "title": "Revenue by region", "data": {"North": 18200, "South": 12100, "West": 17900}},
+            {"type": "table", "title": "Top products", "rows": [{"Product": "Standing desk", "Units": 84, "Revenue": "$25,116"},
+                                                                {"Product": "Task chair", "Units": 61, "Revenue": "$14,579"}]},
+            {"type": "progress", "label": "Quarterly target", "value": 68},
+            {"type": "buttons", "buttons": [{"label": "Open full report", "url": "https://example.com/reports/weekly"}]}
+        ]
+    }
+}
+
+# What a small model often sends: Adaptive Card names, style keys, aliases,
+# strings for numbers and dates, and a status word instead of a tone.
+BUSINESS_EXAMPLES["messy_small_model_call"] = {
+    "design": "Not a pattern to copy: this shows the repairs. Every element renders; metadata.normalizations lists each fix.",
+    "request": {
+        "request": {
+            "Title": "Leave request",
+            "body": [
+                {"type": "TextBlock", "text": "Please review this request", "size": "Large", "weight": "Bolder"},
+                {"type": "FactSet", "facts": ["Employee: Priya Shah", "Dates: 14–18 Oct 2026", "Days: 5"]},
+                {"type": "Badge", "text": "Pending", "color": "yellow"},
+                {"type": "Input.Text", "label": "Comment for the employee", "isMultiline": "yes", "placeholder": "Optional"},
+                {"type": "DatePicker", "question": "Return date", "default": "October 21, 2026"},
+                {"type": "dropdown", "label": "Cover arranged by", "choices": "Alex, Sam, Jordan", "value": "sam"},
+                {"type": "ActionSet", "actions": [{"type": "Action.Submit", "title": "Approve"}, {"type": "Action.Submit", "title": "Reject"}]}
+            ]
+        }
+    }
+}
+
+
+
+def get_example(name: str) -> dict:
+    """Return a copy of an example specification for experimentation."""
+    return copy.deepcopy(BUSINESS_EXAMPLES[name]["request"])
+
+
+def business_examples_doc() -> str:
+    parts = ["\nComplete composition examples (objects to place in request):"]
+    for name, example in BUSINESS_EXAMPLES.items():
+        parts.extend(["\n" + name + ": " + example["design"], json.dumps(example["request"], ensure_ascii=False, indent=2)])
+    return "\n".join(parts)