Skip to content
Reference

m3.aggregations ​

Signatures use ... for factory-backed or opaque defaults. Model field tables show required status, defaults, constraints, and descriptions.

EvaluationGroup ​

python
m3.aggregations.EvaluationGroup(
    *,
    key: collections.abc.Mapping[str, str | int | float | bool | None] = ...,
    values: m3.aggregations.EvaluationStats = ...,
) -> None

Model fields:

FieldTypeRequiredDefaultConstraintsDescription
keycollections.abc.Mapping[str, str | int | float | bool | None]Nofactory builtins.dict()——
valuesm3.aggregations.EvaluationStatsNofactory m3.aggregations.EvaluationStats()——

EvaluationQuery ​

python
m3.aggregations.EvaluationQuery(
    *,
    from_: datetime.datetime | None = None,
    to: datetime.datetime | None = None,
    group_by: tuple[str, ...] = (),
    filters: collections.abc.Mapping[str, tuple[str | int | float | bool | None, ...]] = ...,
    limit: int = 200,
    offset: int = 0,
) -> None

A read-only query over persisted evaluations.

Model fields:

FieldTypeRequiredDefaultConstraintsDescription
from_datetime.datetime | NoneNoNone——
todatetime.datetime | NoneNoNone——
group_bytuple[str, ...]No()——
filterscollections.abc.Mapping[str, tuple[str | int | float | bool | None, ...]]Nofactory builtins.dict()——
limitintNo200ge=1, le=1000—
offsetintNo0ge=0—
  • start (property)

EvaluationReport ​

python
m3.aggregations.EvaluationReport(
    *,
    from_: datetime.datetime | None = None,
    to: datetime.datetime | None = None,
    totals: m3.aggregations.EvaluationStats = ...,
    groups: tuple[m3.aggregations.EvaluationGroup, ...] = (),
    total_groups: int = 0,
    limit: int = 200,
    offset: int = 0,
) -> None

Model fields:

FieldTypeRequiredDefaultConstraintsDescription
from_datetime.datetime | NoneNoNone——
todatetime.datetime | NoneNoNone——
totalsm3.aggregations.EvaluationStatsNofactory m3.aggregations.EvaluationStats()——
groupstuple[m3.aggregations.EvaluationGroup, ...]No()——
total_groupsintNo0——
limitintNo200——
offsetintNo0——

EvaluationStats ​

python
m3.aggregations.EvaluationStats(
    *,
    trial_count: int = 0,
    evaluation_count: int = 0,
    expected_count: int = 0,
    missing_required_count: int = 0,
    pending_required_count: int = 0,
    status_counts: collections.abc.Mapping[str, int] = ...,
    pass_rate: float | None = None,
    average_score: float | None = None,
    score_count: int = 0,
    health: m3.aggregations.HealthStats = ...,
) -> None

Counts and health metrics for one aggregate group.

Model fields:

FieldTypeRequiredDefaultConstraintsDescription
trial_countintNo0ge=0—
evaluation_countintNo0ge=0—
expected_countintNo0ge=0—
missing_required_countintNo0ge=0—
pending_required_countintNo0ge=0—
status_countscollections.abc.Mapping[str, int]Nofactory builtins.dict()——
pass_ratefloat | NoneNoNonege=0, le=1—
average_scorefloat | NoneNoNonege=0, le=1—
score_countintNo0ge=0—
healthm3.aggregations.HealthStatsNofactory m3.aggregations.HealthStats()——

HealthStats ​

python
m3.aggregations.HealthStats(
    *,
    execution_count: int = 0,
    tool_calls: m3.aggregations.ToolCallStats = ...,
    protocol_error_count: int = 0,
    outcome_counts: collections.abc.Mapping[str, int] = ...,
    execution_duration_ms: m3.aggregations.LatencyStats = ...,
    server_latency_ms: m3.aggregations.LatencyStats = ...,
) -> None

Execution and tool health observed for a group.

Model fields:

FieldTypeRequiredDefaultConstraintsDescription
execution_countintNo0ge=0—
tool_callsm3.aggregations.ToolCallStatsNofactory m3.aggregations.ToolCallStats()——
protocol_error_countintNo0ge=0—
outcome_countscollections.abc.Mapping[str, int]Nofactory builtins.dict()——
execution_duration_msm3.aggregations.LatencyStatsNofactory m3.aggregations.LatencyStats()——
server_latency_msm3.aggregations.LatencyStatsNofactory m3.aggregations.LatencyStats()——

LatencyStats ​

python
m3.aggregations.LatencyStats(
    *,
    count: int = 0,
    p50: float | None = None,
    p95: float | None = None,
) -> None

Model fields:

FieldTypeRequiredDefaultConstraintsDescription
countintNo0ge=0—
p50float | NoneNoNonege=0—
p95float | NoneNoNonege=0—

ToolCallStats ​

python
m3.aggregations.ToolCallStats(
    *,
    total: int = 0,
    successful: int = 0,
    failed: int = 0,
) -> None

Model fields:

FieldTypeRequiredDefaultConstraintsDescription
totalintNo0ge=0—
successfulintNo0ge=0—
failedintNo0ge=0—

aggregate_evaluations ​

python
m3.aggregations.aggregate_evaluations(
    query: EvaluationQuery,
    records: Iterable[EvaluationRecord],
    *,
    snapshots: Mapping[str, Any] | None = None,
    specifications: Mapping[str, Any] | None = None,
    traces: Mapping[str, Any] | None = None,
    attempt_states: Mapping[str, str] | None = None,
    project_names: Mapping[str, str] | None = None,
) -> EvaluationReport

Aggregate persisted evaluations and unresolved specification requirements.