revenium-python-sdk 0.6.0__tar.gz → 0.7.0__tar.gz

{revenium_python_sdk-0.6.0 → revenium_python_sdk-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: revenium-python-sdk
-Version: 0.6.0
+Version: 0.7.0
 Summary: The official Revenium Python SDK — unified AI metering middleware for OpenAI, Anthropic, Google, Ollama, LiteLLM, Perplexity, and fal.ai.
 Author-email: Revenium <support@revenium.io>
 License: MIT
@@ -311,7 +311,10 @@ history = get_outcome_history("sales-lead-8842")
 # List[JobOutcomeAmendment], ordered by amendment_sequence (1 = the initial report)
 ```
 
-`amend_outcome()` takes a mandatory non-blank `reason` plus the same optional fields as `report_outcome()` (`execution_status`, `outcome_type`, `outcome_value`, `outcome_currency`, `metadata`, `reported_by`), and returns the updated job as a dict.
+`amend_outcome()` takes a mandatory non-blank `reason` plus the same optional fields as `report_outcome()` (`execution_status`, `outcome_type`, `outcome_value`, `outcome_currency`, `metadata`, `reported_by`, `outcome_reason`), and returns the updated job as a dict.
+
+- **`reason` vs `outcome_reason`:** `reason` is the amendment's own audit justification (why the record changed); `outcome_reason` is the business explanation of why the job failed or was cancelled. Use `outcome_reason` for failure explanations rather than burying them in `metadata` — it is a first-class field on the outcome and is returned on every `get_outcome_history()` row.
+- **Clearing `outcome_reason`:** omit the argument to leave the stored value untouched; pass an empty string (`outcome_reason=""`) to clear it.
 
 ### Outcome Exceptions
 
@@ -779,6 +782,7 @@ litellm_settings:
 ```
 
 When using the LiteLLM proxy, pass metadata via HTTP headers (`x-revenium-*`).
+Reasoning effort travels as `x-revenium-effort` on the proxied request.
 
 #### LiteLLM Decorators
 
@@ -1071,6 +1075,7 @@ Add business context to any API call by passing a `usage_metadata` dictionary. A
 | `productName` | Your product or feature name | Attribute AI costs to specific features (e.g., `"customer-chatbot"`, `"email-assistant"`). Auto-creates if not found |
 | `agent` | AI agent or bot identifier | Distinguish between multiple AI agents or automation workflows |
 | `response_quality_score` | Custom quality rating (0.0-1.0) | Track user satisfaction or automated quality metrics for model performance analysis |
+| `effort` | Reasoning effort level requested of the model (free-form string, max 16 chars, `^[A-Za-z0-9_-]+$`) | Report what share of AI spend is high-effort reasoning, and compare cost per effort level |
 
 **Example:**
 
@@ -1093,11 +1098,27 @@ response = client.chat.completions.create(
         "subscription_id": "pro-plan-Q1",
         "productName": "customer-support-chatbot",
         "agent": "support-agent",
-        "response_quality_score": 0.92
+        "response_quality_score": 0.92,
+        "effort": "high"
     }
 )
 ```
 
+**Reasoning effort:** `effort` records how hard the model was asked to think, so
+high-effort reasoning spend can be separated from the rest. It is a free-form
+string, not an enum -- vendor vocabularies differ and drift, so `low`, `medium`,
+`high`, `xhigh` and `ultra` are all real values, and a level this SDK release has
+never heard of is passed through untouched rather than rejected or rewritten. The
+Revenium backend owns validation (at most 16 characters, matching
+`^[A-Za-z0-9_-]+$`); a value it rejects fails the metering call visibly instead
+of being silently dropped, so it surfaces in the log and in
+`get_metering_status()`. It is distinct from the reported reasoning token count,
+which measures the tokens actually spent rather than the level requested.
+
+Set it per call in `usage_metadata` on any provider integration. In LiteLLM proxy
+mode, where per-call attribution travels as request headers rather than
+`usage_metadata`, send `x-revenium-effort` instead.
+
 **Deprecation notice:** The legacy field aliases `organizationId`, `organization_id`, `productId`, and `product_id` are accepted by this SDK only as an input-layer convenience and emit a `DeprecationWarning`. The Revenium backend no longer accepts them — they are translated to `organizationName` / `productName` before the wire call. Migrate to `organization_name` / `organizationName` and `product_name` / `productName` now; the input-layer aliases will be removed in the next major release.
 
 **API Reference:** [Complete metadata field documentation](https://revenium.readme.io/reference/meter_ai_completion)

{revenium_python_sdk-0.6.0 → revenium_python_sdk-0.7.0}/README.md

@@ -214,7 +214,10 @@ history = get_outcome_history("sales-lead-8842")
 # List[JobOutcomeAmendment], ordered by amendment_sequence (1 = the initial report)
 ```
 
