syvain-metrics-api-client 0.0.322__tar.gz → 0.0.332__tar.gz

{syvain_metrics_api_client-0.0.322 → syvain_metrics_api_client-0.0.332}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: syvain-metrics-api-client
-Version: 0.0.322
+Version: 0.0.332
 Summary: Typed Python client for the Syvain Metrics REST API
 Requires-Dist: niquests>=3.16.0
 Requires-Dist: pydantic>=2.13.3
@@ -79,7 +79,11 @@ every metric in an experiment. In a metadata filter, omit `value` to select
 every series that contains the key.
 
 Set `stream=True` to parse an NDJSON response incrementally. The method still
-returns a complete `list[MetricSeriesColumnBatch]`.
+returns a complete `list[MetricSeriesColumnBatch]`. It requests
+`application/vnd.syvain.metric-series+ndjson` and verifies the final completion
+record against the received batch and row counts. A stream that ends before
+completion raises `MetricsApiRequestError`; partial results are not returned.
+Deploy the API support for this media type before upgrading streaming clients.
 
 ## Authentication
 

{syvain_metrics_api_client-0.0.322 → syvain_metrics_api_client-0.0.332}/README.md

@@ -65,7 +65,11 @@ every metric in an experiment. In a metadata filter, omit `value` to select
 every series that contains the key.
 
 Set `stream=True` to parse an NDJSON response incrementally. The method still
-returns a complete `list[MetricSeriesColumnBatch]`.
+returns a complete `list[MetricSeriesColumnBatch]`. It requests
+`application/vnd.syvain.metric-series+ndjson` and verifies the final completion
+record against the received batch and row counts. A stream that ends before
+completion raises `MetricsApiRequestError`; partial results are not returned.
+Deploy the API support for this media type before upgrading streaming clients.
 
 ## Authentication
 

{syvain_metrics_api_client-0.0.322 → syvain_metrics_api_client-0.0.332}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "syvain-metrics-api-client"
-version = "0.0.322"
+version = "0.0.332"
 description = "Typed Python client for the Syvain Metrics REST API"
 readme = "README.md"
 requires-python = ">=3.10"

{syvain_metrics_api_client-0.0.322 → syvain_metrics_api_client-0.0.332}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "syvain-metrics-api-client"
-version = "0.0.322"
+version = "0.0.332"
 description = "Typed Python client for the Syvain Metrics REST API"
 readme = "README.md"
 requires-python = ">=3.10"

{syvain_metrics_api_client-0.0.322 → syvain_metrics_api_client-0.0.332}/src/syvain_metrics_api_client/client.py

@@ -46,6 +46,7 @@ from syvain_metrics_api_client.types import (
     MetricsCatalogQueryItem,
     TrackingExperimentStatus,
     MetricSeriesColumnBatch,
+    MetricSeriesStreamCompletion,
     SeriesQueryOrder,
     SeriesQueryRequest,
     SeriesQuerySelection,
@@ -954,7 +955,8 @@ class SyvainMetricsApiClient:
                 that experiment.
             order: Axis and direction used to order each returned batch.
             stream: Read an NDJSON response when true. This reduces response
-                buffering but still returns a complete list.
+                buffering but still returns a complete list. Requires the API
+                completion record and rejects truncated responses.
 
         Returns:
             Column batches grouped by exact series identity.
@@ -1006,14 +1008,40 @@ class SyvainMetricsApiClient:
                 use_idempotency_key=False,
                 exclude_none_payload=True,
                 stream_response=True,
-                accept="application/x-ndjson",
+                accept="application/vnd.syvain.metric-series+ndjson",
             )
             batches: list[MetricSeriesColumnBatch] = []
+            completion: MetricSeriesStreamCompletion | None = None
+            row_count = 0
+            frame_adapter = TypeAdapter(
+                MetricSeriesColumnBatch | MetricSeriesStreamCompletion
+            )
             try:
                 for line in response.iter_lines():
                     if not line:
                         continue
-                    batches.append(MetricSeriesColumnBatch.model_validate_json(line))
+                    if completion is not None:
+                        raise MetricsApiResponseError(
+                            "Metrics API returned data after stream completion."
+                        )
+                    frame = frame_adapter.validate_json(line)
+                    if isinstance(frame, MetricSeriesStreamCompletion):
+                        completion = frame
+                    else:
+                        batches.append(frame)
+                        row_count += len(frame.data.value)
+                if completion is None:
+                    raise MetricsApiRequestError(
+                        "Metrics API stream ended without a completion record.",
+                        retryable=True,
+                    )
+                if (
+                    completion.batch_count != len(batches)
+                    or completion.row_count != row_count
+                ):
+                    raise MetricsApiResponseError(
+                        "Metrics API stream completion counts do not match received data."
+                    )
             except ValidationError as error:
                 raise MetricsApiResponseError(
                     "Metrics API response for query_metric_series did not match "

{syvain_metrics_api_client-0.0.322 → syvain_metrics_api_client-0.0.332}/src/syvain_metrics_api_client/types.py

@@ -418,6 +418,16 @@ class SeriesQueryRequest(BaseModel):
     stream: bool = False
 
 
+class MetricSeriesStreamCompletion(BaseModel):
+    """Required final record in the negotiated metric-series stream."""
+
+    model_config = ConfigDict(extra="forbid", strict=True)
+
+    kind: Literal["complete"]
+    batch_count: int = Field(alias="batchCount", ge=0)
+    row_count: int = Field(alias="rowCount", ge=0)
+
+
 class MetricSeriesDataColumns(BaseModel):
     """Parallel step, timestamp, and value columns for one metric series."""
 
@@ -427,7 +437,7 @@ class MetricSeriesDataColumns(BaseModel):
         allow_inf_nan=False,
     )
 
-    steps: list[float]
+    steps: list[float | None]
     timestamp: list[float]
     value: list[float]