You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
SK-2707: add inline example responses to each README operation
Each vault, token, connection, and Detect operation now shows an
"Example response" block with the printed response object, so the response
shape is visible at the point of use instead of only via the API reference
link. Shapes verified against the response parsers and existing tests.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
> With `continue_on_error=True`, each entry also carries a `request_index`, and `errors` is a list of `{request_index, request_id, error, http_code}` for the rows that failed.
239
+
226
240
#### Insert example with `continue_on_error` option
227
241
228
242
Set the `continue_on_error` flag to `True` to allow insert operations to proceed despite encountering partial errors.
Returns an `UpdateResponse` (`updated_field`, `errors`). With the default `return_tokens=False`, only the `skyflow_id` is returned; with `return_tokens=True`, tokens for the updated columns are included:
Returns a `DeidentifyTextResponse` (`processed_text`, `entities`, `word_count`, `char_count`, `errors`). `entities` is a list of [`EntityInfo`](docs/api_reference.md#entityinfo) describing each detected entity:
586
+
587
+
```text
588
+
De-identify Text Response: DeidentifyTextResponse(processed_text='My SSN is [SSN_1].', entities=[...], word_count=4, char_count=18, errors=None)
589
+
```
590
+
525
591
> [!TIP]
526
592
> See the full example in the samples directory: [deidentify_text.py](samples/detect_api/deidentify_text.py)
Returns a `ReidentifyTextResponse` (`processed_text`, `errors`):
614
+
615
+
```text
616
+
Re-identify Text Response: ReidentifyTextResponse(processed_text='John lives in NYC', errors=None)
617
+
```
618
+
547
619
> [!TIP]
548
620
> See the full example in the samples directory: [reidentify_text.py](samples/detect_api/reidentify_text.py)
549
621
@@ -569,6 +641,12 @@ with open('path/to/file.pdf', 'rb') as file_obj:
569
641
print('De-identify File Response:', response)
570
642
```
571
643
644
+
Returns a `DeidentifyFileResponse` with the processed file plus metadata (`file`, `type`, `extension`, `word_count`, `char_count`, `size_in_kb`, `entities`, `run_id`, `status`, `errors`, and more — see the [API Reference](docs/api_reference.md#response-objects)). If processing exceeds `wait_time`, only `run_id` and `status` are returned (poll with `get_detect_run`):
0 commit comments