Skip to content

Commit

Permalink
feat(specs): update estimate response type [skip-bc] (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#4101

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Christopher Hawke <69921547+cdhawke@users.noreply.github.com>
  • Loading branch information
algolia-bot and cdhawke committed Nov 14, 2024
1 parent 7710f71 commit 71e7298
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions algoliasearch/abtesting/models/estimate_ab_test_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

from json import loads
from sys import version_info
from typing import Any, Dict, Optional
from typing import Any, Dict, List, Optional

from pydantic import BaseModel, ConfigDict

Expand All @@ -20,8 +20,7 @@

_ALIASES = {
"duration_days": "durationDays",
"control_sample_size": "controlSampleSize",
"experiment_sample_size": "experimentSampleSize",
"sample_sizes": "sampleSizes",
}


Expand All @@ -36,10 +35,8 @@ class EstimateABTestResponse(BaseModel):

duration_days: Optional[int] = None
""" Estimated number of days needed to reach the sample sizes required for detecting the configured effect. This value is based on historical traffic. """
control_sample_size: Optional[int] = None
""" Number of tracked searches needed to be able to detect the configured effect for the control variant. """
experiment_sample_size: Optional[int] = None
""" Number of tracked searches needed to be able to detect the configured effect for the experiment variant. """
sample_sizes: Optional[List[int]] = None
""" Sample size estimates for each variant. The first element is the control variant. Each element is the estimated number of searches required to achieve the desired statistical significance. """

model_config = ConfigDict(
use_enum_values=True,
Expand Down

0 comments on commit 71e7298

Please sign in to comment.