Sep 20, 2024
Query Suggestions API client
This client is new in v3 of the Ruby API clients.
The Query Suggestions API client is part of the algolia
gem.
To install this gem, run:
Copy
1
gem install algolia
To use the Query Suggestions client, add this import to your files:
Copy
1
require "algolia"
To create an instance of the client:
Copy
1
2
3
4
5
client = Algolia::QuerySuggestionsClient.create(
"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.get_all_configs | List configurations |
client.create_config | Create a configuration |
client.get_config | Retrieve a configuration |
client.update_config | Update a configuration |
client.delete_config | Delete a configuration |
client.get_config_status | Retrieve configuration status |
Logs
client.get_log_file | Retrieve logs |
Did you find this page helpful?