ap-client 0.3.0.dev0__tar.gz → 0.3.1.dev1__tar.gz

{ap_client-0.3.0.dev0 → ap_client-0.3.1.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: ap-client
-Version: 0.3.0.dev0
+Version: 0.3.1.dev1
 Summary: Agent Platform API Client & CLI
 Requires-Python: >=3.10
 Requires-Dist: pyyaml>=6.0
@@ -9,9 +9,9 @@ Requires-Dist: rich>=13.0.0
 Requires-Dist: typer>=0.9.0
 Requires-Dist: websockets>=13.0
 Provides-Extra: all
-Requires-Dist: instance-repo[oss]>=0.7.0; extra == 'all'
+Requires-Dist: instance-repo[oss]>=1.1.0; extra == 'all'
 Provides-Extra: dataset
-Requires-Dist: instance-repo[oss]>=0.7.0; extra == 'dataset'
+Requires-Dist: instance-repo[oss]>=1.1.0; extra == 'dataset'
 Description-Content-Type: text/markdown
 
 A lightweight Python SDK and command line interface for Agent Platform. It provides helpers for configuring API access and managing templates, datasets, jobs, and groups.

{ap_client-0.3.0.dev0 → ap_client-0.3.1.dev1}/ap_client/api.py

@@ -15,6 +15,7 @@ from urllib.parse import parse_qsl, quote, urlencode, urlsplit, urlunsplit
 import requests
 
 from .config import Config, ConfigurationError, get_config, has_cluster_header
+from .managed_ak import require_managed_ak_ack, validate_ak_id, validate_ak_selection
 
 _DEFAULT_CONNECT_TIMEOUT = 300
 _DEFAULT_READ_TIMEOUT = 86400
@@ -293,6 +294,43 @@ def _secret_ws_params(workspace_id: Optional[str]) -> Optional[dict]:
     return {"workspace_id": workspace_id} if workspace_id else None
 
 
+def _unwrap_data(payload: Any) -> Any:
+    """Unwrap the apiserver ``{code,message,data}`` envelope when present.
+
+    The dataset-domain detail/create/patch endpoints return a bare JSON body,
+    but the same handlers are occasionally wrapped by the generic success
+    envelope. Tolerate both so command code never has to branch: a mapping that
+    carries ``data`` alongside ``code``/``message`` is treated as an envelope,
+    anything else is returned verbatim.
+    """
+    if (
+        isinstance(payload, dict)
+        and "data" in payload
+        and ("code" in payload or "message" in payload)
+    ):
+        return payload["data"]
+    return payload
+
+
+def _split_paged(payload: Any) -> tuple[list[dict], dict]:
+    """Split a ``PagedSuccess`` envelope into ``(records, pagination)``.
+
+    ``PagedSuccess`` is ``{code,message,data:[...],pagination:{total,page,page_size}}``.
+    A bare list (or a null ``data``) yields an empty pagination dict so callers
+    can render results without probing the response shape.
+    """
+    if isinstance(payload, list):
+        return [item for item in payload if isinstance(item, dict)], {}
+    if not isinstance(payload, dict):
+        return [], {}
+    records = payload.get("data")
+    pagination = payload.get("pagination")
+    return (
+        [item for item in (records or []) if isinstance(item, dict)],
+        pagination if isinstance(pagination, dict) else {},
+    )
+
+
 class APIClient:
     """Agent Platform API client."""
 
@@ -459,7 +497,12 @@ class APIClient:
 
     def _post(self, path: str, data: Any, timeout: TimeoutType = None) -> Any:
         """Send a POST request."""
-        return self._request("POST", path, json_body=data, timeout=timeout)
+        from .managed_ak import parameter_ak_ids, require_parameter_ak_ack
+
+        references = parameter_ak_ids(data) if path == "/jobs" else set()
+        result = self._request("POST", path, json_body=data, timeout=timeout)
+        require_parameter_ak_ack(result, references)
+        return result
 
     def _delete(self, path: str, *, params: Optional[dict] = None) -> Any:
         """Send a DELETE request."""
@@ -708,8 +751,35 @@ class APIClient:
         return self._get(f"/templates/{quote(name)}", params=params)
 
     def list_benchmarks(self) -> list:
-        """List all active benchmarks from the local benchmark registry."""
-        return self._get("/benchmarks")
+        """List all benchmarks from the central registry, preserving legacy IDs."""
+        benchmarks = []
+        page = 1
+        page_size = 200
+        # 与 CLI dataset list 的自动翻页同口径:100 页上限,防分页异常导致死循环。
+        max_pages = 100
+        while page <= max_pages:
+            payload = self._get(
+                "/apis/v1/benchmarks", params={"page": page, "page_size": page_size}
+            )
+            records, pagination = _split_paged(payload)
+            for record in records:
+                item = dict(record)
+                if "source_id" in item:
+                    item.setdefault("id", item["source_id"])
+                benchmarks.append(item)
+            if not records or not pagination:
+                break
+            try:
+                total = int(pagination.get("total"))
+            except (TypeError, ValueError):
+                total = None
+            if total is not None:
+                if len(benchmarks) >= total:
+                    break
+            elif len(records) < page_size:
+                break
+            page += 1
+        return benchmarks
 
     def get_benchmark(self, name: str) -> dict:
         """Get a single benchmark by exact name."""
@@ -844,7 +914,16 @@ class APIClient:
             "instance_ids": all_instance_ids,
         }
 
