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

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

@@ -1,7 +1,8 @@
 Metadata-Version: 2.3
 Name: syvain-metrics-api-client
-Version: 0.0.332
+Version: 0.0.341
 Summary: Typed Python client for the Syvain Metrics REST API
+Requires-Dist: jcs>=0.2.1
 Requires-Dist: niquests>=3.16.0
 Requires-Dist: pydantic>=2.13.3
 Requires-Dist: typing-extensions>=4.15.0
@@ -18,6 +19,14 @@ Use this typed Python client to find experiments and read stored metrics from
 [Syvain Metrics](https://metrics.syvain.com/). To send metrics from a training
 or evaluation job, use `syvain-metrics-collector` instead.
 
+`create_annotation()` accepts text up to 16,000 characters and metadata up to
+64 KiB, or 65,536 UTF-8 bytes, of compact JSON. Keys, nested values, and JSON
+punctuation count toward the metadata limit. Validation fails before any HTTP
+request. The SDK counts bytes using the API's JavaScript number formatting.
+The API also enforces the cap. Store larger data in an artifact and
+include its path or URL in the annotation. Existing larger annotations remain
+readable.
+
 ## Install
 
 ```bash
@@ -34,7 +43,6 @@ from syvain_metrics_api_client import SyvainMetricsApiClient
 
 with SyvainMetricsApiClient("local", timeout=60.0) as client:
 	experiments = client.list_experiments(
-		status="done",
 		slug="mamba-run-001",
 		limit=1,
 	).experiments

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

@@ -4,6 +4,14 @@ Use this typed Python client to find experiments and read stored metrics from
 [Syvain Metrics](https://metrics.syvain.com/). To send metrics from a training
 or evaluation job, use `syvain-metrics-collector` instead.
 
+`create_annotation()` accepts text up to 16,000 characters and metadata up to
+64 KiB, or 65,536 UTF-8 bytes, of compact JSON. Keys, nested values, and JSON
+punctuation count toward the metadata limit. Validation fails before any HTTP
+request. The SDK counts bytes using the API's JavaScript number formatting.
+The API also enforces the cap. Store larger data in an artifact and
+include its path or URL in the annotation. Existing larger annotations remain
+readable.
+
 ## Install
 
 ```bash
@@ -20,7 +28,6 @@ from syvain_metrics_api_client import SyvainMetricsApiClient
 
 with SyvainMetricsApiClient("local", timeout=60.0) as client:
 	experiments = client.list_experiments(
-		status="done",
 		slug="mamba-run-001",
 		limit=1,
 	).experiments

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

@@ -1,10 +1,11 @@
 [project]
 name = "syvain-metrics-api-client"
-version = "0.0.332"
+version = "0.0.341"
 description = "Typed Python client for the Syvain Metrics REST API"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
+    "jcs>=0.2.1",
     "niquests>=3.16.0",
     "pydantic>=2.13.3",
     "typing-extensions>=4.15.0",

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

@@ -1,10 +1,15 @@
 [project]
 name = "syvain-metrics-api-client"
-version = "0.0.332"
+version = "0.0.341"
 description = "Typed Python client for the Syvain Metrics REST API"
 readme = "README.md"
 requires-python = ">=3.10"
-dependencies = ["niquests>=3.16.0", "pydantic>=2.13.3", "typing-extensions>=4.15.0"]
+dependencies = [
+    "jcs>=0.2.1",
+    "niquests>=3.16.0",
+    "pydantic>=2.13.3",
+    "typing-extensions>=4.15.0",
+]
 
 [project.optional-dependencies]
 dev = ["pytest>=8.0.0", "ruff>=0.15.12", "ty>=0.0.34"]

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

@@ -795,38 +795,24 @@ class SyvainMetricsApiClient:
     def list_experiments(
         self,
         *,
-        status: str | None = None,
         slug: str | None = None,
         search: str | None = None,
-        from_ms: int | None = None,
-        to_ms: int | None = None,
         limit: int | None = None,
     ) -> ExperimentsResponse:
-        """Return experiments that match the supplied filters.
+        """Return a bounded page ordered by most recent directory update.
 
         Args:
-            status: Optional experiment status filter.
             slug: Optional exact slug filter.
-            search: Optional text search.
-            from_ms: Optional lower timestamp bound in Unix milliseconds.
-            to_ms: Optional upper timestamp bound in Unix milliseconds.
+            search: Optional case-insensitive substring in the slug.
             limit: Optional maximum number of returned experiments.
-
-        Raises:
-            ValueError: If a timestamp bound is not a safe non-negative integer.
         """
-        from_ms = _validate_timestamp_query_bound(from_ms, field="from_ms")
-        to_ms = _validate_timestamp_query_bound(to_ms, field="to_ms")
         return self._request_model(
             "GET",
             "/api/v1/experiments",
             ExperimentsResponse,
             query={
-                "status": status,
                 "slug": slug,
                 "search": search,
-                "from": from_ms,
-                "to": to_ms,
                 "limit": limit,
             },
             context="list_experiments",

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

@@ -4,6 +4,7 @@ import json
 import math
 from typing import Literal, cast
 
+import jcs
 from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
 from typing_extensions import Self, TypeAliasType
 
@@ -28,6 +29,7 @@ CAMEL_OUTPUT_MODEL_CONFIG = ConfigDict(extra="allow", populate_by_name=True)
 
 MAX_SAFE_INTEGER = 9_007_199_254_740_991
 MAX_METRIC_STEP = MAX_SAFE_INTEGER - 1
+MAX_ANNOTATION_METADATA_JSON_BYTES = 65_536
 METRIC_NAME_CONTRACT_DESCRIPTION = (
     "A nonempty printable ASCII metric name, at most 256 bytes raw and 512 bytes "
     "after canonical s-prefixed percent encoding."
@@ -588,7 +590,7 @@ class IngestCreateInput(BaseModel):
 
 
 class AnnotationCreateInput(BaseModel):
-    """Validated annotation text and JSON metadata."""
+    """Validated annotation text and at most 64 KiB of compact JSON metadata."""
 
     model_config = INPUT_MODEL_CONFIG
 
@@ -598,7 +600,17 @@ class AnnotationCreateInput(BaseModel):
     @field_validator("metadata")
     @classmethod
     def validate_metadata(cls, value: JsonObject) -> JsonObject:
-        return _validate_finite_metadata(value)
+        _validate_finite_metadata(value)
+        # JCS uses the API's JavaScript number formatting. Python json.dumps
+        # would count 1e-5 as five bytes, but JSON.stringify writes seven.
+        size = len(jcs.canonicalize(value))
+        if size > MAX_ANNOTATION_METADATA_JSON_BYTES:
+            raise ValueError(
+                f"Annotation metadata is {size} UTF-8 bytes; the limit is "
+                f"{MAX_ANNOTATION_METADATA_JSON_BYTES} bytes of compact JSON. "
+                "Store larger data in an artifact and include its path or URL."
+            )
+        return value
 
 
 class IngestionKeyCreateInput(BaseModel):