chore: deprecate document.execute() in favor of document.generate() (v0.19.0)#124
Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Open
chore: deprecate document.execute() in favor of document.generate() (v0.19.0)#124devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Conversation
…v0.19.0) - Add deprecation warning to execute() method - Redirect execute() calls to generate() with domain name conversion (slash -> dot) - Update unit tests to verify new delegation behavior - /document/execute endpoint removed in v0.19.0, redaction domains now use /document/generate Co-Authored-By: dinesh@vlm.run <dinesh@vlm.run>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
4 tasks
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.
chore: deprecate document.execute() in favor of generate() (v0.19.0)
Summary
Aligns the Node SDK with vlm-lab PR #1595 which removed the
/document/executeendpoint in v0.19.0. Redaction and edit domains now flow through/document/generatewith dot-notation domain names.execute()is converted from a direct API call into a deprecation shim that:console.warndeprecation messagenameparameter from slash notation (healthcare/phi-redaction) to dot notation (healthcare.phi-redaction)generate()with the converted domainUnit tests are updated to verify the delegation behavior and domain name conversion.
Review & Testing Checklist for Human
versionparam is intentionally dropped: The oldexecute()accepted aversionparameter that is silently discarded in the new delegation path sincegenerate()has noversionparam. Confirm this is acceptable.execute()manually set defaults (e.g.,detail: "auto",environment: "dev"). Nowgenerate()handles defaults. Check thatgenerate()'s defaults match the old behavior.FileExecuteParamstype is still needed: The type and related exports (AgentExecutionResponse, etc.) remain intypes.tsbut the underlying endpoint no longer exists. Consider if these should be marked deprecated or cleaned up.execute()→generate()delegation end-to-end against a dev environment running v0.19.0 to confirm the redaction flow works through the new path (npm run test:integration).Notes
responseModelconfig test case was removed since config handling is now fully delegated togenerate()(which has its own tests for this).console.warnis used for the deprecation notice — callers will see this in their logs.healthcare.phi-edit-replacedomain from PR #1576)Requested by: dinesh@vlm.run
Link to Devin run