create_metric_definition
Importante
Algumas ou todas estas funcionalidades estão disponíveis como parte de uma versão preliminar. O conteúdo e a funcionalidade estão sujeitos a alterações.
create_metric_definition(metric_properties: dict, skip_save_to_lakehouse: bool = False, skip_duplicate_check: bool = False)
Parâmetros:
- metric_properties (dict): Propriedades da métrica a ser criada. Observe que você deve fornecer as propriedades da mesma maneira especificada no arquivo metrics_definitions_config.json na pasta ESGMetrics/Config em ConfigAndDemoData lakehouse. Para obter mais informações, acesse Biblioteca de métricas ESG pré-criadas.
- skip_save_to_lakehouse (bool, opcional): Atualiza o DataFrame, mas não sálvia no lakehouse.
- skip_duplicate_check (bool, opcional): Ignorar conta-corrente para nomes de métricas duplicados.
Descrição:
Adiciona uma nova métrica ao DataFrame de definições de métricas.
Aumentos:
ValueError
: Se já existir uma métrica com o mesmo nome.
Exemplo de uso:
metrics_manager = MetricsManager()
metric_properties = {
"metric_name": "Gross Scope 1 greenhouse gas emissions",
"measure_name": "Emissions",
"dimensions": ["EmissionsAggregate[UnitOfMeasureName]", "EmissionsAggregate[ReportingPeriod]"],
"filters": {"EmissionsAggregate[isRolledUp]": ["False"], "EmissionsAggregate[Scope]": ["Scope 1"], "EmissionsAggregate[AccountingMethod]": ["Location based", None]},
"sustainability_area": "Climate Change",
"labels": {"Reporting standard": ["CSRD"], "Disclosure datapoint": ["E1-6_07", "E1-6_01"]}
}
metrics_manager.create_metric_definition(metric_properties)