Skip to content

SK-3075: Document Detect V2 for the skyvault SDK - #287

Draft
promptless[bot] wants to merge 2 commits into
saileshwar/SK-3075-add-detect-v2-skyvault-flowvaultfrom
promptless/SK-3075-skyvault-detect-v2-docs
Draft

promptless[bot] wants to merge 2 commits into
saileshwar/SK-3075-add-detect-v2-skyvault-flowvaultfrom
promptless/SK-3075-skyvault-detect-v2-docs

Conversation

@promptless

@promptless promptless Bot commented Oct 26, 2026

Copy link
Copy Markdown

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 cover deidentify_string, deidentify_file (submit-only and polling with PollOptions, auto-written outputs), get_run, reidentify_string, reidentify_file, and check_guardrails, with skyvault RedactionLevel semantics (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; updates skyvault/samples/README.md.

This branch is based on the PR #286 head branch so the docs can merge with the code change.

Testing

  • codespell passes with the repo config; ruff passes on the new samples; each sample compiles. Samples were not run against a vault.
  • README links into docs/api_reference.md and the samples resolve.

Trigger Events

Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
Comment thread skyvault/README.md Resolved
@promptless

promptless Bot commented Oct 26, 2026

Copy link
Copy Markdown
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.

@promptless promptless Bot changed the title docs: Document Detect V2 for the skyvault SDK SK-3075: Document Detect V2 for the skyvault SDK Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants