ExperimentMetric interface

Package:

@azure-rest/onlineexperimentation

Defines experiment metric metadata and computation details.

Properties

categories	Categories associated with the experiment metric. Used for organizing and filtering metrics.
definition	The metric definition specifying how the metric value is calculated from event data.
description	A detailed description of the experiment metric.
desiredDirection	The desired direction for changes in the metric value. Possible values: "Increase", "Decrease", "Neutral"
displayName	A user-friendly display name for the experiment metric shown in reports and dashboards.
lifecycle	Determines whether it is included in experiment analysis. Possible values: "Active", "Inactive"

Property Details

categories

Categories associated with the experiment metric. Used for organizing and filtering metrics.

categories: string[]

Property Value

string[]

definition

The metric definition specifying how the metric value is calculated from event data.

definition: ExperimentMetricDefinition

Property Value

ExperimentMetricDefinition

description

A detailed description of the experiment metric.

description: string

Property Value

string

desiredDirection

The desired direction for changes in the metric value.

Possible values: "Increase", "Decrease", "Neutral"

desiredDirection: string

Property Value

string

displayName

A user-friendly display name for the experiment metric shown in reports and dashboards.

displayName: string

Property Value

string

lifecycle

Determines whether it is included in experiment analysis.

Possible values: "Active", "Inactive"

lifecycle: string

Property Value

string