-`amend_outcome()` takes a mandatory non-blank `reason` plus the same optional fields as `report_outcome()` (`execution_status`, `outcome_type`, `outcome_value`, `outcome_currency`, `metadata`, `reported_by`), and returns the updated job as a dict.
+`amend_outcome()` takes a mandatory non-blank `reason` plus the same optional fields as `report_outcome()` (`execution_status`, `outcome_type`, `outcome_value`, `outcome_currency`, `metadata`, `reported_by`, `outcome_reason`), and returns the updated job as a dict.
+
+- **`reason` vs `outcome_reason`:** `reason` is the amendment's own audit justification (why the record changed); `outcome_reason` is the business explanation of why the job failed or was cancelled. Use `outcome_reason` for failure explanations rather than burying them in `metadata` — it is a first-class field on the outcome and is returned on every `get_outcome_history()` row.
+- **Clearing `outcome_reason`:** omit the argument to leave the stored value untouched; pass an empty string (`outcome_reason=""`) to clear it.
 
 ### Outcome Exceptions
 
@@ -682,6 +685,7 @@ litellm_settings:
 ```
 
 When using the LiteLLM proxy, pass metadata via HTTP headers (`x-revenium-*`).
+Reasoning effort travels as `x-revenium-effort` on the proxied request.
 
 #### LiteLLM Decorators
 
@@ -974,6 +978,7 @@ Add business context to any API call by passing a `usage_metadata` dictionary. A
 | `productName` | Your product or feature name | Attribute AI costs to specific features (e.g., `"customer-chatbot"`, `"email-assistant"`). Auto-creates if not found |
 | `agent` | AI agent or bot identifier | Distinguish between multiple AI agents or automation workflows |
 | `response_quality_score` | Custom quality rating (0.0-1.0) | Track user satisfaction or automated quality metrics for model performance analysis |
+| `effort` | Reasoning effort level requested of the model (free-form string, max 16 chars, `^[A-Za-z0-9_-]+$`) | Report what share of AI spend is high-effort reasoning, and compare cost per effort level |
 
 **Example:**
 
@@ -996,11 +1001,27 @@ response = client.chat.completions.create(
         "subscription_id": "pro-plan-Q1",
         "productName": "customer-support-chatbot",
         "agent": "support-agent",
-        "response_quality_score": 0.92
+        "response_quality_score": 0.92,
+        "effort": "high"
     }
 )
 ```
 
