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

Upsert a composition

Upsert a composition in the current Algolia application.

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
import algoliasearch.api.CompositionClient
import algoliasearch.config.*

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

val response = Await.result(
  client.putComposition(
    compositionID = "my-metadata-compo",
    composition = Composition(
      objectID = "my-metadata-compo",
      name = "my composition",
      behavior = CompositionBehavior(
        injection = Injection(
          main = Main(
            source = CompositionSource(
              search = CompositionSourceSearch(
                index = "foo",
                params = Some(
                  MainInjectionQueryParameters(
                    filters = Some("brand:adidas")
                  )
                )
              )
            )
          ),
          injectedItems = Some(
            Seq(
              InjectedItem(
                key = "injectedItem1",
                source = SearchSource(
                  search = Search(
                    index = "foo",
                    params = Some(
                      BaseInjectionQueryParameters(
                        filters = Some("brand:adidas")
                      )
                    )
                  )
                ),
                position = 2,
                length = 1,
                metadata = Some(
                  InjectedItemMetadata(
                    hits = Some(
                      InjectedItemHitsMetadata(
                        addItemKey = Some(true),
                        extra = Some(
                          Map(
                            "my-string" -> "string",
                            "my-bool" -> true,
                            "my-number" -> 42,
                            "my-object" -> JObject(
                              List(
                                JField("sub-key", JString("sub-value"))
                              )
                            )
                          )
                        )
                      )
                    )
                  )
                )
              ),
              InjectedItem(
                key = "externalItem",
                source = SearchSource(
                  search = Search(
                    index = "foo",
                    params = Some(
                      BaseInjectionQueryParameters(
                        filters = Some("brand:puma")
                      )
                    )
                  )
                ),
                position = 5,
                length = 5,
                metadata = Some(
                  InjectedItemMetadata(
                    hits = Some(
                      InjectedItemHitsMetadata(
                        addItemKey = Some(true),
                        extra = Some(
                          Map(
                            "my-string" -> "string",
                            "my-bool" -> true,
                            "my-number" -> 42,
                            "my-object" -> JObject(
                              List(
                                JField("sub-key", JString("sub-value"))
                              )
                            )
                          )
                        )
                      )
                    )
                  )
                )
              )
            )
          )
        )
      )
    )
  ),
  Duration(100, "sec")
)