gen_ai_hub.evaluations.models.metric_config module

class gen_ai_hub.evaluations.models.metric_config.MetricRef(scenario: str = None, name: str = None, version: str = None, id: str = None)

Bases: object

Represents a reference to a specific metric definition.

A metric can be identified in multiple ways: - By its UUID from metric management service (id) - By name (name) - By a combination of scenario, name, and version (scenario, name, version)

__init__(scenario: str = None, name: str = None, version: str = None, id: str = None)

class gen_ai_hub.evaluations.models.metric_config.MetricConfig(reference: MetricRef, variable_mapping: dict = None)

Bases: object

Defines the metric config of the evaluation flow

Parameters:

• reference (MetricRef) – Provide the reference of metric to be evaluated, can be one of name,uuid(id), scenario/name/version

• variable_mapping (Optional[dict]) – Any variable maping associated with the metric

__init__(reference: MetricRef, variable_mapping: dict = None)