You're viewing an archived version of our docs. Check out our current documentation →

Create or update or delete composition rules

Create or update or delete multiple composition rules.

Usage

Required ACL: editSettings
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
import algoliasearch.api.CompositionClient
import algoliasearch.config.*

val client = CompositionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

val response = Await.result(
  client.saveRules(
    compositionID = "rule-with-exernal-source",
    rules = CompositionRulesBatchParams(
      requests = Some(
        Seq(
          RulesMultipleBatchRequest(
            action = Action.withName("upsert"),
            body = CompositionRule(
              objectID = "rule-with-exernal-source",
              description = Some("my description"),
              tags = Some(Seq("tag1", "tag2")),
              enabled = Some(true),
              validity = Some(
                Seq(
                  TimeRange(
                    from = Some(1704063600L),
                    until = Some(1704083600L)
                  )
                )
              ),
              conditions = Seq(
                Condition(
                  anchoring = Some(Anchoring.withName("contains")),
                  pattern = Some("harry")
                ),
                Condition(
                  anchoring = Some(Anchoring.withName("contains")),
                  pattern = Some("potter")
                )
              ),
              consequence = CompositionRuleConsequence(
                behavior = CompositionBehavior(
                  injection = Injection(
                    main = Main(
                      source = CompositionSource(
                        search = CompositionSourceSearch(
                          index = "my-index",
                          params = Some(
                            MainInjectionQueryParameters(
                              filters = Some("brand:adidas")
                            )
                          )
                        )
                      )
                    ),
                    injectedItems = Some(
                      Seq(
                        InjectedItem(
                          key = "injectedItem",
                          source = ExternalSource(
                            external = External(
                              index = "my-index",
                              params = Some(
                                BaseInjectionQueryParameters(
                                  filters = Some("brand:adidas")
                                )
                              ),
                              ordering = Some(ExternalOrdering.withName("userDefined"))
                            )
                          ),
                          position = 0,
                          length = 3
                        )
                      )
                    )
                  )
                )
              )
            )
          )
        )
      )
    )
  ),
  Duration(100, "sec")
)