ap-client 0.6.0.dev1__tar.gz → 0.7.0.dev0__tar.gz

{ap_client-0.6.0.dev1 → ap_client-0.7.0.dev0}/PKG-INFO

@@ -1,18 +1,18 @@
 Metadata-Version: 2.5
 Name: ap-client
-Version: 0.6.0.dev1
+Version: 0.7.0.dev0
 Summary: Agent Platform API Client & CLI
 Requires-Python: >=3.10
-Requires-Dist: irepo-artifact==0.2.1
+Requires-Dist: irepo-artifact==0.2.2
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: requests>=2.28.0
 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]<2.0.0,>=1.3.2; extra == 'all'
+Requires-Dist: instance-repo[oss]<2.0.0,>=1.3.5; extra == 'all'
 Provides-Extra: dataset
-Requires-Dist: instance-repo[oss]<2.0.0,>=1.3.2; extra == 'dataset'
+Requires-Dist: instance-repo[oss]<2.0.0,>=1.3.5; 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.6.0.dev1 → ap_client-0.7.0.dev0}/ap_client/api.py

@@ -1125,8 +1125,21 @@ class APIClient:
         benchmark: Optional[str] = None,
         experiment: Optional[str] = None,
         ak_ids: Optional[list[str]] = None,
+        priority: Optional[str] = None,
+        priority_weight: Optional[int] = None,
+        transparency: Optional[Literal["whitebox", "blackbox"]] = None,
+        idempotency_key: Optional[str] = None,
     ) -> dict:
-        """Create a group."""
+        """Create a group with optional scheduling defaults for its Jobs.
+
+        Omitted priority fields use the server defaults: medium and weight 0.
+        """
+        if priority is not None and priority not in {"high", "medium"}:
+            raise ValueError("priority must be one of high/medium")
+        if transparency is not None and transparency not in {"whitebox", "blackbox"}:
+            raise ValueError("transparency must be whitebox or blackbox")
+        if transparency == "blackbox" and not idempotency_key:
+            raise ValueError("blackbox Group creation requires a reusable idempotency_key (UUID4)")
         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 [])
@@ -1135,6 +1148,10 @@ class APIClient:
                 raise ValueError("ak_ids entries must be nonempty strings")
         references = list(dict.fromkeys(references))
         body: dict = {}
+        if transparency is not None:
+            body["transparency"] = transparency
+        if idempotency_key is not None:
+            body["idempotency_key"] = idempotency_key
         if references:
             body["ak_ids"] = references
         if name:
@@ -1164,6 +1181,10 @@ class APIClient:
             body["queue_id"] = effective_queue_id
         if max_concurrency is not None:
             body["max_concurrency"] = max_concurrency
+        if priority is not None:
+            body["priority"] = priority
+        if priority_weight is not None:
+            body["priority_weight"] = priority_weight
         if eval_config is not None:
             body["eval_config"] = eval_config
         if model_base_url_collection is not None:
@@ -1252,9 +1273,11 @@ class APIClient:
         ak_mode: str = "auto",
         instance_range: Optional[str] = None,
         profile: Optional[str] = None,
+        transparency: Optional[Literal["whitebox", "blackbox"]] = None,
     ) -> dict:
         """Create a job."""
         body = self.build_create_job_body(
+            transparency=transparency,
             template=template,
             params=params,
             params_list=params_list,
@@ -1366,8 +1389,11 @@ class APIClient:
         ak_mode: str = "auto",
         instance_range: Optional[str] = None,
         profile: Optional[str] = None,
+        transparency: Optional[Literal["whitebox", "blackbox"]] = None,
     ) -> dict:
         """Build the /jobs request body for job creation."""
