Skip to content

v0.21.1

Choose a tag to compare

@thorrester thorrester released this 12 Mar 20:22
· 392 commits to main since this release
4e3ec57

v0.21.1 Release Summary

What Changed

This release renames the GenAI evaluation result types to remove the GenAI prefix. The names GenAIEvalResults, GenAIEvalSet, GenAIEvalTaskResult, and GenAIEvalResultSet have been replaced with shorter, framework-agnostic equivalents. No behavior or schema changes are included.


Breaking Changes

All four GenAI eval result types have been renamed. Any code importing or referencing these types must be updated.

Old name New name
GenAIEvalResults EvalResults
GenAIEvalSet EvalSet
GenAIEvalTaskResult EvalTaskResult
GenAIEvalResultSet EvalResultSet

This affects:

  • Python imports from scouter or scouter.evaluate
  • Type annotations referencing these classes
  • Any serialized JSON being deserialized back into these types via model_validate_json (type name is not embedded in the JSON payload, so existing stored results are unaffected)

Changes

GenAI evaluation — type renaming

The GenAI prefix has been dropped from four result container types. The change is purely nominal — fields, methods, and return values are identical. The rename touches the Rust crates (scouter_types, scouter_evaluate, scouter_dataframe, scouter_client, scouter_sql), PyO3 bindings, Python stubs, and the public scouter.evaluate module.

Drifter.compute_drift() return type annotation updated from GenAIEvalResultSet to EvalResultSet. EvalDataset.evaluate() return type updated from GenAIEvalResults to EvalResults.

Tracing — storage architecture documentation

Added py-scouter/docs/docs/tracing/storage-architecture.md documenting the Delta Lake + DataFusion write/query pipeline, component reference table, and the dual-actor buffer/engine design.


Upgrading from v0.21.0

  1. Replace all imports of the renamed types:

    # Before
    from scouter.evaluate import (
        GenAIEvalResults,
        GenAIEvalSet,
        GenAIEvalTaskResult,
        GenAIEvalResultSet,
    )
    
    # After
    from scouter.evaluate import (
        EvalResults,
        EvalSet,
        EvalTaskResult,
        EvalResultSet,
    )

    The top-level scouter namespace export has changed the same way:

    # Before
    from scouter import GenAIEvalResults
    # After
    from scouter import EvalResults
  2. Update any type annotations that reference the old names.

  3. No database migrations, no environment variable changes, no serialization format changes.