Skip to content

DOC: Guidance for serializing model metadata #2435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Richard Lundeen (rlundeen2) merged 1 commit into from
Aug 20, 2026
+2 −0
Merged

DOC: Guidance for serializing model metadata #2435

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/code/framework.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,8 @@ The below talks about responsibilities of most modules in the PyRIT library
- Models includes `identifiers` which are descriptions of the core components. And along with the registry, can often recreate those components.
- Models includes types passed around between components, and should be prefered in REST
- models should never depend on anything except lightweight Python (the standard library and pydantic) and pyrit.common
- Store metadata on the narrowest model that owns it (for example, request or response data belongs on `MessagePiece`, not `Message`). Use explicit typed fields for stable, core, or independently queried data.
- For shared metadata, define a lightweight value object in `pyrit.models` that owns its keys and provides symmetric `to_metadata()` and `from_metadata()` methods. Use `JsonResponseConfig` as the pattern for data stored in `MessagePiece.prompt_metadata`.

## [Normalizers](./targets/11_message_normalizer)

Expand Down
Loading