+        if transparency is not None and transparency not in {"whitebox", "blackbox"}:
+            raise ValueError("transparency must be whitebox or blackbox")
         if profile is not None and (profile_id is not None or profile_version is not None):
             raise ValueError("profile cannot be combined with profile_id or profile_version")
         _validate_credential_source_selection(
@@ -1492,8 +1518,23 @@ class APIClient:
         if experiment is not None:
             body["experiment"] = experiment
 
+        if transparency is not None:
+            body["transparency"] = transparency
         return body
 
+    def get_job_access_contact(self, job_id: str) -> dict:
+        """Discover the owner and grant contact without reading protected details."""
+        result = self._get(f"/jobs/{quote(job_id, safe='')}", params={"access_contact": True})
+        if (
+            not isinstance(result, dict)
+            or result.get("resource_type") != "job"
+            or "authorization_contact" not in result
+        ):
+            raise ConfigurationError(
+                "Server does not support access contact queries; upgrade Agent-Platform first"
+            )
+        return result
+
     def get_job(
         self,
         job_id: str,
@@ -1619,6 +1660,19 @@ class APIClient:
 
     # ==================== Group operations ====================
 
+    def get_group_access_contact(self, group_id: str) -> dict:
+        """Discover the owner and grant contact without reading protected details."""
+        result = self._get(f"/groups/{quote(group_id, safe='')}", params={"access_contact": True})
+        if (
+            not isinstance(result, dict)
+            or result.get("resource_type") != "group"
+            or "authorization_contact" not in result
+        ):
+            raise ConfigurationError(
+                "Server does not support access contact queries; upgrade Agent-Platform first"
+            )
+        return result
+
     def get_group(self, group_id: str, timeout: TimeoutType = None) -> dict:
         """Get group details."""
         return self._get(f"/groups/{quote(group_id)}", timeout=timeout)
@@ -1881,9 +1935,15 @@ class APIClient:
         meta_job_type: Optional[str] = None,
         meta_teacher_direction: Optional[str] = None,
         meta_train_stage: Optional[str] = None,
+        benchmark: Optional[str] = None,
+        priority: Optional[str] = None,
+        priority_weight: Optional[int] = None,
+        priority_update_mode: Optional[str] = None,
     ) -> dict:
         """Update group properties.
 
+        ``benchmark`` is omitted when None; pass an empty string to clear it.
+
         ``tags``（`key:value` 数组）在客户端先与 Group 现有 tags 合并，再以
         全量替换语义提交（服务端 PATCH 是整体替换）；同名 key 覆盖，未提及
         的 key 保留。服务端会从 tags 同步 meta_* 等派生字段。
@@ -1891,7 +1951,19 @@ class APIClient:
         ``meta_*`` 独立属性为部分更新（传了才改，不支持清除）；新服务端
         优先读属性，老服务端忽略属性——因此过渡期内同时也会将属性合并进
         tags 轨（双写）。
+
+        Priority changes update the Group defaults. The default existing mode
+        also updates all current Jobs, including PostProcess; incremental mode
+        changes only the defaults for future Jobs. Updating priority alone uses
+        weight 0; updating only weight preserves the current priority tier.
         """
+        if priority is not None and priority not in {"high", "medium"}:
+            raise ValueError("priority must be one of high/medium")
+        if priority_update_mode is not None:
+            if priority_update_mode not in {"existing", "incremental"}:
+                raise ValueError("priority_update_mode must be one of existing/incremental")
+            if priority is None and priority_weight is None:
+                raise ValueError("priority_update_mode requires priority or priority_weight")
         body: dict = {}
 
         if max_concurrency is not None:
@@ -1906,6 +1978,14 @@ class APIClient:
             body["model"] = model
         if scaffold is not None:
             body["scaffold"] = scaffold
+        if benchmark is not None:
+            body["benchmark"] = benchmark
+        if priority is not None:
+            body["priority"] = priority
+        if priority_weight is not None:
+            body["priority_weight"] = priority_weight
+        if priority_update_mode is not None:
+            body["priority_update_mode"] = priority_update_mode
         meta_attr_tags = _merge_meta_tags(
             None,
             meta_model=meta_model,
@@ -3009,6 +3089,23 @@ class APIClient:
             return self._get(f"{self._PROFILES_BASE}/{quote(id_or_name)}/versions/{version}")
         return self._get(f"{self._PROFILES_BASE}/{quote(id_or_name)}")
 
+    def update_profile_job_meta(self, profile_id: str, patch: dict) -> dict:
+        """Patch live Job defaults without changing the Profile version.
+
+        Omitted fields stay unchanged. Set benchmark to None to clear it.
+        Tags use {"append": [...], "remove": [...]} and are applied atomically.
+        """
+        return self._request_central(
+            "PATCH", f"/profiles/{quote(profile_id, safe='')}/job-meta", json_body=patch
+        )
+
+    def replace_profile_job_meta(self, profile_id: str, job_meta: dict) -> dict:
+        """Replace all live Job defaults; {} clears benchmark and tags.
+
+        This does not change spec, Profile tags, version, verification or release.
+        """
+        return self._put_central(f"/profiles/{quote(profile_id, safe='')}/job-meta", job_meta)
+
     def update_profile(
         self,
         profile_id: str,
@@ -3017,8 +3114,13 @@ class APIClient:
         description: str = "",
         account_pool: Optional[str] = None,
         metadata: Optional[dict] = None,
+        reason: Optional[str] = None,
     ) -> dict:
-        """Update a submission profile, preserving an omitted default Pool."""
+        """Update a submission profile, preserving an omitted default Pool.
+
+        reason describes this update; omission never reuses a previous reason.
+        The server validates whether it is required and its 500-character limit.
+        """
         body: dict = {"name": name, "spec": spec}
         if description:
             body["description"] = description
@@ -3026,6 +3128,8 @@ class APIClient:
             body["account_pool"] = account_pool
         if metadata is not None:
             body["metadata"] = metadata
+        if reason is not None:
+            body["reason"] = reason
         return self._put(f"{self._PROFILES_BASE}/{quote(profile_id)}", body)
 
     def delete_profile(self, profile_id: str) -> dict:
@@ -3048,8 +3152,8 @@ class APIClient:
     ) -> dict:
         """把某个 job/group 实例的访问权授予某 user/user_group（scope=resource 绑定）。
 
-        workspace_id = 该实例所属 queue_id；apiserver 按该 WorkSpace 的 workspace-admin/
-        创建者/superuser 门控。鉴权走当前 API Key 解析出的调用者身份。
+        workspace_id = 该实例所属 queue_id；Job/Group Owner、Group Admin 或所属
+        WorkSpace 的管理员/创建者及平台管理员可授权。鉴权走当前 API Key 解析出的调用者身份。
         """
         body = {
             "scope": "resource",
@@ -3315,7 +3419,7 @@ def _response_error_detail(resp: requests.Response) -> Any:
     except Exception:
         return resp.text
     if isinstance(err_data, dict):
-        return err_data.get("detail", resp.text)
+        return err_data.get("detail", err_data.get("message", resp.text))
     return err_data