Skip to content

chore: deprecate document.execute() in favor of document.generate() (v0.19.0)#124

Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1770927283-deprecate-document-execute
Open

chore: deprecate document.execute() in favor of document.generate() (v0.19.0)#124
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1770927283-deprecate-document-execute

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 12, 2026

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/execute endpoint in v0.19.0. Redaction and edit domains now flow through /document/generate with dot-notation domain names.

execute() is converted from a direct API call into a deprecation shim that:

  1. Emits a console.warn deprecation message
  2. Converts the name parameter from slash notation (healthcare/phi-redaction) to dot notation (healthcare.phi-redaction)
  3. Delegates to generate() with the converted domain

Unit tests are updated to verify the delegation behavior and domain name conversion.

Review & Testing Checklist for Human

  • Verify version param is intentionally dropped: The old execute() accepted a version parameter that is silently discarded in the new delegation path since generate() has no version param. Confirm this is acceptable.
  • Verify config/metadata defaults are equivalent: Previously execute() manually set defaults (e.g., detail: "auto", environment: "dev"). Now generate() handles defaults. Check that generate()'s defaults match the old behavior.
  • Check that FileExecuteParams type is still needed: The type and related exports (AgentExecutionResponse, etc.) remain in types.ts but the underlying endpoint no longer exists. Consider if these should be marked deprecated or cleaned up.
  • Test 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

  • The responseModel config test case was removed since config handling is now fully delegated to generate() (which has its own tests for this).
  • console.warn is used for the deprecation notice — callers will see this in their logs.
  • This is one of three coordinated PRs for the v0.19.0 redaction unification and new edit capability:

Requested by: dinesh@vlm.run
Link to Devin run

…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>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants