Merge branch 'main' into clara/refact/composition-private-client

Author: ClaraMuller

clients/algoliasearch-client-javascript/packages/abtesting/model/metricMetadata.ts

@@ -5,7 +5,12 @@
  */
 export type MetricMetadata = {
   /**
-   * 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).
+   * 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).
    */
   winsorizedValue?: number | undefined;
+
+  /**
+   * Mean value for this metric.
+   */
+  mean?: number | undefined;
 };

clients/algoliasearch-client-javascript/packages/abtesting/model/metricResult.ts

@@ -13,12 +13,12 @@ export type MetricResult = {
   value: number;
 
   /**
-   * 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).
+   * 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).
    */
   valueCIHigh?: number | undefined;
 
   /**
-   * 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).
+   * 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).
    */
   valueCILow?: number | undefined;
 
@@ -35,7 +35,7 @@ export type MetricResult = {
   metadata?: MetricMetadata | undefined;
 
   /**
-   * 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.
+   * 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.
    */
   criticalValue?: number | undefined;
 

docs/bundled/abtesting-v3.json

@@ -992,11 +992,18 @@
           "winsorizedValue": {
             "type": "number",
             "format": "double",
-            "description": "Only present in case the metric is 'revenue'. \nIt 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.\nIt is tied to a per revenue-currency pair contrary to other \nglobal filter effects (such as outliers and empty search count).\n"
+            "description": "Only present in case the metric is 'revenue'.\nIt 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.\nIt is tied to a per revenue-currency pair contrary to other\nglobal filter effects (such as outliers and empty search count).\n"
+          },
+          "mean": {
+            "type": "number",
+            "format": "double",
+            "description": "Mean value for this metric.",
+            "example": 53.7
           }
         },
         "example": {
-          "winsorizedValue": 888.8
+          "winsorizedValue": 888.8,
+          "mean": 53.7
         }
       },
       "metricResult": {
@@ -1016,12 +1023,12 @@
           "valueCIHigh": {
             "type": "number",
             "format": "double",
-            "description": "The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using \neither the relative ratio or relative difference between the metric values for the control and the variant.\nRelative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), \nwhile relative difference is used for continuous metrics (e.g., revenue).\n"
+            "description": "The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using\neither the relative ratio or relative difference between the metric values for the control and the variant.\nRelative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate),\nwhile relative difference is used for continuous metrics (e.g., revenue).\n"
           },
           "valueCILow": {
             "type": "number",
             "format": "double",
-            "description": "The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using \neither the relative ratio or relative difference between the metric values for the control and the variant.\nRelative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), \nwhile relative difference is used for continuous metrics (e.g., revenue).\n"
+            "description": "The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using\neither the relative ratio or relative difference between the metric values for the control and the variant.\nRelative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate),\nwhile relative difference is used for continuous metrics (e.g., revenue).\n"
           },
           "pValue": {
             "type": "number",
@@ -1038,7 +1045,7 @@
           "criticalValue": {
             "type": "number",
             "format": "double",
-            "description": "The value that was computed during error correction. It is used to determine significance of the metric pValue.\nThe critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given \nconfiguration during the A/B test creation.\n"
+            "description": "The value that was computed during error correction. It is used to determine significance of the metric pValue.\nThe critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given\nconfiguration during the A/B test creation.\n"
           },
           "significant": {
             "type": "boolean",

docs/bundled/abtesting-v3.yml

@@ -1126,17 +1126,23 @@ components:
           type: number
           format: double
           description: >
-            Only present in case the metric is 'revenue'. 
+            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 
+            It is tied to a per revenue-currency pair contrary to other
 
             global filter effects (such as outliers and empty search count).
+        mean:
+          type: number
+          format: double
+          description: Mean value for this metric.
+          example: 53.7
       example:
         winsorizedValue: 888.8
+        mean: 53.7
     metricResult:
       type: object
       properties:
@@ -1153,13 +1159,13 @@ components:
           format: double
           description: >
             The upper bound of the 95% confidence interval for the metric value.
-            The confidence interval is calculated using 
+            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), 
+            click-through rate, conversion rate),
 
             while relative difference is used for continuous metrics (e.g.,
             revenue).
@@ -1168,13 +1174,13 @@ components:
           format: double
           description: >
             The lower bound of the 95% confidence interval for the metric value.
-            The confidence interval is calculated using 
+            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), 
+            click-through rate, conversion rate),
 
             while relative difference is used for continuous metrics (e.g.,
             revenue).
@@ -1198,7 +1204,7 @@ components:
             determine significance of the metric pValue.
 
             The critical value is calculated using Bonferroni or
-            Benjamini-Hochberg corrections, based on the given 
+            Benjamini-Hochberg corrections, based on the given
 
             configuration during the A/B test creation.
         significant:

specs/abtesting-v3/common/schemas/Variant.yml

@@ -57,17 +57,17 @@ metricResult:
       type: number
       format: double
       description: |
-        The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using 
+        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), 
+        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).
     valueCILow:
       type: number
       format: double
       description: |
-        The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using 
+        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), 
+        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).
     pValue:
       type: number
@@ -83,7 +83,7 @@ metricResult:
       format: double
       description: |
         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 
+        The critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given
         configuration during the A/B test creation.
     significant:
       type: boolean
@@ -131,9 +131,15 @@ metricMetadata:
       type: number
       format: double
       description: |
-        Only present in case the metric is 'revenue'. 
+        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 
+        It is tied to a per revenue-currency pair contrary to other
         global filter effects (such as outliers and empty search count).
+    mean:
+      type: number
+      format: double
+      description: Mean value for this metric.
+      example: 53.7
   example:
     winsorizedValue: 888.80
+    mean: 53.7

specs/bundled/abtesting-v3.yml

@@ -796,17 +796,23 @@ components:
           type: number
           format: double
           description: >
-            Only present in case the metric is 'revenue'. 
+            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 
+            It is tied to a per revenue-currency pair contrary to other
 
             global filter effects (such as outliers and empty search count).
+        mean:
+          type: number
+          format: double
+          description: Mean value for this metric.
+          example: 53.7
       example:
         winsorizedValue: 888.8
+        mean: 53.7
     metricResult:
       type: object
       properties:
@@ -823,13 +829,13 @@ components:
           format: double
           description: >
             The upper bound of the 95% confidence interval for the metric value.
-            The confidence interval is calculated using 
+            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), 
+            click-through rate, conversion rate),
 
             while relative difference is used for continuous metrics (e.g.,
             revenue).
@@ -838,13 +844,13 @@ components:
           format: double
           description: >
             The lower bound of the 95% confidence interval for the metric value.
-            The confidence interval is calculated using 
+            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), 
+            click-through rate, conversion rate),
 
             while relative difference is used for continuous metrics (e.g.,
             revenue).
@@ -868,7 +874,7 @@ components:
             determine significance of the metric pValue.
 
             The critical value is calculated using Bonferroni or
-            Benjamini-Hochberg corrections, based on the given 
+            Benjamini-Hochberg corrections, based on the given
 
             configuration during the A/B test creation.
         significant:

specs/crawler/paths/crawlerCrawl.yml

@@ -5,6 +5,8 @@ post:
     Crawls the specified URLs, extracts records from them, and adds them to the index.
     If a crawl is currently running (the crawler's `reindexing` property is `true`),
     the records are added to a temporary index.
+
+    This operation is rate-limited to 500 requests every 24 hours.
   tags:
     - actions
   parameters: