FEAT: Adding Json Schema Pipeline to SeedPrompts by riedgar-ms · Pull Request #1432 · microsoft/PyRIT

riedgar-ms · 2026-03-02T19:43:00Z

Added JSON Schema that can be added directly in yaml, by putting a json_schema inline or using a name that references datasets or (so diff datasets can easily share)
Added a message normalizer so that targets that support it can use the schema in the request or add the text to the request if it's not supported
Updated refusal scorers to use json schema (followup could have all JSON schemas use this)
Moved json_response_config to pyrit.prompt_target.common, which makes more sense since it's tied to targets

co-authored/hijacked by rlundeen

Copilot

Pull request overview

This PR embeds a JSON response schema into the SelfAskRefusalScorer’s seed YAML and plumbs that schema through scoring so compatible prompt targets can request schema-constrained JSON output.

Changes:

Add response_json_schema to SeedPrompt and populate it in the default refusal scorer YAML.
Update SelfAskRefusalScorer to load and forward the schema into _score_value_with_llm.
Extend _score_value_with_llm to accept an optional schema and attach it to prompt_metadata for JSON-response-capable targets.

Reviewed changes

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

File	Description
pyrit/score/true_false/self_ask_refusal_scorer.py	Loads schema from the seed prompt and forwards it into LLM scoring + identifier params.
pyrit/score/scorer.py	Adds schema parameter and injects it into request metadata for JSON response formatting.
pyrit/models/seeds/seed_prompt.py	Introduces a new optional `response_json_schema` field on `SeedPrompt`.
pyrit/datasets/score/refusal/refusal_default.yaml	Defines the refusal scorer response JSON schema and tightens the schema text in the prompt.

riedgar-ms · 2026-03-02T20:10:04Z

