bytekit-sdk 0.9.4__tar.gz → 0.9.6__tar.gz

{bytekit_sdk-0.9.4 → bytekit_sdk-0.9.6}/CHANGELOG.md

@@ -5,6 +5,25 @@ PyPI distribution: `bytekit-sdk`. Import name: `bytekit`.
 
 ## Unreleased
 
+## 0.9.6
+
+### Changed
+
+- **The `ScrapeSuccessEnvelope.warnings` docstring now names the `json` extraction codes** (#5469).
+  A request carrying a `json` format can get `extract_validation_failed`, `exhausted_retries`,
+  `content_truncated`, `model_refusal` and `empty_extraction` in `warnings`, without
+  `markdown_include_warnings`, whether or not the extraction validated. Regenerated docstrings only;
+  no signature moves.
+
+## 0.9.5
+
+### Changed
+
+- **`artifact_warnings` on a `/v1/bulk/{id}/screenshots` scrape item now documents the extraction
+  warnings** (#5458). The field also carries the `json` extraction's own warning codes
+  (whether or not the output validated), after any `artifact_unavailable` entry; its description said it reported
+  artifact reference failures only. Regenerated docstrings only; no signature moves.
+
 ## 0.9.4
 
 _Unreleased; 0.9.3 is the latest on PyPI._

{bytekit_sdk-0.9.4 → bytekit_sdk-0.9.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: bytekit-sdk
-Version: 0.9.4
+Version: 0.9.6
 Summary: Official Python SDK for the ByteKit API
 Project-URL: Homepage, https://bytekit.com
 Project-URL: Repository, https://github.com/Hunt-Labs-Inc/ByteKit

{bytekit_sdk-0.9.4 → bytekit_sdk-0.9.6}/pyproject.toml

@@ -7,7 +7,7 @@
 # `pip install bytekit-sdk` yields a working `import bytekit`. Mirrors the npm sibling
 # @hunt-labs/bytekit-sdk.
 name = "bytekit-sdk"
-version = "0.9.4"
+version = "0.9.6"
 description = "Official Python SDK for the ByteKit API"
 readme = "README.md"
 requires-python = ">=3.10"

{bytekit_sdk-0.9.4 → bytekit_sdk-0.9.6}/src/bytekit/models/list_bulk_screenshots_response_200_items_item_type_0.py

@@ -83,10 +83,12 @@ class ListBulkScreenshotsResponse200ItemsItemType0:
                 signing fails.
             artifacts (Union[Unset, ListBulkScreenshotsResponse200ItemsItemType0Artifacts]): `type: scrape` only. Exact
                 requested artifact values or signed references. `raw`, `markdown`, `links` and `images` are always present;
-                unrequested or unavailable values are null, with nonfatal reference failures in `artifact_warnings`. `json` is
-                present only on an item that requested a `json` format.
-            artifact_warnings (Union[Unset, list['ScrapeWarning']]): Nonfatal artifact reference failures for this scrape
-                item.
+                unrequested or unavailable values are null, with nonfatal warnings in `artifact_warnings`. `json` is present
+                only on an item that requested a `json` format.
+            artifact_warnings (Union[Unset, list['ScrapeWarning']]): Nonfatal warnings for this scrape item. An
+                `artifact_unavailable` entry reports a requested artifact whose reference failed, and comes first. For a `json`
+                format, the extraction's own warning codes follow, with `element: null`, whether or not the output validated
+                (`content_truncated` can accompany a validated result); `artifacts.json` is still returned as stored.
     """
 
     type_: ListBulkScreenshotsResponse200ItemsItemType0Type

{bytekit_sdk-0.9.4 → bytekit_sdk-0.9.6}/src/bytekit/models/list_bulk_screenshots_response_200_items_item_type_0_artifacts.py

@@ -26,8 +26,8 @@ T = TypeVar("T", bound="ListBulkScreenshotsResponse200ItemsItemType0Artifacts")
 @_attrs_define
 class ListBulkScreenshotsResponse200ItemsItemType0Artifacts:
     """`type: scrape` only. Exact requested artifact values or signed references. `raw`, `markdown`, `links` and `images`
-    are always present; unrequested or unavailable values are null, with nonfatal reference failures in
-    `artifact_warnings`. `json` is present only on an item that requested a `json` format.
+    are always present; unrequested or unavailable values are null, with nonfatal warnings in `artifact_warnings`.
+    `json` is present only on an item that requested a `json` format.
 
         Attributes:
             raw (Union[None, str]):

{bytekit_sdk-0.9.4 → bytekit_sdk-0.9.6}/src/bytekit/models/scrape_success_envelope.py

@@ -72,9 +72,14 @@ class ScrapeSuccessEnvelope:
         tables (Union[Unset, list['ScrapeTable']]): Tables extracted from the page. Present only when
             markdown_include_media=true. Present only on the synchronous response and webhook delivery. Not included in `GET
             /v1/scrape/:id`, bulk results, or cached hits.
-        warnings (Union[Unset, list['ScrapeWarning']]): Warnings about markdown processing, tag filtering, or requested
-            persisted artifacts. Markdown-pipeline and tag-filter warnings require `markdown_include_warnings=true`;
-            `artifact_unavailable` may appear independently when a requested persisted format cannot be rehydrated.
+        warnings (Union[Unset, list['ScrapeWarning']]): Warnings about markdown processing, tag filtering, requested
+            persisted artifacts, or the `json` format's extraction. Markdown-pipeline and tag-filter warnings require
+            `markdown_include_warnings=true`; `artifact_unavailable` may appear independently when a requested persisted
+            format cannot be rehydrated. A request carrying a `json` format can also get the extraction's own warning codes
+            here (`extract_validation_failed`, `exhausted_retries`, `content_truncated`, `model_refusal`,
+            `empty_extraction`), whether or not `markdown_include_warnings` is set and whether or not the extraction
+            validated: `content_truncated` can accompany a validated result, so a warning here does not by itself mean the
+            extraction failed.
         stats (Union[Unset, ScrapeStats]):
         markdown_tokens (Union[Unset, ScrapeMarkdownTokens]):
         billing (Union[Unset, BillingNode]): The authoritative, self-explaining account of what this call was billed and