Sep 20, 2024
Query Suggestions API client
This client is new in v5 of the JavaScript API clients.
The Query Suggestions API client is part of the @algolia/client-query-suggestions
package.
To install it, run:
Copy
1
npm install @algolia/client-query-suggestions
To use this client, run:
Copy
1
2
3
4
5
6
7
import { querySuggestionsClient } from "@algolia/client-query-suggestions";
const client = querySuggestionsClient(
"ALGOLIA_APPLICATION_ID",
"ALGOLIA_API_KEY",
"ALGOLIA_APPLICATION_ID_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 |
Did you find this page helpful?