docs: document score result shape#189
Merged
Abhijeet Prasad (AbhiPrasad) merged 3 commits intoJun 8, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds README documentation defining the public Score result object returned by scorers, clarifying which fields external consumers should use and what context is intentionally kept outside the Score.
Changes:
- Documented the
Scoreresult shape (name,score,metadata, and deprecatederror) in the README. - Clarified that inputs/expected values/prompts/runtime context are not included in
Scoreand should be stored separately.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Abhijeet Prasad (AbhiPrasad)
approved these changes
Jun 8, 2026
Abhijeet Prasad (AbhiPrasad)
merged commit 7dcc2ed
into
braintrustdata:main
3 of 8 checks passed
Braintrust eval report
|
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.
Summary
Documents the small
Scoreresult object returned by scorers in the README.The new section calls out the public fields consumers should read when storing, comparing, or exporting evaluation results:
name,score,metadata, and the deprecatederrorfield. It also clarifies that inputs, expected values, prompts, and runtime context are kept separately from the returnedScore.Context
This follows the public-surface clarification from #187, where maintainers confirmed the returned
Scoreobject is the right minimal scorer-consumer boundary.Validation
git diff --check