Repository navigation
SK-3075: Document Detect V2 for the skyvault SDK - #287
Draft
promptless[bot] wants to merge 2 commits into
Draft
promptless[bot] wants to merge 2 commits into
promptless[bot] wants to merge 2 commits into
Conversation
Author
|
I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed. |
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.
Open in Promptless
Why
PR #286 (SK-3075) replaces skyvault's V1 Detect API with Detect V2, but the skyvault docs still describe the removed methods and classes (
deidentify_text,reidentify_text,get_detect_run,DeidentifyTextRequest,TokenFormat,DetectEntities, and others). Readers who follow the skyvault README or samples after this change will get import errors.Goal
Document Detect V2 for the skyvault package:
skyvault/README.md: rewrites the Detect section to coverdeidentify_string,deidentify_file(submit-only and polling withPollOptions, auto-written outputs),get_run,reidentify_string,reidentify_file, andcheck_guardrails, with skyvaultRedactionLevelsemantics (entity_name+redaction_type).docs/api_reference.md: replaces the V1 Detect request, response, helper, and enum entries with the V2 models and enums.skyvault/samples/detect_api/: replaces the five V1 samples with six V2 samples; updatesskyvault/samples/README.md.This branch is based on the PR #286 head branch so the docs can merge with the code change.
Testing
docs/api_reference.mdand the samples resolve.Trigger Events