aip_sdk.iter_metric_configs

aip_sdk.iter_metric_configs(*, workspace_id: str | None = None, config_name: str | None = None, metric_name: str | None = None, per_page: int = 100, client: APIClient | None = None, include_global: bool | None = None, all_workspaces: bool = False) -> Iterator[MetricConfigSummary]

Iterate every metric config visible to the caller, auto-paginating.

Reads your session's workspace unless you name one, and raises if none is set. Pass all_workspaces=True to read across every workspace you can access.

Parameters

• workspace_id str | None: Only configs owned by this workspace. Omitting it iterates your session's workspace, and raises if none is set.
• config_name str | None: Filter by configuration name.
• metric_name str | None: Filter by the metric implementation configured.
• per_page int: Page size used internally for each request (1-100).
• client APIClient | None: Optional pre-configured API client.
• include_global bool | None: Deprecated and ignored — there is no more platform-wide scope to include, every config is workspace-owned. Passing any value (including False) emits a DeprecationWarning. Will be removed in a future release.
• all_workspaces bool: Read across every workspace you can access.

Yields

• MetricConfigSummary MetricConfigSummary: each matching config, across as many pages as needed. Not a
• MetricConfigSummary: point-in-time snapshot — a config created or deleted mid-iteration can shift rows
• MetricConfigSummary: across page boundaries.

Raises

• InvalidArgumentError: If per_page is out of range.
• AuthError: If credentials are missing or invalid.
• ForbiddenError: If workspace_id names a workspace the caller cannot access.
• APIError: If a listing request returns a malformed response.
• InvalidArgumentError: If both workspace_id and all_workspaces are given.
• NoWorkspaceSelectedError: No workspace was passed, none is configured for the session, and all_workspaces was not set. Raised at this call, before any request.

Example:

names = [c.config_name for c in aip.iter_metric_configs(metric_name="agent.custom_judge_rubric")]