Add structured JSON outputs for ChatBob integration#83
Open
ChrisCollison wants to merge 22 commits into
Open
Conversation
…rmation about the incoming dataset such that a ChatBOB can use that information downstream
…the variable desc_keep, which is a variable built at source in the original ROBERT. Here we add a label to the JSON auditing files so that the variable can be better understood by ChatBob
… locally on my computer
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a structured JSON evidence layer to ROBERT without changing its standard behavior.
The new JSON files capture information that ROBERT already generates during CURATE, GENERATE, VERIFY, PREDICT, and REPORT. All ChatBob-related JSON files are written to a separate top-level
JSON/directory, while the existing DAT, CSV, image, and PDF outputs remain in their normal locations.I'm including:
Runtime JSON audit files are implemented for:
REPORT currently includes figure provenance only, rather than a complete report audit.
But AQME and EVALUATE JSON audits are not included in this PR.
JSON writing is fail-soft, so a problem writing a JSON file should not interrupt or alter a normal ROBERT run.
I validated, as follows:
The modified ROBERT 2.1.2 workflow was compared with an unmodified ROBERT 2.1.2 workflow using the same input dataset.
The comparison found:
The generated JSON files were also reviewed against the corresponding ROBERT DAT information.
For the tested workflow, the JSON additions did not change ROBERT’s scientific outputs.
Scope
This PR is intended to add structured access to information ROBERT already produces. It does not intentionally change:
I next want to work on the JSON schema so I am calling the current set up 'experimental' while it is aligned with the questions ChatBob users are likely to ask.
Follow-up work
The next steps are to: