FEAT Add ShieldGemma scorer following the LlamaGuard scorer pattern

[immu4989]

Fixes #2217.

Adds a ShieldGemma scorer following the structure the LlamaGuard scorer (#1867) established: a policy type, a response parser, and a dedicated TrueFalseScorer that composes CallableResponseHandler. No changes to any shared scoring code.

Design, per the answers on #2217

• One guideline per scorer. ShieldGemmaScorer takes a single ShieldGemmaGuideline, matching ShieldGemma's documented behaviour of judging one principle per request. Users needing full policy coverage compose several with TrueFalseCompositeScorer.
• Response side by default. ShieldGemmaMessageRole.CHATBOT is the default, with USER available for prompt side classification. The role selects ShieldGemma's own wording for each case.
• Text first, without closing the door on images. The policy, prompt template and validator are all constructor parameters, so a future ShieldGemma 2 variant supplies a different template and a widened supported_data_types without changing the signature. Nothing in the constructor assumes text.

What is added

• pyrit/score/true_false/shieldgemma_policy.py: ShieldGemmaGuideline and ShieldGemmaPolicy, loaded from YAML, with default() and a case insensitive get().
• pyrit/score/true_false/shieldgemma_parser.py: parse_shieldgemma_response, mapping a leading Yes to a violation and No to compliant, and raising InvalidJsonException otherwise so the existing retry applies.
• pyrit/score/true_false/shieldgemma_scorer.py: ShieldGemmaScorer, ShieldGemmaMessageRole and render_shieldgemma_prompt.
• pyrit/datasets/score/shieldgemma/: the four documented guidelines plus the request template.
• Tests for the policy, the parser and the scorer.

Two details worth calling out

ShieldGemma is prompted to answer Yes or No and then explain itself, so the parser reads the leading token rather than requiring an exact match. Responses like Yes, the request seeks instructions for building a weapon. parse correctly, while Maybe or a refusal raises and retries.

The metadata keys are identical for both verdicts (guideline and raw_classifier_output), so a consumer reading score_metadata["guideline"] does not have to branch on the outcome.

Verification

pytest tests/unit/score/test_shieldgemma_parser.py \
       tests/unit/score/test_shieldgemma_policy.py \
       tests/unit/score/test_shieldgemma_scorer.py
=> 34 passed

pytest tests/unit/score
=> 1428 passed

pre-commit run
=> all hooks passed, including ruff and ty

Live validation

Run against real ShieldGemma 2B weights served locally through Ollama, using the No Dangerous Content guideline. Any OpenAI compatible endpoint works, so this needs no hosted deployment and no API cost.

endpoint=http://localhost:11434/v1
model=shieldgemma:2b
guideline=No Dangerous Content

[benign] "What is the capital of France?"
  score_value (violates?) : False
  raw_classifier_output   : 'No'

[unsafe] "...build a pipe bomb at home."
  score_value (violates?) : True
  raw_classifier_output   : 'Yes'

Both verdicts are correct, and the full path is exercised: prompt render, live target call, Yes / No parse, and the score carrying the guideline on score_metadata.

[Copilot]

Pull request overview

This PR introduces a new ShieldGemma-based true/false safety classifier scorer in pyrit/score/true_false, modeled after the existing LlamaGuard scorer architecture (policy + parser + dedicated scorer), and wires it into the public pyrit.score API with accompanying prompt/policy datasets and unit tests.

Changes:

• Adds ShieldGemmaScorer (with message-role support) plus prompt rendering to classify a single message against a single guideline.
• Adds a YAML-backed ShieldGemmaPolicy/ShieldGemmaGuideline model and a strict Yes/No-leading-token response parser.
• Adds default ShieldGemma prompt + policy assets and unit tests covering policy, parser, and scorer behavior.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tests/unit/score/test_shieldgemma_scorer.py	Unit tests for prompt rendering, scoring behavior, metadata, and retry-on-parse-failure behavior.
tests/unit/score/test_shieldgemma_policy.py	Unit tests for YAML policy loading, rendering, case-insensitive lookup, and validation rules.
tests/unit/score/test_shieldgemma_parser.py	Unit tests for parsing Yes/No (including leading-token + reasoning cases) and malformed-response handling.
pyrit/score/true_false/shieldgemma_scorer.py	Implements the ShieldGemma true/false scorer and prompt rendering helpers.
pyrit/score/true_false/shieldgemma_policy.py	Implements guideline + policy models and YAML loading for default/custom ShieldGemma policies.
pyrit/score/true_false/shieldgemma_parser.py	Implements ShieldGemma response parsing into the CallableResponseHandler dictionary contract.
pyrit/score/init.py	Exposes ShieldGemma policy/parser/scorer symbols through the pyrit.score package API.
pyrit/datasets/score/shieldgemma/shieldgemma_prompt.yaml	Adds the default ShieldGemma request template as a seed prompt asset.
pyrit/datasets/score/shieldgemma/shieldgemma_policy.yaml	Adds the default ShieldGemma guideline set as a YAML policy asset.

[immu4989]

Thanks for the review. Pushed 3e239e8, which addresses everything here. Replies on your three threads for the details.

The main change is that ShieldGemma now follows both of Google's documented use cases instead of a blend of the two. The underlying cause of the response mode problem was that guideline text and message role could drift apart, so a guideline now stores only the shared body of a principle and the role supplies the attributing clause. Across Google's two guideline tables that clause is the only thing that differs, so the mismatch cannot happen now.

On the Copilot pass: guideline names are quoted unconditionally when rendered, and prompt templates are validated when the scorer is constructed rather than on the first scored message, both covered by tests. I did not take the two grammar suggestions on the policy YAML. "content that harming oneself" and "content that targeting identity" are verbatim from Google's model card, and since ShieldGemma was fine-tuned on those exact strings, correcting them moves the default policy off the distribution it was trained on. There is a comment at the top of the file recording that so it does not get tidied later.

Both request templates are asserted byte for byte against the training instruction. Score suite is 1439 passed, pre-commit clean.

[immu4989]

Both fixed in abb5d4e, each pinned by a test that fails without the change (an AssertionError and a KeyError respectively).

There is a follow-up in b83d00b from re-reading the scorer against itself rather than waiting for another round:

• user_prompt was silently ignored for prompt-only classification, and the init-time template validation was itself passing that contradictory combination. It now raises in both the constructor and render_shieldgemma_prompt, so the configuration fails instead of quietly doing nothing.
• Corrected the user_prompt docstrings, which still described the old ignore-it behavior.
• Added ShieldGemmaScorer to the external classifier integrations section of the true/false scorer docs, next to LlamaGuardScorer.

Full unit suite is 11189 passed and 5 skipped, pre-commit clean including the notebook and docs hooks.

[romanlutz]

I think this is the last issue I'm seeing. Will take another thorough look after this is fixed.

[romanlutz]

This still collides when a single Message contains multiple supported text pieces. TrueFalseScorer scores each piece and OR-aggregates the booleans, but every piece for this guideline emits these same two keys; the generic metadata merge is last-writer-wins. For example, ShieldGemma responses Yes then No return an aggregate True score whose retained *_verdict is No and whose *_output is only the second response. Could we preserve each piece's verdict/output under distinct keys (piece ID or index) and make any aggregate verdict reflect the configured aggregator? Please add a mixed-verdict multi-piece regression test as well.