I'm not massively keen on how I've hidden the type of the schema (and this hiding has provoked most of CoPilot's comments). The solution would be defining a JSONObject type, in the manner of:
python/typing#182
However, that could have quite a blast radius.

Copilot

Pull request overview

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

Copilot

Pull request overview

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

You can also share your feedback on Copilot code review. Take the survey.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

You can also share your feedback on Copilot code review. Take the survey.

…onschema-01

rom typing import override is 3.12+; PyRIT supports >=3.10. The project intentionally suppresses the missing-override-decorator rule (see pyproject.toml [tool.ty.rules]) precisely so we don't have to pull in the typing_extensions backport. Aligning this normalizer with the rest of pyrit/message_normalizer/, which override methods without the decorator. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

JSON Schema 'description' is the canonical place for field-level guidance. Adding them here means: * Native JSON_SCHEMA targets (OpenAI, Anthropic) pass field descriptions through to the model as part of the schema metadata. * When JsonSchemaNormalizer falls back to injecting the pretty-printed schema into the prompt body, the descriptions ride along automatically via {schema_json}. * Scorer prompt YAMLs no longer need to redundantly describe the shape of each field; that responsibility moves to the schema (single source of truth) so scorer prompts can focus on the task framing. Descriptions are intentionally generic so the schema stays reusable across any future self-ask True/False scorer. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

build_scripts/check_no_rest_roles.py rejects :class:/:func:/:meth:/ :data: cross-reference roles in docstrings and comments; the docs pipeline auto-links bare `Foo` spans against known PyRIT symbols via build_scripts/gen_api_md.py. Switching all sites I introduced in pyrit/models/json_schema_definition.py and pyrit/message_normalizer/json_schema_normalizer.py to plain double-backticks so the pre-commit hook passes and the rendered docs link the same way as the rest of the codebase. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Single ValueError string now fits within line length; ruff-format auto-reformats this on pre-commit. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…/riedgar-ms/PyRIT into riedgar-ms/selfask-jsonschema-01

…lizer When both MULTI_TURN and JSON_SCHEMA need adaptation, the pipeline ran HistorySquashNormalizer first and produced a fresh Message.from_prompt(...) with empty prompt_metadata. The subsequent JsonSchemaNormalizer then saw no schema key and no-oped, so the schema instructions were silently dropped from the squashed text. HistorySquashNormalizer now carries the last message's prompt_metadata onto the squashed piece so downstream normalizers still see request-level metadata. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Same shape as the HistorySquashNormalizer fix: a fresh Message.from_prompt(...) produced by squashing carried empty prompt_metadata, so when both SYSTEM_PROMPT and JSON_SCHEMA needed adaptation, the schema key was silently dropped before JsonSchemaNormalizer ran. Single-system case carries the system piece's metadata; system+user squash carries the user piece's metadata (the user piece represents the current request being sent). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Both squash normalizers (history and system) need to carry the last subsumed message's prompt_metadata onto the fresh Message.from_prompt(...) so downstream normalizers in the pipeline still see request-level metadata such as the JSON schema key. Centralize that rule in pyrit/message_normalizer/_helpers.py so any future squash-style normalizer gets correct propagation by default. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

riedgar-ms · 2026-06-08T12:51:45Z

@rlundeen2 @romanlutz first, apologies for accidentally pinging you both on #1346 ; I was updating both PRs, and didn't notice that I was writing in the wrong tab until after I'd hit 'comment' (not that I wouldn't appreciate a review on that PR as well).

I think I've merged in the latest changes from main and updated everything for the latest set of linting rule updates correctly. The type checker also started complaining about memory_models.py, and I had to ask Copilot for help fixing that. As such, those changes might bear closer examination.

…onschema-01 # Conflicts: # pyrit/memory/memory_models.py

Copilot AI review requested due to automatic review settings March 2, 2026 19:43

Copilot started reviewing on behalf of riedgar-ms March 2, 2026 19:43 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

riedgar-ms commented Mar 2, 2026

View reviewed changes

Comment thread pyrit/datasets/score/refusal/refusal_default.yaml Outdated

Copilot AI review requested due to automatic review settings March 3, 2026 16:18

Copilot started reviewing on behalf of riedgar-ms March 3, 2026 16:19 View session

Copilot AI reviewed Mar 3, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings March 4, 2026 14:12

Copilot started reviewing on behalf of riedgar-ms March 4, 2026 14:12 View session

Copilot AI reviewed Mar 4, 2026

View reviewed changes

Comment thread pyrit/score/scorer.py Outdated

Comment thread pyrit/score/scorer.py Outdated

Comment thread pyrit/score/scorer.py Outdated

Comment thread pyrit/score/scorer.py Outdated

Copilot AI review requested due to automatic review settings March 5, 2026 11:41

Copilot started reviewing on behalf of riedgar-ms March 5, 2026 11:42 View session

Copilot AI reviewed Mar 5, 2026

View reviewed changes

Comment thread pyrit/datasets/score/refusal/refusal_default.yaml Outdated

riedgar-ms added 9 commits March 26, 2026 14:16

Tweak prompt yaml

f2041d8

Small iteration

de6309f

Fiddling

7e926dd

Adding some comments

a137629

Dealing with mypy

760211f

Naming

edda2ea

Merge changes (I think?)

8ce6a54

Revert to main

e0fef73

Run pre-commit

04795e5

riedgar-ms force-pushed the riedgar-ms/selfask-jsonschema-01 branch from c679a55 to 04795e5 Compare March 26, 2026 18:18

riedgar-ms added 6 commits March 26, 2026 18:36

Merge remote-tracking branch 'origin/main' into riedgar-ms/selfask-js…

369fc36

…onschema-01

Merge remote-tracking branch 'origin/main' into riedgar-ms/selfask-js…

64a0aa2

…onschema-01

Merge remote-tracking branch 'origin/main' into riedgar-ms/selfask-js…

ea36b75

…onschema-01

Merge remote-tracking branch 'origin/main' into riedgar-ms/selfask-js…

5a9ce12

…onschema-01

Merge remote-tracking branch 'origin/main' into riedgar-ms/selfask-js…

9790be1

…onschema-01

Merge changes from main

b50086f

riedgar-ms commented Jun 4, 2026

View reviewed changes

Comment thread pyrit/datasets/score/refusal/refusal_no_objective_lenient.yaml

rlundeen2 and others added 8 commits June 4, 2026 12:42

STYLE Collapse multi-line raise to satisfy ruff-format

e06d9c0

Single ValueError string now fits within line length; ruff-format auto-reformats this on pre-commit. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Merge branch 'riedgar-ms/selfask-jsonschema-01' of https://github.com…

78635df

…/riedgar-ms/PyRIT into riedgar-ms/selfask-jsonschema-01

Merge branch 'main' into riedgar-ms/selfask-jsonschema-01

d48f29e

Clean up override

70a2fa0

Missed override

dc73d18

romanlutz reviewed Jun 5, 2026

View reviewed changes

Comment thread pyrit/prompt_target/common/conversation_normalization_pipeline.py

Comment thread pyrit/models/json_schema_definition.py

riedgar-ms and others added 10 commits June 5, 2026 12:38

Merge branch 'main' into riedgar-ms/selfask-jsonschema-01

6a24935

Multi-arg calls should be all-kwarg

607249c

STYLE Rename helper kwarg to new_message_content

61f2e1b

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Merging from main.... think this is correct

8ccfc8d

ruffen

1e4c6c1

Fix memory model type annotations

b6ca3bb

Fix ScenarioRunState model export

7069be9

Merge branch 'main' into riedgar-ms/selfask-jsonschema-01

100feeb

romanlutz approved these changes Jun 9, 2026

View reviewed changes

Merge remote-tracking branch 'origin/main' into riedgar-ms/selfask-js…

478a33d

…onschema-01 # Conflicts: # pyrit/memory/memory_models.py

rlundeen2 force-pushed the riedgar-ms/selfask-jsonschema-01 branch from d280fa9 to 478a33d Compare June 9, 2026 21:07

rlundeen2 enabled auto-merge June 9, 2026 21:09

rlundeen2 added this pull request to the merge queue Jun 9, 2026

Merged via the queue into microsoft:main with commit 37468e5 Jun 9, 2026
53 checks passed

riedgar-ms deleted the riedgar-ms/selfask-jsonschema-01 branch June 10, 2026 09:40

Uh oh!

Conversation

riedgar-ms commented Mar 2, 2026 • edited by rlundeen2 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

riedgar-ms commented Mar 2, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

riedgar-ms commented Jun 8, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

riedgar-ms commented Mar 2, 2026 •

edited by rlundeen2

Loading