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
require "algolia"

client = Algolia::CompositionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

response = client.save_rules(
  "rule-with-exernal-source",
  Algolia::Composition::CompositionRulesBatchParams.new(
    requests: [
      Algolia::Composition::RulesMultipleBatchRequest.new(
        action: "upsert",
        body: Algolia::Composition::CompositionRule.new(
          algolia_object_id: "rule-with-exernal-source",
          description: "my description",
          tags: ["tag1", "tag2"],
          enabled: true,
          validity: [Algolia::Composition::TimeRange.new(from: 1704063600, _until: 1704083600)],
          conditions: [
            Algolia::Composition::Condition.new(anchoring: "contains", pattern: "harry"),
            Algolia::Composition::Condition.new(anchoring: "contains", pattern: "potter")
          ],
          consequence: Algolia::Composition::CompositionRuleConsequence.new(
            behavior: Algolia::Composition::CompositionBehavior.new(
              injection: Algolia::Composition::Injection.new(
                main: Algolia::Composition::Main.new(
                  source: Algolia::Composition::CompositionSource.new(
                    search: Algolia::Composition::CompositionSourceSearch.new(
                      index: "my-index",
                      params: Algolia::Composition::MainInjectionQueryParameters.new(filters: "brand:adidas")
                    )
                  )
                ),
                injected_items: [
                  Algolia::Composition::InjectedItem.new(
                    key: "injectedItem",
                    source: Algolia::Composition::ExternalSource.new(
                      external: Algolia::Composition::External.new(
                        index: "my-index",
                        params: Algolia::Composition::BaseInjectionQueryParameters.new(filters: "brand:adidas"),
                        ordering: "userDefined"
                      )
                    ),
                    position: 0,
                    length: 3
                  )
                ]
              )
            )
          )
        )
      )
    ]
  )
)