https://github.com/algolia/query-suggestions
A connector to create a query suggestions index
https://github.com/algolia/query-suggestions
Last synced: about 1 year ago
JSON representation
A connector to create a query suggestions index
- Host: GitHub
- URL: https://github.com/algolia/query-suggestions
- Owner: algolia
- Created: 2016-12-05T13:54:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-04-23T09:14:23.000Z (about 7 years ago)
- Last Synced: 2025-04-25T11:53:20.118Z (about 1 year ago)
- Language: Ruby
- Homepage: https://community.algolia.com/query-suggestions/
- Size: 1.58 MB
- Stars: 21
- Watchers: 73
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Deprecation notice
This repository will soon be removed and should not be used to build new projects.
You should probably go to https://www.algolia.com/doc/guides/getting-insights-and-analytics/leveraging-analytics-data/query-suggestions/#query-suggestions---what-is-it
Algolia has introduced a new version of its Analytics service (V2) which makes this repository obsolete.
In the new Analytics service, top searches are limited to 1k results.
As a result, the number of suggestions can not exceed that number unless you are using any of the other suggestion generation strategies.
Algolia will soon provide a newly hosted version of this service along the other Analytics services.
In the meantime, if you have any question regarding this feature, please feel free to reach out to support@algolia.com mentioning that you have read this notice.
# Query suggestions
Using Algolia indices and their analytics, generate a new query suggestion index.
# Quick Start
```bash
CONFIG='{
"app_id": "A1B2C3D4",
"api_key": "a1b2c3d4e5f6a1b2c3d4e5f6",
"indices": [{
"name": "products"
}, {
"name": "articles"
}]
}' \
bundle exec ./run
```
For a more complete description of all the configuration parameters, see [`connector/CONFIG.md`](./connector/CONFIG.md).