bayesline.api.equity.RiskDatasetApi

class bayesline.api.equity.RiskDatasetApi

API for managing risk datasets.

This abstract base class defines the interface for risk dataset operations, including updating datasets and retrieving their properties.

__init__()

Methods

__init__()
describe()	Get the properties of this risk dataset.
update([force])	Check underlying datasets for updates and update this dataset to latest versions.
update_as_task()

Attributes

settings

Get the settings for this risk dataset.

abstract property settings: Annotated[DerivedRiskDatasetSettings | RootRiskDatasetSettings, Discriminator(discriminator=kind, custom_error_type=None, custom_error_message=None, custom_error_context=None)]

Get the settings for this risk dataset.

For reference-based datasets this returns DerivedRiskDatasetSettings. For root datasets (built from upload sources, no reference) this returns RootRiskDatasetSettings. Use isinstance to distinguish.

Returns

AnyRiskDatasetSettings

The settings for this risk dataset.

abstract describe() → RiskDatasetProperties

Get the properties of this risk dataset.

Returns

RiskDatasetProperties

The properties of this risk dataset.

abstract update(force: bool = False) → RiskDatasetUpdateResult

Check underlying datasets for updates and update this dataset to latest versions.

Parameters

forcebool, default=False

If true, the update will be forced even if the dataset is up to date.

Raises

DatasetError

If an error occurs.

Returns

RiskDatasetUpdateResult

The result of the update operation.

abstract update_as_task() → Task[RiskDatasetUpdateResult]