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]>

Author: algolia-bot

Sources/Abtesting/Models/AbtestingABTestConfiguration.swift

@@ -8,21 +8,25 @@ import Foundation
 
 /// A/B test configuration.
 public struct AbtestingABTestConfiguration: Codable, JSONEncodable {
+    public var featureFilters: FeatureFilters?
     public var outliers: Outliers?
     public var emptySearch: EmptySearch?
     public var minimumDetectableEffect: AbtestingMinimumDetectableEffect?
 
     public init(
+        featureFilters: FeatureFilters? = nil,
         outliers: Outliers? = nil,
         emptySearch: EmptySearch? = nil,
         minimumDetectableEffect: AbtestingMinimumDetectableEffect? = nil
     ) {
+        self.featureFilters = featureFilters
         self.outliers = outliers
         self.emptySearch = emptySearch
         self.minimumDetectableEffect = minimumDetectableEffect
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
+        case featureFilters
         case outliers
         case emptySearch
         case minimumDetectableEffect
@@ -32,6 +36,7 @@ public struct AbtestingABTestConfiguration: Codable, JSONEncodable {
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.featureFilters, forKey: .featureFilters)
         try container.encodeIfPresent(self.outliers, forKey: .outliers)
         try container.encodeIfPresent(self.emptySearch, forKey: .emptySearch)
         try container.encodeIfPresent(self.minimumDetectableEffect, forKey: .minimumDetectableEffect)
@@ -40,14 +45,16 @@ public struct AbtestingABTestConfiguration: Codable, JSONEncodable {
 
 extension AbtestingABTestConfiguration: Equatable {
     public static func ==(lhs: AbtestingABTestConfiguration, rhs: AbtestingABTestConfiguration) -> Bool {
-        lhs.outliers == rhs.outliers &&
+        lhs.featureFilters == rhs.featureFilters &&
+            lhs.outliers == rhs.outliers &&
             lhs.emptySearch == rhs.emptySearch &&
             lhs.minimumDetectableEffect == rhs.minimumDetectableEffect
     }
 }
 
 extension AbtestingABTestConfiguration: Hashable {
     public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.featureFilters?.hashValue)
         hasher.combine(self.outliers?.hashValue)
         hasher.combine(self.emptySearch?.hashValue)
         hasher.combine(self.minimumDetectableEffect?.hashValue)

Sources/Abtesting/Models/AbtestingEstimateConfiguration.swift

@@ -8,21 +8,25 @@ import Foundation
 
 /// A/B test configuration for estimating the sample size and duration using minimum detectable effect.
 public struct AbtestingEstimateConfiguration: Codable, JSONEncodable {
+    public var featureFilters: FeatureFilters?
     public var outliers: Outliers?
     public var emptySearch: EmptySearch?
     public var minimumDetectableEffect: AbtestingMinimumDetectableEffect
 
     public init(
+        featureFilters: FeatureFilters? = nil,
         outliers: Outliers? = nil,
         emptySearch: EmptySearch? = nil,
         minimumDetectableEffect: AbtestingMinimumDetectableEffect
     ) {
+        self.featureFilters = featureFilters
         self.outliers = outliers
         self.emptySearch = emptySearch
         self.minimumDetectableEffect = minimumDetectableEffect
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
+        case featureFilters
         case outliers
         case emptySearch
         case minimumDetectableEffect
@@ -32,6 +36,7 @@ public struct AbtestingEstimateConfiguration: Codable, JSONEncodable {
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.featureFilters, forKey: .featureFilters)
         try container.encodeIfPresent(self.outliers, forKey: .outliers)
         try container.encodeIfPresent(self.emptySearch, forKey: .emptySearch)
         try container.encode(self.minimumDetectableEffect, forKey: .minimumDetectableEffect)
@@ -40,14 +45,16 @@ public struct AbtestingEstimateConfiguration: Codable, JSONEncodable {
 
 extension AbtestingEstimateConfiguration: Equatable {
     public static func ==(lhs: AbtestingEstimateConfiguration, rhs: AbtestingEstimateConfiguration) -> Bool {
-        lhs.outliers == rhs.outliers &&
+        lhs.featureFilters == rhs.featureFilters &&
+            lhs.outliers == rhs.outliers &&
             lhs.emptySearch == rhs.emptySearch &&
             lhs.minimumDetectableEffect == rhs.minimumDetectableEffect
     }
 }
 
 extension AbtestingEstimateConfiguration: Hashable {
     public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.featureFilters?.hashValue)
         hasher.combine(self.outliers?.hashValue)
         hasher.combine(self.emptySearch?.hashValue)
         hasher.combine(self.minimumDetectableEffect.hashValue)

Sources/Abtesting/Models/FeatureFilters.swift

@@ -0,0 +1,54 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on
+// https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import Foundation
+#if canImport(Core)
+    import Core
+#endif
+
+/// Configuration of feature-based filters applied to the A/B test population.
+public struct FeatureFilters: Codable, JSONEncodable {
+    /// Whether to apply Dynamic Re-Ranking feature filters.
+    public var dynamicReRanking: Bool?
+    /// Whether to apply AI Personalization feature filters.
+    public var aiPerso: Bool?
+    /// Whether to apply Multi-Signal Re-Ranking feature filters.
+    public var multiSignalRanking: Bool?
+
+    public init(dynamicReRanking: Bool? = nil, aiPerso: Bool? = nil, multiSignalRanking: Bool? = nil) {
+        self.dynamicReRanking = dynamicReRanking
+        self.aiPerso = aiPerso
+        self.multiSignalRanking = multiSignalRanking
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case dynamicReRanking
+        case aiPerso
+        case multiSignalRanking
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.dynamicReRanking, forKey: .dynamicReRanking)
+        try container.encodeIfPresent(self.aiPerso, forKey: .aiPerso)
+        try container.encodeIfPresent(self.multiSignalRanking, forKey: .multiSignalRanking)
+    }
+}
+
+extension FeatureFilters: Equatable {
+    public static func ==(lhs: FeatureFilters, rhs: FeatureFilters) -> Bool {
+        lhs.dynamicReRanking == rhs.dynamicReRanking &&
+            lhs.aiPerso == rhs.aiPerso &&
+            lhs.multiSignalRanking == rhs.multiSignalRanking
+    }
+}
+
+extension FeatureFilters: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.dynamicReRanking?.hashValue)
+        hasher.combine(self.aiPerso?.hashValue)
+        hasher.combine(self.multiSignalRanking?.hashValue)
+    }
+}