Query Suggestions API client
This client is new in v4 of the Java API clients.
The Query Suggestions API client is part of the algoliasearch
package.
You can add this package to your pom.xml
file for Maven:
1
2
3
4
5
<dependency>
<groupId>com.algolia</groupId>
<artifactId>algoliasearch</artifactId>
<version>4.12.1</version>
</dependency>
or to your build.gradle
file for Gradle:
1
implementation 'com.algolia:algoliasearch:4.12.1'
To use the Query Suggestions client, add these imports to your files:
1
2
import com.algolia.api.QuerySuggestionsClient;
import com.algolia.config.*;
To create an instance of the client:
1
QuerySuggestionsClient client = new QuerySuggestionsClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "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
client.getAllConfigs | List configurations |
client.createConfig | Create a configuration |
client.getConfig | Retrieve a configuration |
client.updateConfig | Update a configuration |
client.deleteConfig | Delete a configuration |
client.getConfigStatus | Retrieve configuration status |
Logs
client.getLogFile | Retrieve logs |