Repository navigation
SK-3289: address Detect docs and sample parity feedback (Python) - #290
Merged
saileshwar-skyflow merged 3 commits intoNov 11, 2026
Merged
saileshwar-skyflow merged 3 commits into
saileshwar-skyflow merged 3 commits into
Conversation
Fix the Detect README and sample gaps raised in the final Detect feedback, for both the flowvault and skyvault Python SDKs. flowvault README: - drop the unsupported SKYFLOW_ID file source (the enum is BASE64/PRESIGNED_URL only) - document Entity/CustomType include_prefix and prefix_override, and CustomType deidentification_type and destination - add where-to-create pointers for the configuration id, token groups and redaction patterns - add response examples and a common-errors section - make the re-identify example a round trip; branch re-identify file on output_type skyvault README: - make the re-identify example a round trip that stores tokens in a table.column; branch re-identify file on output_type - add a bold warning that deidentify_file no longer waits by default - note the server's default toxicity check; fix the stale v1 EOL banner samples (both SDKs): print request_id in Detect error handlers. Nomenclature: drop the "Detect V2" label from both READMEs and the samples README; rename the migration guide to docs/migrate_detect.md, retitle it, cite skyflow 3.0.0, and promote the deidentify_file behaviour change. setup.py version is managed by release automation and left unchanged; the guide now names 3.0.0 as the target. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Promptless documentation updates
|
skyflow-bharti
approved these changes
Nov 9, 2026
flowvault: - Disable the generated client's hidden retry layer so the SDK's configured max_retries (default 0) is honored and POSTs are not silently auto-retried. - Pass the bearer token as None when absent so no empty "Authorization: Bearer " header is sent. - Build insert/get wire objects inside the try block so pydantic ValidationError surfaces as a SkyflowError. - Rewind a caller-supplied file_object to the start before upload (without closing the caller's handle). - Guard client re-init and close with a lock. common (shared by flowvault and skyvault): - Validate env with isinstance instead of enum membership to avoid a TypeError on Python 3.9-3.11 for non-Env values. - Attach the skyflow-python log handler once instead of clearing and re-adding it on every log call. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Mirror the Java flowvault change: reidentify_file only supports the file formats that carry VAULT_TOKEN, so the single FileDataFormat enum is split into separate types. - enums: rename FileDataFormat -> DeidentifyFileDataFormat, add ReidentifyFileDataFormat (csv, docx, json, jsonl, pptx, txt, xlsx, xml) - models: FileOutput uses DeidentifyFileDataFormat; add ReidentifyFileOutput; ReidentifyFileResponse.output is now a list of ReidentifyFileOutput - mappers: separate deidentify/reidentify format resolvers; an unknown reidentify format maps to None - re-exports, samples, READMEs and tests updated across flowvault and skyvault - regenerate the public API contract baselines Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Public API contract change (
|
Public API contract change (
|
saileshwar-skyflow
merged commit Nov 11, 2026
baebace
into
flowvault-release/26.10.0
9 checks passed
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.
What
Addresses the final Detect feedback (docs + samples parity) for the Python SDKs — the items under Python (FlowVault) and Python (SkyVault), plus the shared nomenclature points. Docs/samples only; no SDK source changes.
flowvault README
SKYFLOW_IDfile source and state plainly that flowvault'sDeidentifySourceTypeisBASE64/PRESIGNED_URLonly (previously a copy-pasteAttributeError).include_prefix/prefix_overrideonEntityandCustomType(incl. theinclude_prefix=NO"not re-identifiable" trap), anddeidentification_type/destinationonCustomType.output_type(was an unconditional base64 decode + hardcoded.txt).skyvault README
table.column) andoutput_typebranch.deidentify_fileno longer waits by default.will reach→reached).Samples (both SDKs)
request_idin every Detect error handler.Nomenclature
docs/migrate_detect.md, retitle it ("Migrate to the new Detect methods (skyflow 3.0.0)"), cite skyflow 3.0.0 in the intro + timeline, and promote thedeidentify_filebehaviour change to a top-of-doc warning.Notes / decisions
setup.pyversion is managed by release automation and is left unchanged; the guide now names 3.0.0 as the target — please confirm that's the release version.Verification
py_compile).Detect V2/V2 APIstrings in the touched docs; noSKYFLOW_IDleft in the flowvault README.🤖 Generated with Claude Code