Query Suggestions API client

The Query Suggestions API client is part of the algoliasearch-scala package. You can add this package to your build.gradle.kts file:

1
2
3
implementation("com.algolia:algoliasearch-client-kotlin:3.17.0")
// You also need to add a KTOR engine as dependency, for example:
implementation("io.ktor:ktor-client-java:$ktor_version")

To use the Query Suggestions client, add this import to your files:

1
2
3
import com.algolia.client.api.QuerySuggestionsClient
import com.algolia.client.configuration.*
import com.algolia.client.transport.*

To create an instance of the client:

1
val client = QuerySuggestionsClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY", region = "ALGOLIA_APPLICATION_REGION")

Replace ALGOLIA_APPLICATION_ID_REGION with your Algolia application’s analytics region: us for the United States or eu for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

List of methods

Each method makes one request to the Query Suggestions API.

Configurations

Logs