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

Composition API client

The Composition API client is part of the algoliasearch-scala package. You can add this package to your build.sbt file:

Copy 
1
2
3
4

// For Scala 3:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_3" % "2.28.0"
// For Scala 2:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_2" % "2.28.0"

To use the Composition client, add these imports to your files:

Copy 
1
2

import algoliasearch.api.CompositionClient
import algoliasearch.config.*

To create an instance of the client:

Copy 
1

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

List of methods

Each method makes one request to the Composition API.

client.search Run a Composition
client.searchForFacetValues Search for facet values

Compositions

client.listCompositions List compositions
client.getComposition Retrieve a composition
client.putComposition Upsert a composition
client.deleteComposition Delete a composition
client.multipleBatch Batch action to multiple compositions

Composition Rules

client.getRule Retrieve a rule
client.putCompositionRule Upsert a composition rule
client.deleteCompositionRule Delete a Composition Rule
client.saveRules Create or update or delete composition rules
client.searchCompositionRules Search for composition rules

Advanced

client.getTask Check task status