aip_sdk.aload_dataset

async aip_sdk.aload_dataset(reference: str | None = None, *, id: str | None = None, client: APIClient | None = None, workspace_id: str | None = None, all_workspaces: bool = False) -> Dataset

Async variant of load_dataset().

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

• reference str | None: Dataset name. The "name@vN" syntax is not supported (version pinning not yet implemented). UUID lookup requires id=.
• id str | None: Dataset UUID for direct ID lookup (keyword-only).
• client APIClient | None: Optional API client.
• workspace_id str | None: Search only this workspace.
• all_workspaces bool: Search every workspace you can access.

Returns

• Dataset: Dataset object.

Raises

• DatasetNotFoundError: If the dataset does not exist.
• NotImplementedError: If a version reference ("name@vN") is passed.
• InvalidArgumentError: If neither reference nor id is provided.
• ForbiddenError: If workspace_id names a workspace you cannot access.
• NoWorkspaceSelectedError: No workspace was passed, none is configured for the session, and all_workspaces was not set.

Examples:

ds = await aip.aload_dataset("compliance-test-set")
ds = await aip.aload_dataset(id="uuid-...")