revenium-python-sdk 0.1.4__tar.gz → 0.1.6__tar.gz

{revenium_python_sdk-0.1.4/revenium_python_sdk.egg-info → revenium_python_sdk-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: revenium-python-sdk
-Version: 0.1.4
+Version: 0.1.6
 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
@@ -203,6 +203,30 @@ print(response.choices[0].message.content)
 
 ---
 
+## Agentic Outcomes (Outcome-Based Metering)
+
+Emit per-agent terminal outcomes (`CONVERTED`, `DEFLECTED`, `ESCALATED`) alongside completion and tool-event records, so dashboards show business value next to AI cost.
+
+```python
+from revenium_middleware.agentic_outcomes import AgenticOutcomeClient, AgenticOutcomeSettings
+
+settings = AgenticOutcomeSettings(api_key="rev_sk_...")
+client = AgenticOutcomeClient(settings)
+
+client.emit_completion(...)                # one per LLM call
+client.emit_tool_event(...)                # one per tool / step
+client.report_outcome(job_id, {...})       # close the job with a terminal outcome
+client.close()
+```
+
+The job is created implicitly by the first metric ingested for `agenticJobId`. Call `client.create_job(job_id)` explicitly if you need to record an agent run before emitting any metrics.
+
+See [`examples/agentic_outcomes/`](examples/agentic_outcomes/) for runnable demos (sales / coding / support) with configurable failure rates and outcome distributions.
+
+**API reference:** [docs.revenium.io](https://docs.revenium.io) · per-endpoint reference at [revenium.readme.io/reference/meter_ai_completion](https://revenium.readme.io/reference/meter_ai_completion).
+
+---
+
 ## Provider Usage Guides
 
 ### OpenAI
@@ -292,7 +316,7 @@ client = anthropic.Anthropic()
 
 # Basic message
 message = client.messages.create(
-    model="claude-3-haiku-20240307",
+    model="claude-opus-4-7",
     max_tokens=100,
     messages=[{"role": "user", "content": "Hello!"}],
     usage_metadata={
@@ -304,7 +328,7 @@ message = client.messages.create(
 
 # Streaming
 with client.messages.stream(
-    model="claude-3-haiku-20240307",
+    model="claude-opus-4-7",
     max_tokens=200,
     messages=[{"role": "user", "content": "Tell me a story"}],
     usage_metadata={"task_type": "creative"}
@@ -330,7 +354,7 @@ client = anthropic.AnthropicBedrock(
 )
 
 message = client.messages.create(
-    model="anthropic.claude-3-haiku-20240307-v1:0",
+    model="claude-opus-4-7",
     max_tokens=100,
     messages=[{"role": "user", "content": "Hello from Bedrock!"}]
 )
@@ -354,6 +378,11 @@ message = client.messages.create(
 
 | Anthropic Model | Bedrock Model ID |
 |----------------|------------------|
+| `claude-opus-4-7` | `anthropic.claude-opus-4-7` |
+| `us.claude-opus-4-7` | `us.anthropic.claude-opus-4-7` |
+| `eu.claude-opus-4-7` | `eu.anthropic.claude-opus-4-7` |
+| `au.claude-opus-4-7` | `au.anthropic.claude-opus-4-7` |
+| `global.claude-opus-4-7` | `global.anthropic.claude-opus-4-7` |
 | `claude-3-opus-20240229` | `anthropic.claude-3-opus-20240229-v1:0` |
 | `claude-3-sonnet-20240229` | `anthropic.claude-3-sonnet-20240229-v1:0` |
 | `claude-3-haiku-20240307` | `us.anthropic.claude-3-5-haiku-20241022-v1:0` |
@@ -676,7 +705,7 @@ handler = ReveniumCallbackHandler(
     agent_name="support_agent"
 )
 
-llm = ChatOpenAI(model="gpt-4", callbacks=[handler])
+llm = ChatOpenAI(model="gpt-4o-mini", callbacks=[handler])
 response = llm.invoke("Hello!")
 ```
 
@@ -715,7 +744,7 @@ result = agent.invoke(
 from revenium_middleware_langchain import AsyncReveniumCallbackHandler
 
 handler = AsyncReveniumCallbackHandler(trace_id="async-session")
-llm = ChatOpenAI(model="gpt-4", callbacks=[handler])
+llm = ChatOpenAI(model="gpt-4o-mini", callbacks=[handler])
 response = await llm.ainvoke("Hello!")
 ```
 
@@ -783,7 +812,7 @@ response = client.chat.completions.create(
 )
 ```
 
-**Deprecation notice:** The old field names `organizationId`, `organization_id`, `productId`, and `product_id` are still supported for backward compatibility but are deprecated. Use `organizationName` and `productName` for new implementations.
+**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)
 
@@ -964,7 +993,7 @@ from revenium_middleware import revenium_meter, revenium_metadata
 def premium_feature(prompt: str) -> str:
     # This WILL be metered (decorated with @revenium_meter)
     response = client.chat.completions.create(
-        model="gpt-4o",
+        model="gpt-4o-mini",
         messages=[{"role": "user", "content": prompt}]
     )
     return response.choices[0].message.content
@@ -1080,65 +1109,11 @@ Prompt capture works with both streaming and non-streaming requests, and with mu
 
 ---
 
-## Terminal Summary Output
-
-Display a cost and usage summary in your terminal after each API request. Useful for development, debugging, and monitoring AI costs in real-time.
-
-### Configuration
-
-| Environment Variable | Values | Description |
-|---------------------|--------|-------------|
-| `REVENIUM_PRINT_SUMMARY` | `false` (default), `true` or `human`, `json` | Controls output format |
-| `REVENIUM_TEAM_ID` | Your team ID | Required to fetch and display cost information |
-
-```bash
-# Enable human-readable output
-export REVENIUM_PRINT_SUMMARY=human
-
-# Required for cost display (find in Revenium web app)
-export REVENIUM_TEAM_ID=your-team-id-here
-```
-
-### Human-Readable Format
-
-```
-============================================================
-REVENIUM USAGE SUMMARY
-============================================================
-Model: gpt-4o-mini
-Provider: OPENAI
-Duration: 1.23s
-
-Token Usage:
-  Input Tokens:  150
-  Output Tokens: 250
-  Total Tokens:  400
-
-Cost: $0.000045
-
-Trace ID: abc-123
-============================================================
-```
-
-### JSON Format
-
-```json
-{"model":"gpt-4o-mini","provider":"OPENAI","durationSeconds":1.23,"inputTokenCount":150,"outputTokenCount":250,"totalTokenCount":400,"cost":0.000045,"costStatus":"available","traceId":"abc-123"}
-```
-
-### Cost Status
-
-| Scenario | Display |
-|----------|---------|
-| Cost available | `$0.000045` |
-| `REVENIUM_TEAM_ID` set, cost pending | `Pending (aggregating... check Revenium dashboard)` |
-| `REVENIUM_TEAM_ID` not set | `Add REVENIUM_TEAM_ID to see pricing` |
-
----
-
 ## Cost Controls / Enforcement
 
-Block outbound provider requests client-side when a Revenium cost-limit rule trips. When the circuit breaker is enabled, the middleware polls enforcement rules from the Revenium API in a background daemon thread and raises `ReveniumCostLimitExceeded` **before** the upstream call, preventing spend beyond the configured limit.
+Block outbound provider requests client-side when a Revenium cost control trips. When the circuit breaker is enabled, the middleware polls compiled enforcement rules from the Revenium API in a background daemon thread and raises `BudgetExceededError` **before** the upstream call, preventing spend beyond the configured limit.
+
+> **Terminology note:** The customer-facing entity is called a **cost control**, served by the backend at `/v2/api/ai/cost-controls`. This SDK polls a separate compiled-rules feed at `/v2/api/ai/enforcement-rules/{teamId}` and is unaffected by changes to the CRUD path — no SDK upgrade is required.
 
 Currently wired for the OpenAI provider (other providers land via per-provider follow-on tickets).
 
@@ -1164,7 +1139,7 @@ REVENIUM_ENFORCEMENT_BASE_URL=https://api.revenium.ai/profitstream  # optional
 | `REVENIUM_TEAM_ID` | — | Hashed team ID. Path component on rule fetches; required when the breaker is enabled. |
 | `REVENIUM_ENFORCEMENT_BASE_URL` | origin of `REVENIUM_METERING_BASE_URL` | Base URL for the enforcement API. Set when the enforcement API lives behind a context-path. |
 | `REVENIUM_CB_POLL_INTERVAL_SECONDS` | `60` | Background poll interval for rule refreshes. |
-| `REVENIUM_CB_FAIL_MODE` | `open` | `open` (default) lets calls through when no cache exists; `closed` raises `ReveniumCostLimitExceeded` until rules are loaded. |
+| `REVENIUM_CB_FAIL_MODE` | `open` | `open` (default) lets calls through when no cache exists; `closed` raises `BudgetExceededError` until rules are loaded. |
 | `REVENIUM_CACHE_DIR` | — | When set, the rule cache is mirrored to `<dir>/revenium_enforcement_rules.json` so a restarted process doesn't fail-closed on the very first call. |
 
 ### Public API
@@ -1188,7 +1163,7 @@ The pre-call check fires before every chat / embeddings / responses call. When t
 ### Exception Contract
 
 ```python
-from revenium_middleware.openai import ReveniumCostLimitExceeded
+from revenium_middleware.openai import BudgetExceededError
 ```
 
 When a tripped rule matches the current request, the middleware raises before the OpenAI call is made. All structured fields are populated when the server provides them:
@@ -1202,10 +1177,10 @@ When a tripped rule matches the current request, the middleware raises before th
 | `resets_at` | `str \| None` | ISO-8601 timestamp the rule next resets |
 | `rule_id` | `str \| int \| None` | Server-side rule identifier |
 
-`ReveniumCostLimitExceeded` does **not** inherit from `ReveniumMiddlewareError`, so the OpenAI middleware's `handle_exception_safely` decorator never swallows it — it always reaches your `except` block.
+`BudgetExceededError` does **not** inherit from `ReveniumMiddlewareError`, so the OpenAI middleware's `handle_exception_safely` decorator never swallows it — it always reaches your `except` block.
 
 ```python
-from revenium_middleware.openai import ReveniumCostLimitExceeded
+from revenium_middleware.openai import BudgetExceededError
 import openai
 
 client = openai.OpenAI()
@@ -1215,7 +1190,7 @@ try:
         model="gpt-4o-mini",
         messages=[{"role": "user", "content": "Summarize the meeting notes"}],
     )
-except ReveniumCostLimitExceeded as exc:
+except BudgetExceededError as exc:
     print(f"Cost limit reached: {exc.message}")
     print(f"Rule {exc.rule_name}: {exc.current_value} / {exc.threshold}; resets {exc.resets_at}")
 ```
@@ -1251,9 +1226,8 @@ See [`examples/openai/openai_blocking_demo.py`](examples/openai/openai_blocking_
 | `REVENIUM_METERING_BASE_URL` | `https://api.revenium.ai` | Revenium API endpoint |
 | `REVENIUM_LOG_LEVEL` | `INFO` | Log level: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` |
 | `REVENIUM_CAPTURE_PROMPTS` | `false` | Enable prompt capture |
-| `REVENIUM_PRINT_SUMMARY` | `false` | Terminal output: `false`, `true`/`human`, `json` |
 | `REVENIUM_SELECTIVE_METERING` | `false` | Only meter `@revenium_meter` decorated functions |
-| `REVENIUM_TEAM_ID` | - | Team ID for cost display in terminal summary |
+| `REVENIUM_TEAM_ID` | - | Team ID for cost lookups |
 | `REVENIUM_ENVIRONMENT` | - | Deployment environment (auto-detects from `ENVIRONMENT`, `DEPLOYMENT_ENV`) |
 | `REVENIUM_REGION` | - | Cloud region (auto-detects from `AWS_REGION`, `AZURE_REGION`, `GCP_REGION`) |
 | `REVENIUM_CREDENTIAL_ALIAS` | - | Human-readable API key name |

{revenium_python_sdk-0.1.4 → revenium_python_sdk-0.1.6}/README.md

@@ -115,6 +115,30 @@ print(response.choices[0].message.content)
 
 ---
 
+## Agentic Outcomes (Outcome-Based Metering)
+
+Emit per-agent terminal outcomes (`CONVERTED`, `DEFLECTED`, `ESCALATED`) alongside completion and tool-event records, so dashboards show business value next to AI cost.
+
+```python
+from revenium_middleware.agentic_outcomes import AgenticOutcomeClient, AgenticOutcomeSettings
+
+settings = AgenticOutcomeSettings(api_key="rev_sk_...")
+client = AgenticOutcomeClient(settings)
+
+client.emit_completion(...)                # one per LLM call
+client.emit_tool_event(...)                # one per tool / step
+client.report_outcome(job_id, {...})       # close the job with a terminal outcome
+client.close()
+```
+
+The job is created implicitly by the first metric ingested for `agenticJobId`. Call `client.create_job(job_id)` explicitly if you need to record an agent run before emitting any metrics.
+
+See [`examples/agentic_outcomes/`](examples/agentic_outcomes/) for runnable demos (sales / coding / support) with configurable failure rates and outcome distributions.
+
+**API reference:** [docs.revenium.io](https://docs.revenium.io) · per-endpoint reference at [revenium.readme.io/reference/meter_ai_completion](https://revenium.readme.io/reference/meter_ai_completion).
+
+---
+
 ## Provider Usage Guides
 
 ### OpenAI
@@ -204,7 +228,7 @@ client = anthropic.Anthropic()
 
 # Basic message
 message = client.messages.create(
-    model="claude-3-haiku-20240307",
+    model="claude-opus-4-7",
     max_tokens=100,
     messages=[{"role": "user", "content": "Hello!"}],
     usage_metadata={
@@ -216,7 +240,7 @@ message = client.messages.create(
 
 # Streaming
 with client.messages.stream(
-    model="claude-3-haiku-20240307",
+    model="claude-opus-4-7",
     max_tokens=200,
     messages=[{"role": "user", "content": "Tell me a story"}],
     usage_metadata={"task_type": "creative"}
@@ -242,7 +266,7 @@ client = anthropic.AnthropicBedrock(
 )
 
 message = client.messages.create(
-    model="anthropic.claude-3-haiku-20240307-v1:0",
+    model="claude-opus-4-7",
     max_tokens=100,
     messages=[{"role": "user", "content": "Hello from Bedrock!"}]
 )
@@ -266,6 +290,11 @@ message = client.messages.create(
 
 | Anthropic Model | Bedrock Model ID |
 |----------------|------------------|
+| `claude-opus-4-7` | `anthropic.claude-opus-4-7` |
+| `us.claude-opus-4-7` | `us.anthropic.claude-opus-4-7` |
+| `eu.claude-opus-4-7` | `eu.anthropic.claude-opus-4-7` |
+| `au.claude-opus-4-7` | `au.anthropic.claude-opus-4-7` |
+| `global.claude-opus-4-7` | `global.anthropic.claude-opus-4-7` |
 | `claude-3-opus-20240229` | `anthropic.claude-3-opus-20240229-v1:0` |
 | `claude-3-sonnet-20240229` | `anthropic.claude-3-sonnet-20240229-v1:0` |
 | `claude-3-haiku-20240307` | `us.anthropic.claude-3-5-haiku-20241022-v1:0` |
@@ -588,7 +617,7 @@ handler = ReveniumCallbackHandler(
     agent_name="support_agent"
 )
 
-llm = ChatOpenAI(model="gpt-4", callbacks=[handler])
+llm = ChatOpenAI(model="gpt-4o-mini", callbacks=[handler])
 response = llm.invoke("Hello!")
 ```
 
@@ -627,7 +656,7 @@ result = agent.invoke(
 from revenium_middleware_langchain import AsyncReveniumCallbackHandler
 
 handler = AsyncReveniumCallbackHandler(trace_id="async-session")
-llm = ChatOpenAI(model="gpt-4", callbacks=[handler])
+llm = ChatOpenAI(model="gpt-4o-mini", callbacks=[handler])
 response = await llm.ainvoke("Hello!")
 ```
 
@@ -695,7 +724,7 @@ response = client.chat.completions.create(
 )
 ```
 
-**Deprecation notice:** The old field names `organizationId`, `organization_id`, `productId`, and `product_id` are still supported for backward compatibility but are deprecated. Use `organizationName` and `productName` for new implementations.
+**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)
 
@@ -876,7 +905,7 @@ from revenium_middleware import revenium_meter, revenium_metadata
 def premium_feature(prompt: str) -> str:
     # This WILL be metered (decorated with @revenium_meter)
     response = client.chat.completions.create(
-        model="gpt-4o",
+        model="gpt-4o-mini",
         messages=[{"role": "user", "content": prompt}]
     )
     return response.choices[0].message.content
@@ -992,65 +1021,11 @@ Prompt capture works with both streaming and non-streaming requests, and with mu
 
 ---
 
-## Terminal Summary Output
-
-Display a cost and usage summary in your terminal after each API request. Useful for development, debugging, and monitoring AI costs in real-time.
-
-### Configuration
-
-| Environment Variable | Values | Description |
-|---------------------|--------|-------------|
-| `REVENIUM_PRINT_SUMMARY` | `false` (default), `true` or `human`, `json` | Controls output format |
-| `REVENIUM_TEAM_ID` | Your team ID | Required to fetch and display cost information |
-
-```bash
-# Enable human-readable output
-export REVENIUM_PRINT_SUMMARY=human
-
-# Required for cost display (find in Revenium web app)
-export REVENIUM_TEAM_ID=your-team-id-here
-```
-
-### Human-Readable Format
-
-```
-============================================================
-REVENIUM USAGE SUMMARY
-============================================================
-Model: gpt-4o-mini
-Provider: OPENAI
-Duration: 1.23s
-
-Token Usage:
-  Input Tokens:  150
-  Output Tokens: 250
-  Total Tokens:  400
-
-Cost: $0.000045
-
-Trace ID: abc-123
-============================================================
-```
-
-### JSON Format
-
-```json
-{"model":"gpt-4o-mini","provider":"OPENAI","durationSeconds":1.23,"inputTokenCount":150,"outputTokenCount":250,"totalTokenCount":400,"cost":0.000045,"costStatus":"available","traceId":"abc-123"}
-```
-
-### Cost Status
-
-| Scenario | Display |
-|----------|---------|
-| Cost available | `$0.000045` |
-| `REVENIUM_TEAM_ID` set, cost pending | `Pending (aggregating... check Revenium dashboard)` |
-| `REVENIUM_TEAM_ID` not set | `Add REVENIUM_TEAM_ID to see pricing` |
-
----
-
 ## Cost Controls / Enforcement
 
-Block outbound provider requests client-side when a Revenium cost-limit rule trips. When the circuit breaker is enabled, the middleware polls enforcement rules from the Revenium API in a background daemon thread and raises `ReveniumCostLimitExceeded` **before** the upstream call, preventing spend beyond the configured limit.
+Block outbound provider requests client-side when a Revenium cost control trips. When the circuit breaker is enabled, the middleware polls compiled enforcement rules from the Revenium API in a background daemon thread and raises `BudgetExceededError` **before** the upstream call, preventing spend beyond the configured limit.
+
+> **Terminology note:** The customer-facing entity is called a **cost control**, served by the backend at `/v2/api/ai/cost-controls`. This SDK polls a separate compiled-rules feed at `/v2/api/ai/enforcement-rules/{teamId}` and is unaffected by changes to the CRUD path — no SDK upgrade is required.
 
 Currently wired for the OpenAI provider (other providers land via per-provider follow-on tickets).
 
@@ -1076,7 +1051,7 @@ REVENIUM_ENFORCEMENT_BASE_URL=https://api.revenium.ai/profitstream  # optional
 | `REVENIUM_TEAM_ID` | — | Hashed team ID. Path component on rule fetches; required when the breaker is enabled. |
 | `REVENIUM_ENFORCEMENT_BASE_URL` | origin of `REVENIUM_METERING_BASE_URL` | Base URL for the enforcement API. Set when the enforcement API lives behind a context-path. |
 | `REVENIUM_CB_POLL_INTERVAL_SECONDS` | `60` | Background poll interval for rule refreshes. |
-| `REVENIUM_CB_FAIL_MODE` | `open` | `open` (default) lets calls through when no cache exists; `closed` raises `ReveniumCostLimitExceeded` until rules are loaded. |
+| `REVENIUM_CB_FAIL_MODE` | `open` | `open` (default) lets calls through when no cache exists; `closed` raises `BudgetExceededError` until rules are loaded. |
 | `REVENIUM_CACHE_DIR` | — | When set, the rule cache is mirrored to `<dir>/revenium_enforcement_rules.json` so a restarted process doesn't fail-closed on the very first call. |
 
 ### Public API
@@ -1100,7 +1075,7 @@ The pre-call check fires before every chat / embeddings / responses call. When t
 ### Exception Contract
 
 ```python
-from revenium_middleware.openai import ReveniumCostLimitExceeded
+from revenium_middleware.openai import BudgetExceededError
 ```
 
 When a tripped rule matches the current request, the middleware raises before the OpenAI call is made. All structured fields are populated when the server provides them:
@@ -1114,10 +1089,10 @@ When a tripped rule matches the current request, the middleware raises before th
 | `resets_at` | `str \| None` | ISO-8601 timestamp the rule next resets |
 | `rule_id` | `str \| int \| None` | Server-side rule identifier |
 
-`ReveniumCostLimitExceeded` does **not** inherit from `ReveniumMiddlewareError`, so the OpenAI middleware's `handle_exception_safely` decorator never swallows it — it always reaches your `except` block.
+`BudgetExceededError` does **not** inherit from `ReveniumMiddlewareError`, so the OpenAI middleware's `handle_exception_safely` decorator never swallows it — it always reaches your `except` block.
 
 ```python
-from revenium_middleware.openai import ReveniumCostLimitExceeded
+from revenium_middleware.openai import BudgetExceededError
 import openai
 
 client = openai.OpenAI()
@@ -1127,7 +1102,7 @@ try:
         model="gpt-4o-mini",
         messages=[{"role": "user", "content": "Summarize the meeting notes"}],
     )
-except ReveniumCostLimitExceeded as exc:
+except BudgetExceededError as exc:
     print(f"Cost limit reached: {exc.message}")
     print(f"Rule {exc.rule_name}: {exc.current_value} / {exc.threshold}; resets {exc.resets_at}")
 ```
@@ -1163,9 +1138,8 @@ See [`examples/openai/openai_blocking_demo.py`](examples/openai/openai_blocking_
 | `REVENIUM_METERING_BASE_URL` | `https://api.revenium.ai` | Revenium API endpoint |
 | `REVENIUM_LOG_LEVEL` | `INFO` | Log level: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` |
 | `REVENIUM_CAPTURE_PROMPTS` | `false` | Enable prompt capture |
-| `REVENIUM_PRINT_SUMMARY` | `false` | Terminal output: `false`, `true`/`human`, `json` |
 | `REVENIUM_SELECTIVE_METERING` | `false` | Only meter `@revenium_meter` decorated functions |
-| `REVENIUM_TEAM_ID` | - | Team ID for cost display in terminal summary |
+| `REVENIUM_TEAM_ID` | - | Team ID for cost lookups |
 | `REVENIUM_ENVIRONMENT` | - | Deployment environment (auto-detects from `ENVIRONMENT`, `DEPLOYMENT_ENV`) |
 | `REVENIUM_REGION` | - | Cloud region (auto-detects from `AWS_REGION`, `AZURE_REGION`, `GCP_REGION`) |
 | `REVENIUM_CREDENTIAL_ALIAS` | - | Human-readable API key name |

{revenium_python_sdk-0.1.4 → revenium_python_sdk-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "revenium-python-sdk"
-version = "0.1.4"
+version = "0.1.6"
 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.1.4 → revenium_python_sdk-0.1.6}/revenium_middleware/__init__.py

@@ -157,6 +157,9 @@ from ._core import (  # noqa: E402
 # Re-export tool metering utilities from revenium_metering (v6.8.2+)
 from revenium_metering import meter_tool, report_tool_call, configure  # noqa: E402
 
+# Agentic-outcome client (used by examples/agentic_outcomes/ pack)
+from .agentic_outcomes import AgenticOutcomeClient, AgenticOutcomeSettings  # noqa: E402
+
 __all__ = [
     # Metering exports
     "client",
@@ -181,4 +184,7 @@ __all__ = [
     "meter_tool",
     "report_tool_call",
     "configure",
+    # Agentic-outcome exports
+    "AgenticOutcomeClient",
+    "AgenticOutcomeSettings",
 ]

{revenium_python_sdk-0.1.4 → revenium_python_sdk-0.1.6}/revenium_middleware/_core/__init__.py

@@ -6,7 +6,7 @@ provider-specific middleware implementations.
 """
 
 from .metering import run_async_in_thread, shutdown_event, client
-from .exceptions import ReveniumCostLimitExceeded
+from .exceptions import BudgetExceededError
 from .enforcement import check_enforcement, is_circuit_breaker_enabled, stop_polling
 from .context import (
     is_inside_decorated_function,
@@ -49,7 +49,7 @@ __all__ = [
     "run_async_in_thread",
     "shutdown_event",
     # Enforcement / circuit breaker
-    "ReveniumCostLimitExceeded",
+    "BudgetExceededError",
     "check_enforcement",
     "is_circuit_breaker_enabled",
     "stop_polling",

{revenium_python_sdk-0.1.4 → revenium_python_sdk-0.1.6}/revenium_middleware/_core/config.py

@@ -8,13 +8,10 @@ this via class inheritance and re-export symbols for backward compatibility.
 
 import logging
 import os
-from typing import Set, Literal, Union, Optional
+from typing import Set, Optional
 
 logger = logging.getLogger(__name__)
 
-# Type alias for summary format
-SummaryFormat = Literal["human", "json"]
-
 
 class Config:
     """Shared configuration constants for all Revenium middleware providers."""
@@ -65,13 +62,9 @@ class Config:
     CAPTURE_PROMPTS: bool = False
     MAX_PROMPT_LENGTH: int = 50_000  # Maximum characters per prompt field
 
-    # Terminal summary settings
-    ENV_REVENIUM_PRINT_SUMMARY: str = "REVENIUM_PRINT_SUMMARY"
+    # Revenium API targeting
     ENV_REVENIUM_TEAM_ID: str = "REVENIUM_TEAM_ID"
     ENV_REVENIUM_BASE_URL: str = "REVENIUM_METERING_BASE_URL"
-    SUMMARY_RETRY_ATTEMPTS: int = 3
-    SUMMARY_RETRY_DELAY: float = 2.0
-    SUMMARY_API_TIMEOUT: float = 5.0
     DEFAULT_BASE_URL: str = "https://api.revenium.ai"
 
     # Enforcement / circuit breaker — see _core/enforcement.py.
@@ -139,38 +132,6 @@ def get_timeout_config() -> dict:
     }
 
 
-def parse_print_summary_value(value: Optional[str]) -> Union[bool, SummaryFormat]:
-    """
-    Parse REVENIUM_PRINT_SUMMARY environment variable value.
-
-    Returns:
-        False if disabled, 'human' or 'json' if enabled
-    """
-    if value is None:
-        return False
-
-    value_lower = value.lower().strip()
-
-    if value_lower in ('false', '0', 'no', 'off', 'disabled', ''):
-        return False
-    elif value_lower in ('true', '1', 'yes', 'on', 'enabled', 'human'):
-        return 'human'
-    elif value_lower == 'json':
-        return 'json'
-    else:
-        logger.warning(
-            f"Invalid REVENIUM_PRINT_SUMMARY value '{value}'. "
-            f"Expected 'true', 'human', 'json', or 'false'. Defaulting to disabled."
-        )
-        return False
-
-
-def get_print_summary_config() -> Union[bool, SummaryFormat]:
-    """Get print summary configuration from environment."""
-    value = get_config_value(Config.ENV_REVENIUM_PRINT_SUMMARY)
-    return parse_print_summary_value(value)
-
-
 def get_team_id() -> Optional[str]:
     """Get Revenium team ID from environment."""
     return get_config_value(Config.ENV_REVENIUM_TEAM_ID)

{revenium_python_sdk-0.1.4 → revenium_python_sdk-0.1.6}/revenium_middleware/_core/enforcement.py

@@ -3,7 +3,7 @@ Enforcement engine for the Revenium circuit breaker.
 
 Polls cost-limit rules from the Revenium API in a daemon thread and caches
 them in memory. ``check_enforcement(...)`` is a pre-call hook that raises
-``ReveniumCostLimitExceeded`` when a tripped rule matches the current
+``BudgetExceededError`` when a tripped rule matches the current
 request, blocking the outbound provider call before any spend occurs.
 
 Opt-in via ``REVENIUM_CIRCUIT_BREAKER_ENABLED``. Disabled by default so the
@@ -21,7 +21,7 @@ from urllib.parse import quote, urlparse
 import httpx
 
 from .config import Config
-from .exceptions import ReveniumCostLimitExceeded
+from .exceptions import BudgetExceededError
 
 logger = logging.getLogger("revenium_middleware.extension")
 
@@ -276,7 +276,7 @@ def check_enforcement(usage_metadata: Optional[dict] = None) -> None:
     is disabled or no rules are tripped.
 
     Raises:
-        ReveniumCostLimitExceeded: when a cost-limit rule blocks the call.
+        BudgetExceededError: when a cost-limit rule blocks the call.
             All structured fields (``rule_name``, ``current_value``,
             ``threshold``, ``resets_at``, ``rule_id``) are populated when the
             server provides them.
@@ -295,7 +295,7 @@ def check_enforcement(usage_metadata: Optional[dict] = None) -> None:
     # valid initialized state and must pass through. Use the snapshot taken
     # under _cache_lock so the decision can't see a torn write.
     if _fail_mode_is_closed() and not initialized:
-        raise ReveniumCostLimitExceeded(
+        raise BudgetExceededError(
             "Request blocked: enforcement cache is uninitialized and "
             "REVENIUM_CB_FAIL_MODE=closed."
         )
@@ -319,7 +319,7 @@ def check_enforcement(usage_metadata: Optional[dict] = None) -> None:
             continue
 
         rule_name = rule.get("name", "cost limit")
-        raise ReveniumCostLimitExceeded(
+        raise BudgetExceededError(
             message=f"Request blocked by Revenium enforcement rule: {rule_name}",
             rule_name=rule_name,
             current_value=_coerce_float(rule.get("currentValue")),

{revenium_python_sdk-0.1.4 → revenium_python_sdk-0.1.6}/revenium_middleware/_core/exceptions.py

@@ -1,15 +1,15 @@
 """
 Core exceptions shared across all Revenium middleware providers.
 
-The unified SDK ships ``ReveniumCostLimitExceeded`` from ``_core`` so every
+The unified SDK ships ``BudgetExceededError`` from ``_core`` so every
 provider subpackage (openai, anthropic, google, …) raises the same exception
-type and downstream callers can ``except ReveniumCostLimitExceeded`` once.
+type and downstream callers can ``except BudgetExceededError`` once.
 """
 
 from typing import Optional, Union
 
 
-class ReveniumCostLimitExceeded(Exception):
+class BudgetExceededError(Exception):
     """Raised when a Revenium enforcement rule blocks the outbound request.
 
     Inherits directly from ``Exception`` (not from any middleware-error base)
@@ -33,3 +33,11 @@ class ReveniumCostLimitExceeded(Exception):
         self.threshold = threshold
         self.resets_at = resets_at
         self.rule_id = rule_id
+
+
+# Deprecated alias preserved for backward compatibility. The exception was
+# renamed in v0.1.5 to align with the Go and Node SDKs and the backend
+# `BudgetExceededException`. Existing code that does
+# `except ReveniumCostLimitExceeded:` continues to catch the new exception
+# unchanged. Plan to remove in a future major release.
+ReveniumCostLimitExceeded = BudgetExceededError