Skip to content

UsageReport

autogen.beta.usage.UsageReport dataclass #

UsageReport(total=Usage(), records=(), by_model=dict(), by_provider=dict(), by_kind=dict())

Aggregated token usage for a run, broken down by stage.

total class-attribute instance-attribute #

total = field(default_factory=Usage)

records class-attribute instance-attribute #

records = ()

by_model class-attribute instance-attribute #

by_model = field(default_factory=dict)

by_provider class-attribute instance-attribute #

by_provider = field(default_factory=dict)

by_kind class-attribute instance-attribute #

by_kind = field(default_factory=dict)

from_events classmethod #

from_events(events)
Source code in autogen/beta/usage.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
@classmethod
def from_events(cls, events: Iterable[BaseEvent]) -> "UsageReport":
    records: list[UsageRecord] = []
    for event in events:
        record = _record_for(event)
        if record is not None:
            records.append(record)

    by_model: dict[str, Usage] = {}
    by_provider: dict[str, Usage] = {}
    by_kind: dict[str, Usage] = {}
    for record in records:
        if record.model is not None:
            by_model[record.model] = by_model.get(record.model, Usage()) + record.usage
        if record.provider is not None:
            by_provider[record.provider] = by_provider.get(record.provider, Usage()) + record.usage
        by_kind[record.kind] = by_kind.get(record.kind, Usage()) + record.usage

    return cls(
        total=sum((record.usage for record in records), Usage()),
        records=tuple(records),
        by_model=by_model,
        by_provider=by_provider,
        by_kind=by_kind,
    )