Skip to content

Commit f7db3d4

Browse files
algolia-botcdhawke
andcommitted
fix(specs): abtests metadata mean (generated)
algolia/api-clients-automation#5121 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Christopher Hawke <[email protected]>
1 parent 854ef1b commit f7db3d4

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

packages/abtesting/model/metricMetadata.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@
55
*/
66
export type MetricMetadata = {
77
/**
8-
* Only present in case the metric is \'revenue\'. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).
8+
* Only present in case the metric is \'revenue\'. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).
99
*/
1010
winsorizedValue?: number | undefined;
11+
12+
/**
13+
* Mean value for this metric.
14+
*/
15+
mean?: number | undefined;
1116
};

packages/abtesting/model/metricResult.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ export type MetricResult = {
1313
value: number;
1414

1515
/**
16-
* The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
16+
* The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
1717
*/
1818
valueCIHigh?: number | undefined;
1919

2020
/**
21-
* The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
21+
* The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
2222
*/
2323
valueCILow?: number | undefined;
2424

@@ -35,7 +35,7 @@ export type MetricResult = {
3535
metadata?: MetricMetadata | undefined;
3636

3737
/**
38-
* The value that was computed during error correction. It is used to determine significance of the metric pValue. The critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given configuration during the A/B test creation.
38+
* The value that was computed during error correction. It is used to determine significance of the metric pValue. The critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given configuration during the A/B test creation.
3939
*/
4040
criticalValue?: number | undefined;
4141

0 commit comments

Comments
 (0)