Skip to main content

Deterministic, pre-execution spend limiting for semantic actions in agent systems.

Project description

BudgetGate

Deterministic, pre-execution spend limiting for semantic actions in agent systems.

Source of Truth

The canonical source is github.com/actiongate-oss/budgetgate. PyPI distribution is a convenience mirror.

Vendoring encouraged. This is a small, stable primitive. Copy it, fork it, reimplement it. See SEMANTICS.md for the behavioral contract if you reimplement.


Quick Start

from decimal import Decimal
from budgetgate import Engine, Ledger, Budget, BudgetExceeded

engine = Engine()

@engine.guard(
    Ledger("openai", "gpt-4", "user:123"),
    Budget(max_spend=Decimal("10.00"), window=3600),  # $10/hour
    cost=Decimal("0.03"),  # fixed cost per call
)
def call_gpt4(prompt: str) -> str:
    return openai.chat(prompt)

try:
    response = call_gpt4("Hello")
except BudgetExceeded as e:
    print(f"Budget exceeded: {e.decision.spent_in_window} spent")

Two Cost Modes

Fixed Cost (pre-execution)

When cost is known before execution:

@engine.guard(
    Ledger("openai", "embedding"),
    Budget(max_spend=Decimal("5.00"), window=3600),
    cost=Decimal("0.0001"),  # fixed cost per call
)
def embed(text: str) -> list[float]:
    return openai.embed(text)

Bounded Dynamic Cost (pre-execution with estimate)

When cost depends on the result but has a known upper bound:

@engine.guard_bounded(
    Ledger("anthropic", "claude", "user:123"),
    Budget(max_spend=Decimal("5.00"), window=3600),
    estimate=Decimal("0.50"),  # max possible cost (reserved before execution)
    actual=lambda r: Decimal(str(r.usage.total_cost)),  # actual cost (committed after)
)
def call_claude(prompt: str) -> Response:
    return anthropic.messages.create(...)

The estimate is reserved before execution. If it doesn't fit the budget, the action is blocked. After execution, the actual cost is committed and unused budget is recovered.


Core Concepts

Ledger

Identifies a spend-tracked stream:

Ledger(namespace, resource, principal)

Ledger("openai", "gpt-4", "user:123")     # per-user
Ledger("anthropic", "claude", "team:eng") # per-team
Ledger("infra", "compute", "global")      # global

Budget

Budget(
    max_spend=Decimal("10.00"),  # max spend in window
    window=3600,                  # rolling window (seconds)
    mode=Mode.HARD,               # HARD raises, SOFT returns result
    on_store_error=StoreErrorMode.FAIL_CLOSED,
)

Decision

Every check returns a Decision with:

decision.allowed          # bool
decision.spent_in_window  # Decimal - current spend
decision.remaining        # Decimal - budget remaining
decision.requested        # Decimal - amount requested

Decorator Styles

Decorator Cost Mode Returns On Block
guard Fixed T Raises BudgetExceeded
guard_bounded Dynamic T Raises BudgetExceeded
guard_result Fixed Result[T] Returns blocked result
guard_bounded_result Dynamic Result[T] Returns blocked result
# Raises on block
@engine.guard(ledger, budget, cost=Decimal("0.01"))
def fixed_action(): ...

@engine.guard_bounded(ledger, budget, estimate=Decimal("0.50"), actual=lambda r: r.cost)
def dynamic_action(): ...

# Never raises - returns Result[T]
@engine.guard_result(ledger, budget, cost=Decimal("0.01"))
def fixed_action(): ...

@engine.guard_bounded_result(ledger, budget, estimate=Decimal("0.50"), actual=lambda r: r.cost)
def dynamic_action(): ...

Relation to ActionGate

BudgetGate complements ActionGate:

Primitive Limits Use case
ActionGate calls/time Rate limiting
BudgetGate cost/time Spend limiting

Both are:

  • Deterministic
  • Pre-execution
  • Decorator-friendly
  • Store-backed

Use together:

from decimal import Decimal

@actiongate_engine.guard(Gate("api", "search"), Policy(max_calls=100))
@budgetgate_engine.guard(Ledger("api", "search"), Budget(max_spend=Decimal("1.00")), cost=Decimal("0.01"))
def search(query: str) -> list:
    ...

API Reference

Type Purpose
Engine Core spend tracking
Ledger Spend stream identity
Budget Spend policy
Decision Evaluation result
Result[T] Wrapper for guard_result
BudgetExceeded Exception from guard
Enum Values
Mode HARD, SOFT
StoreErrorMode FAIL_CLOSED, FAIL_OPEN
Status ALLOW, BLOCK
BlockReason BUDGET_EXCEEDED, STORE_ERROR

Numeric Precision

All spend amounts use Decimal to avoid floating-point drift. See SEMANTICS.md §9.


License

Apache License 2.0. See LICENSE for the full text.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

budgetgate-0.3.0.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

budgetgate-0.3.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file budgetgate-0.3.0.tar.gz.

File metadata

  • Download URL: budgetgate-0.3.0.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for budgetgate-0.3.0.tar.gz
Algorithm Hash digest
SHA256 da3b4602110c673e440d3b46a08fd70dd84a8733a4ca5041ea5c3314a5cc5cdd
MD5 874600a5f4f4b3551c78e21cc68229f7
BLAKE2b-256 3d9747a3af7076bc07c4794c513b059b7d04454c44433256d5a24e74eab21e67

See more details on using hashes here.

File details

Details for the file budgetgate-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: budgetgate-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for budgetgate-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 05d0d14329e458897a5722bee275e94dbdfca9eb7019eed100a767cc9e537e7c
MD5 3b4b33b452b7d956eea494217bb26ccd
BLAKE2b-256 1373488dfda668f3bb155136d441f961f69792572cf8b21c12d6d7fdab89d3dc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page