chore: deprecate document.execute() in favor of document.generate() (v0.19.0) #153
Conversation
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
…v0.19.0) - Add deprecation warning to execute() method - Redirect execute() calls to generate() with domain name conversion (slash -> dot) - /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:
|
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 Python SDK with vlm-lab PR #1595 which removes the
/document/executeendpoint and unifies redaction domains under/document/generate.The
execute()method onFilePredictions(used byclient.document,client.audio,client.video) is now a thin deprecation wrapper that:DeprecationWarningnameparam from slash to dot notation (healthcare/phi-redaction→healthcare.phi-redaction)self.generate()with the converted domainNo new functionality — this is purely a deprecation shim.
Review & Testing Checklist for Human
FilePredictionsis shared acrossdocument,audio, andvideoroutes. Verify thataudio.execute()andvideo.execute()are also intended to be deprecated, or if onlydocument.execute()should be affected. The current change deprecates ALL routes.versionparameter is silently dropped — the oldexecute()sentversionto the API; the new delegation togenerate()does not forward it. Confirm this is acceptable.modelparameter defaults to"vlm-1"ingenerate()— oldexecute()never sent amodelfield. Verify the backend handles this correctly for former execute use cases.make testto confirm existing tests pass (especiallytest_document_executeintests/test_predictions.py), since the mock expectations may have changed.Notes