Skip to content

Commit 45ced06

Browse files
docs(abtests): Added documentation for featureFilters configuration i… (generated)
algolia/api-clients-automation#5688 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Samy Kettani <[email protected]>
1 parent 8d1899c commit 45ced06

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

src/main/scala/algoliasearch/abtesting/ABTestConfiguration.scala

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ package algoliasearch.abtesting
2727
/** A/B test configuration.
2828
*/
2929
case class ABTestConfiguration(
30+
featureFilters: Option[FeatureFilters] = scala.None,
3031
outliers: Option[Outliers] = scala.None,
3132
emptySearch: Option[EmptySearch] = scala.None,
3233
minimumDetectableEffect: Option[MinimumDetectableEffect] = scala.None

src/main/scala/algoliasearch/abtesting/EstimateConfiguration.scala

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ package algoliasearch.abtesting
2727
/** A/B test configuration for estimating the sample size and duration using minimum detectable effect.
2828
*/
2929
case class EstimateConfiguration(
30+
featureFilters: Option[FeatureFilters] = scala.None,
3031
outliers: Option[Outliers] = scala.None,
3132
emptySearch: Option[EmptySearch] = scala.None,
3233
minimumDetectableEffect: MinimumDetectableEffect
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/** A/B Testing API ## Base URLs The base URLs for requests to the A/B testing API are: -
2+
* `https://analytics.us.algolia.com` - `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (alias of
3+
* `analytics.us.algolia.com`) Use the URL that matches your [analytics
4+
* region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ##
5+
* Availability and authentication Access to the A/B testing API is available as part of the [Premium or Elevate
6+
* plans](https://www.algolia.com/pricing). To authenticate your API requests, add these headers: -
7+
* `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary
8+
* permissions to make the request. The required access control list (ACL) to make a request is listed in each
9+
* endpoint's reference. You can find your application ID and API key in the [Algolia
10+
* dashboard](https://dashboard.algolia.com/account/api-keys). ## Rate limits You can make up to **100 requests per
11+
* minute per app** to the A/B testing API. The response includes headers with information about the limits. ##
12+
* Parameters Query parameters must be
13+
* [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be
14+
* UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The A/B testing API
15+
* returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in
16+
* the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are
17+
* indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current
18+
* version of the A/B Testing API is version 2, as indicated by the `/2/` in each endpoint's URL.
19+
*
20+
* The version of the OpenAPI document: 2.0.0
21+
*
22+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
23+
* https://openapi-generator.tech Do not edit the class manually.
24+
*/
25+
package algoliasearch.abtesting
26+
27+
/** Configuration of feature-based filters applied to the A/B test population.
28+
*
29+
* @param dynamicReRanking
30+
* Whether to apply Dynamic Re-Ranking feature filters.
31+
* @param aiPerso
32+
* Whether to apply AI Personalization feature filters.
33+
* @param multiSignalRanking
34+
* Whether to apply Multi-Signal Re-Ranking feature filters.
35+
*/
36+
case class FeatureFilters(
37+
dynamicReRanking: Option[Boolean] = scala.None,
38+
aiPerso: Option[Boolean] = scala.None,
39+
multiSignalRanking: Option[Boolean] = scala.None
40+
)

0 commit comments

Comments
 (0)