Token Calculator

studies/202512_GenesysCX/ctm-token-calculator/tokencalc/cost_model.py

@@ -7,8 +7,8 @@ Correctness rules implemented here (see spec §4.1):
    is enabled at a site, AI Summary & Insights consumption at that site
    is forced to zero — Copilot's per-user token rate already includes
    interaction summarization. Source: Genesys Cloud AI Experience
-   tokens FAQ,
-   https://help.mypurecloud.com/articles/genesys-cloud-ai-experience-tokens-faqs/
+   token metering,
+   https://help.genesys.cloud/articles/genesys-cloud-tokens-model/
 2. **Token rounding.** Genesys rounds consumption up at billing —
    ``math.ceil`` is applied to each site's MONTHLY consumption token
    total before the rate. Per-user totals (users × tokens/user/month)
@@ -133,12 +133,18 @@ def _monthly_units(site: SiteInput, feature: str, scope: FeatureScope,
             site.voice_volume_monthly * deflection * scenario.voice_bot_avg_minutes
         )  # minutes
     if feature == "Agentic Virtual Agent":
-        deflection = (
+        # Layered model: VA operates on the residual volume after the voice bot
+        # has already deflected its share.  Cost base = residual × va_rate.
+        # This is consistent with the benefit model and avoids double-counting
+        # the same call pool across both deflection mechanisms.
+        bot_deflection = scenario.voice_bot_deflection
+        va_deflection = (
             scope.deflection_target
             if scope.deflection_target is not None
             else scenario.agentic_va_deflection
         )
-        return site.voice_volume_monthly * deflection  # interactions
+        residual = site.voice_volume_monthly * (1.0 - bot_deflection)
+        return residual * va_deflection  # interactions
     if feature == "Virtual Agent (legacy)":
         deflection = scope.deflection_target or 0.0
         return site.voice_volume_monthly * deflection
@@ -159,6 +165,11 @@ def _monthly_units(site: SiteInput, feature: str, scope: FeatureScope,
     if feature in ("Direct Messaging", "Social Listening", "Social Responses"):
         eligibility = scope.eligibility_pct if scope.eligibility_pct is not None else 1.0
         return (site.chat_volume_monthly + site.sms_volume_monthly) * eligibility
+    if feature == "AI Translate":
+        # Each voice interaction generates one translation; eligibility_pct
+        # can be used to scope to a subset of interactions (e.g. non-English only).
+        eligibility = scope.eligibility_pct if scope.eligibility_pct is not None else 1.0
+        return site.voice_volume_monthly * eligibility  # translations
     raise KeyError(f"No consumption-volume mapping for feature {feature!r}")
 
 
@@ -260,11 +271,12 @@ def calculate_total_cost(
 
     # Rule 1: Agent Copilot covers Supervisor AI Summary. Sites where
     # Copilot is active this year are excluded from AI Summary billing —
-    # Copilot's 40 tokens/user/month already includes summarization.
-    # https://help.mypurecloud.com/articles/genesys-cloud-ai-experience-tokens-faqs/
+    # Copilot's per-user token rate already includes interaction summarization.
+    # https://help.genesys.cloud/articles/genesys-cloud-tokens-model/
+    _COPILOT_FEATURES = {"Agent Copilot [named]", "Agent Copilot [concurrent]"}
     copilot_sites: set[str] = set()
     for scope in feature_scopes:
-        if scope.feature == "Agent Copilot":
+        if scope.feature in _COPILOT_FEATURES:
             copilot_sites |= {
                 s.site_name for s in sites if scope.active(s.site_name, year)
             }