+**Reasoning effort:** `effort` records how hard the model was asked to think, so
+high-effort reasoning spend can be separated from the rest. It is a free-form
+string, not an enum -- vendor vocabularies differ and drift, so `low`, `medium`,
+`high`, `xhigh` and `ultra` are all real values, and a level this SDK release has
+never heard of is passed through untouched rather than rejected or rewritten. The
+Revenium backend owns validation (at most 16 characters, matching
+`^[A-Za-z0-9_-]+$`); a value it rejects fails the metering call visibly instead
+of being silently dropped, so it surfaces in the log and in
+`get_metering_status()`. It is distinct from the reported reasoning token count,
+which measures the tokens actually spent rather than the level requested.
+
+Set it per call in `usage_metadata` on any provider integration. In LiteLLM proxy
+mode, where per-call attribution travels as request headers rather than
+`usage_metadata`, send `x-revenium-effort` instead.
+
 **Deprecation notice:** The legacy field aliases `organizationId`, `organization_id`, `productId`, and `product_id` are accepted by this SDK only as an input-layer convenience and emit a `DeprecationWarning`. The Revenium backend no longer accepts them — they are translated to `organizationName` / `productName` before the wire call. Migrate to `organization_name` / `organizationName` and `product_name` / `productName` now; the input-layer aliases will be removed in the next major release.
 
 **API Reference:** [Complete metadata field documentation](https://revenium.readme.io/reference/meter_ai_completion)

{revenium_python_sdk-0.6.0 → revenium_python_sdk-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "revenium-python-sdk"
-version = "0.6.0"
+version = "0.7.0"
 description = "The official Revenium Python SDK — unified AI metering middleware for OpenAI, Anthropic, Google, Ollama, LiteLLM, Perplexity, and fal.ai."
 readme = "README.md"
 requires-python = ">=3.8"

revenium_python_sdk-0.7.0/revenium_middleware/_core/cache_tokens.py

@@ -0,0 +1,109 @@
+"""Tolerant field access for provider usage objects (dict or attribute-style).
+
+Cache token fields differ by provider surface:
+
+- Anthropic-style: top-level ``cache_read_input_tokens`` / ``cache_creation_input_tokens``,
+  plus the nested per-TTL breakdown under ``cache_creation``.
+- OpenAI-style: nested ``prompt_tokens_details.cached_tokens``; no separate
+  cache-creation count.
+
+See BACK-2391 for the history of this bug class (hardcoded/zeroed cache-token
+fields recurring across multiple emitters) and BACK-1925 for the LiteLLM
+client's cache-token contract, which this module's defaults must not break.
+"""
+from numbers import Number
+from typing import Any, Dict, NamedTuple, Optional
+
+
+class CacheTokens(NamedTuple):
+    cache_read_tokens: int
+    cache_creation_tokens: int
+
+
+def _get(source: Any, name: str) -> Any:
+    """Read `name` from a dict or an attribute-style object; None if absent."""
+    if source is None:
+        return None
+    if isinstance(source, dict):
+        return source.get(name)
+    return getattr(source, name, None)
+
+
+def get_usage_field(usage: Any, name: str, default: int = 0) -> Any:
+    """Read a single usage field through the same tolerant accessor as
+    `extract_cache_tokens`, so cache fields and base token fields (prompt/
+    completion/total) are read consistently from the same dict-or-object
+    usage value. Missing or None fields return `default`.
+
+    Normalizing a usage object to a plain dict *before* reading it (e.g. to
+    simplify a `.get(...)` call) silently drops every field for
+    attribute-style usage objects that fall through that normalization --
+    exactly the inconsistency this function exists to prevent. Callers with
+    multiple fields to read from the same `usage` value should read all of
+    them through this function (or `extract_cache_tokens`) rather than
+    normalizing `usage` itself first.
+    """
+    value = _get(usage, name)
+    return default if value is None else value
+
+
+def extract_cache_tokens(usage: Any) -> CacheTokens:
+    """Extract (cache_read_tokens, cache_creation_tokens) from a usage object.
+
+    Tolerates dicts and attribute-style objects (SimpleNamespace, SDK response
+    models) and treats missing or None fields as 0. Checked in order:
+
+    1. OpenAI-style nested cache reads: ``usage.prompt_tokens_details.cached_tokens``
+    2. Anthropic-style top-level cache reads: ``usage.cache_read_input_tokens``
+    3. Anthropic-style top-level cache creation: ``usage.cache_creation_input_tokens``
+    """
+    prompt_details = _get(usage, "prompt_tokens_details")
+    cache_read_tokens = get_usage_field(prompt_details, "cached_tokens", 0)
+    if not cache_read_tokens:
+        cache_read_tokens = get_usage_field(usage, "cache_read_input_tokens", 0)
+    cache_creation_tokens = get_usage_field(usage, "cache_creation_input_tokens", 0)
+
+    return CacheTokens(cache_read_tokens=cache_read_tokens, cache_creation_tokens=cache_creation_tokens)
+
+
+def _optional_token_count(source: Any, name: str) -> Optional[int]:
+    """Read an integral token count, or None when it is absent or unusable.
+
+    Unlike `get_usage_field`, a missing field is reported as None rather than
+    coerced to 0, so callers can tell "the provider reported zero" apart from
+    "the provider reported nothing". Non-numeric values (including the
+    attributes that attribute-style test doubles auto-create on access) count
+    as nothing rather than being forwarded into a metering payload.
+    """
+    value = _get(source, name)
+    if isinstance(value, bool) or not isinstance(value, Number):
+        return None
+    return int(value)
+
+
+def extract_cache_creation_ttl_counts(usage: Any) -> Dict[str, int]:
+    """Extract the per-TTL cache-creation breakdown as metering parameters.
+
+    Anthropic reports the split under a nested ``usage.cache_creation`` object
+    (``ephemeral_5m_input_tokens`` / ``ephemeral_1h_input_tokens``). That
+    object is absent on older responses and whenever the extended cache-TTL
+    beta is not in play, so it is read defensively.
+
+    Returns metering parameter names mapped to the counts the provider
+    actually reported, ready to be merged into a metering payload. A bucket the
+    provider did not report is left out entirely instead of being sent as a
+    zero: the aggregate ``cache_creation_token_count`` stays authoritative and
+    the backend prices the flat fallback from it when no split is present,
+    whereas an explicit zero would assert a split that never happened. A
+    bucket the provider does report as 0 is forwarded as 0.
+    """
+    cache_creation = _get(usage, "cache_creation")
+
+    counts: Dict[str, int] = {}
+    ephemeral_5m = _optional_token_count(cache_creation, "ephemeral_5m_input_tokens")
+    if ephemeral_5m is not None:
+        counts["cache_creation5m_token_count"] = ephemeral_5m
+    ephemeral_1h = _optional_token_count(cache_creation, "ephemeral_1h_input_tokens")
+    if ephemeral_1h is not None:
+        counts["cache_creation1h_token_count"] = ephemeral_1h
+    return counts