-    # ==================== Meta operations ====================
+    # ==================== Dataset series (apiserver dataset domain) ====================
+    #
+    # 这一节对接 Go apiserver 的 dataset 领域(/apis/v1/datasets/...),与上面
+    # ossdata 目录的 /api/datasets 路由完全无关。
+    #
+    # **dataset 领域的控制面读写全部在 InstanceRepo SDK 上**(见
+    # docs/ap-cli-dataset-refactor-design.md §9.5):迁移期加进这里的 registry 方法、
+    # 以及最后三条"push 前检查 + publish-status"的旧读,都已随迁移删除。
+    # 本文件现在只服务旧 ossdata 路径(`dataset list --legacy`、弃用的
+    # `dataset versions/instances`、`job create --dataset`)。
 
     def list_meta_models(self) -> dict:
         """模型词表（apiserver 权威源 GET /apis/v1/meta-models，返回 {items:[...]}）。"""
@@ -911,9 +990,19 @@ class APIClient:
         checkpoint: Optional[dict] = None,
         benchmark: Optional[str] = None,
         experiment: Optional[str] = None,
+        ak_ids: Optional[list[str]] = None,
     ) -> dict:
         """Create a group."""
+        if ak_ids is not None and not isinstance(ak_ids, list):
+            raise ValueError("ak_ids must be a list")
+        references = list(ak_ids or [])
+        for reference in references:
+            if validate_ak_id(reference) is None:
+                raise ValueError("ak_ids entries must be nonempty strings")
+        references = list(dict.fromkeys(references))
         body: dict = {}
+        if references:
+            body["ak_ids"] = references
         if name:
             body["name"] = name
         effective_tags = _merge_meta_tags(
@@ -965,11 +1054,14 @@ class APIClient:
             body["benchmark"] = benchmark
         if experiment is not None:
             body["experiment"] = experiment
-        return self._post("/groups", body)
+        result = self._post("/groups", body)
+        for reference in references:
+            require_managed_ak_ack(result, reference)
+        return result
 
     def create_job(
         self,
-        template: str,
+        template: Optional[str] = None,
         params: Optional[dict] = None,
         params_list: Optional[list] = None,
         suite_name: Optional[str] = None,
@@ -1022,6 +1114,7 @@ class APIClient:
         checkpoint: Optional[dict] = None,
         benchmark: Optional[str] = None,
         experiment: Optional[str] = None,
+        ak_id: Optional[str] = None,
     ) -> dict:
         """Create a job."""
         body = self.build_create_job_body(
@@ -1068,13 +1161,16 @@ class APIClient:
             checkpoint=checkpoint,
             benchmark=benchmark,
             experiment=experiment,
+            ak_id=ak_id,
         )
 
-        return self._post("/jobs", body, timeout=timeout)
+        result = self._post("/jobs", body, timeout=timeout)
+        require_managed_ak_ack(result, ak_id)
+        return result
 
     def build_create_job_body(
         self,
-        template: str,
+        template: Optional[str] = None,
         params: Optional[dict] = None,
         params_list: Optional[list] = None,
         suite_name: Optional[str] = None,
@@ -1126,6 +1222,7 @@ class APIClient:
         checkpoint: Optional[dict] = None,
         benchmark: Optional[str] = None,
         experiment: Optional[str] = None,
+        ak_id: Optional[str] = None,
     ) -> dict:
         """Build the /jobs request body for job creation."""
         _validate_credential_source_selection(
@@ -1134,7 +1231,14 @@ class APIClient:
             params=params,
             params_list=params_list,
         )
-        body: dict = {"template": template}
+        if not template and not profile_id:
+            raise ValueError("Either template or profile_id is required")
+        validate_ak_selection(ak_id, params, params_list, overrides)
+        body: dict = {}
+        if template is not None:
+            body["template"] = template
+        if ak_id is not None:
+            body["ak_id"] = ak_id
 
         if params is not None:
             body["params"] = params
@@ -1289,9 +1393,13 @@ class APIClient:
         next_token: Optional[str] = None,
         pagination: Optional[str] = None,
         include_total: bool = True,
+        ak_id: Optional[str] = None,
     ) -> dict:
         """List jobs."""
+        validate_ak_id(ak_id)
         params = {"skip": skip, "limit": limit}
+        if ak_id is not None:
+            params["ak_id"] = ak_id
         if template:
             params["template"] = template
         if group_id:
@@ -1485,9 +1593,13 @@ class APIClient:
         meta_job_type: Optional[str] = None,
         upstream_platform: Optional[str] = None,
         upstream_job_id: Optional[str] = None,
+        ak_id: Optional[str] = None,
     ) -> dict:
         """List groups."""
+        validate_ak_id(ak_id)
         params: dict = {"skip": skip, "limit": limit}
+        if ak_id is not None:
+            params["ak_id"] = ak_id
         if name is not None:
             params["name"] = name
         if group_id is not None: