fix(giskard-checks): preserve concrete trace type on scenario results

[kevinmessiaen]

Updated scenario result final trace type to be generic. Fixing an issue where pydantic would cast to Trace and losing custom display:

New:

Old:

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an issue where Pydantic's default behavior would cast specific Trace implementations to a generic Trace type, leading to a loss of custom display information. By introducing a TraceType generic parameter to ScenarioResult and SuiteResult classes, the system now correctly preserves the concrete type of the trace throughout the scenario execution and result aggregation. This ensures that custom display logic associated with specific trace types remains intact, improving the accuracy and utility of scenario results.

Highlights

• Generic Type Parameterization: The ScenarioResult and SuiteResult classes were updated to be generic over a TraceType, allowing for the preservation of concrete trace types.
• Preservation of Concrete Trace Types: The final_trace attribute within ScenarioResult was modified to use the new TraceType generic, preventing Pydantic from casting to a base Trace type and losing custom display information.
• Type Signature Alignment: Return types and list types across scenario.py, runner.py, and suite.py were updated to align with the new generic TraceType for consistent type handling.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request aims to preserve concrete Trace types in scenario results by making ScenarioResult generic over TraceType. This is a good approach for individual scenario runs. However, the implementation for Suite and SuiteResult seems to re-introduce the problem by using a generic SuiteResult[Trace[Any, Any]], which will likely cause Pydantic to cast all trace types to a common base type, losing the specific type information. My review includes several suggestions to make SuiteResult non-generic and use list[ScenarioResult] to correctly handle heterogeneous trace types within a suite. The rest of the changes for Scenario and ScenarioResult look correct.

[davidberenstein1957]

LFTM. Not sure if it should be part of this PR, but perhaps we can control the visualisation a bit more.

• can we outline assistents left, users right?
• how do we deal with very long conversations, do we truncate them?
• do we visualise metadata etc?

[kevinmessiaen]

@davidberenstein1957

Yes basically this can be done inside the custom __rich_console__ method. But it'll be nice to have builtin and more example in the documentation