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.
Attributes
Get the settings for this risk dataset.
- abstract property settings: RiskDatasetSettings#
Get the settings for this risk dataset.
Returns#
- RiskDatasetSettings
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]#