Skip to content

Commit be5035f

Browse files
committed
chore: additional changes
1 parent 2746d95 commit be5035f

File tree

4 files changed

+60
-6
lines changed

4 files changed

+60
-6
lines changed

specs/abtesting/common/schemas/ABTest.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,12 @@ MinimumDetectableEffect:
155155
Smallest difference in an observable metric between variants.
156156
For example, to detect a 10% difference between variants, set this value to 0.1.
157157
metric:
158-
$ref: '#/Effect'
158+
$ref: '#/Metric'
159+
required:
160+
- size
161+
- metric
159162

160-
Effect:
163+
Metric:
161164
type: string
162165
description: Metric for which you want to detect the smallest relative difference.
163166
enum:
Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
11
EstimateResponse:
2-
$ref: '../parameters.yml#/minimumDetectableEffect'
2+
type: object
3+
properties:
4+
durationDays:
5+
type: number
6+
format: int64
7+
description: Estimated number of days needed to reach the sample sizes required for detecting the configured effect. This value is based on historical traffic.
8+
example: 21
9+
controlSampleSize:
10+
type: number
11+
format: int64
12+
description: Number of tracked searches needed to be able to detect the configured effect for the control variant.
13+
example: 23415
14+
experimentSampleSize:
15+
type: number
16+
format: int64
17+
description: Number of tracked searches needed to be able to detect the configured effect for the experiment variant.
18+
example: 23415
19+
required:
20+
- durationDays
21+
- controlSampleSize
22+
- experimentSampleSize

specs/abtesting/paths/estimate.yml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,23 @@ post:
1111
content:
1212
application/json:
1313
schema:
14-
title: estimateABTestRequest
14+
title: estimateRequest
1515
type: object
1616
additionalProperties: false
1717
properties:
1818
configuration:
19-
$ref: '../common/schemas/ABTest.yml#/ABTestConfiguration'
19+
title: configuration
20+
type: object
21+
description: A/B test configuration.
22+
properties:
23+
outliers:
24+
$ref: '../common/schemas/ABTest.yml#/Outliers'
25+
emptySearch:
26+
$ref: '../common/schemas/ABTest.yml#/EmptySearch'
27+
minimumDetectableEffect:
28+
$ref: '../common/schemas/ABTest.yml#/MinimumDetectableEffect'
29+
required:
30+
- minimumDetectableEffect
2031
variants:
2132
type: array
2233
description: A/B test variants.

tests/CTS/requests/abtesting/estimateABTest.json

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,27 @@
11
[
22
{
33
"testName": "estimate AB Test sample size",
4-
"parameters": {},
4+
"parameters": {
5+
"configuration": {
6+
"emptySearch": {
7+
"exclude": true
8+
},
9+
"minimumDetectableEffect": {
10+
"size": 0.03,
11+
"metric": "conversionrate"
12+
}
13+
},
14+
"variants": [
15+
{
16+
"index": "AB_TEST_1",
17+
"trafficPercentage": 50
18+
},
19+
{
20+
"index": "AB_TEST_2",
21+
"trafficPercentage": 50
22+
}
23+
]
24+
},
525
"request": {
626
"path": "/2/abtests/estimate",
727
"method": "POST",

0 commit comments

Comments
 (0)