Include Model Name in Completion Response#198
Open
Melbourneandrew wants to merge 2 commits into567-labs:mainfrom
Open
Include Model Name in Completion Response#198Melbourneandrew wants to merge 2 commits into567-labs:mainfrom
Melbourneandrew wants to merge 2 commits into567-labs:mainfrom
Conversation
🦋 Changeset detectedLatest commit: 91660c2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to 91660c2 in 1 minute and 21 seconds
More details
- Looked at
23lines of code in2files - Skipped
0files when reviewing. - Skipped posting
3drafted comments based on config settings.
1. src/instructor.ts:205
- Draft comment:
New model field inclusion in _meta looks appropriate. Consider adding tests or inline documentation confirming its expected source and behavior for future maintainability. - Reason this comment was not posted:
Confidence changes required:0%<= threshold70%
None
2. .changeset/blue-hats-behave.md:1
- Draft comment:
Changeset file looks good and clearly documents the patch. - Reason this comment was not posted:
Confidence changes required:0%<= threshold70%
None
3. src/instructor.ts:205
- Draft comment:
The added 'model' field is nested under _meta, but the PR specification shows 'model' as a top‑level key. Ensure the response structure matches the desired output (i.e. 'model' and 'thinking' at the root level with only 'usage' inside _meta) or update the spec accordingly. - Reason this comment was not posted:
Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 70%
The code shows a consistent pattern of keeping metadata fields under _meta. The comment suggests breaking this pattern without strong evidence. Moving 'model' to root level would be inconsistent with how 'usage' and 'thinking' are handled. The comment makes assumptions about a spec we can't see.
I could be wrong about the spec - maybe there is documentation somewhere that explicitly requires 'model' to be at the root level.
Without seeing clear evidence from a spec, we should assume the consistent pattern in the code is intentional. Breaking this pattern would reduce code consistency.
Delete the comment. It suggests breaking a consistent pattern without strong evidence, and makes assumptions about requirements we can't verify.
Workflow ID: wflow_8mFUD6CWaHd7Tk5m
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
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.
Including model name in non-streaming completion response. Desired outputs shaped like this:
Important
Add model name to non-streaming completion response in
Instructorclass.modelname in non-streaming completion response inchatCompletionStandard()ininstructor.ts.blue-hats-behave.mdfor version tracking.This description was created by
for 91660c2. It will automatically update as commits are pushed.