Quickstart with the Ruby API client
On this page
Supported platforms
The Algolia Ruby API client requires Ruby version 2.2 or later.
Install
Install the Ruby API client using RubyGems:
1
gem install algolia -v '~>2.0'
If you’re using bundler, add algolia
as a dependency:
1
bundle add algolia --version='~> 2.0'
Be sure to install algolia
and not algoliasearch
which is the old version of the API client.
For more information, see Update the Ruby API client.
Framework integrations
Algolia provides an integration for the Ruby on Rails framework with the algoliasearch-rails gem.
Quickstart sample app
To download and run a self-contained example, see the Ruby quickstart on GitHub.
Initialize the client
To start, you need to initialize the client. To do this, you need your Application ID and API Key. You can find both on your Algolia account.
1
2
3
4
require 'algolia'
client = Algolia::Search::Client.create('YourApplicationID', 'YourWriteAPIKey')
index = client.init_index('your_index_name')
The API key displayed here is your Admin API key. To maintain security, never use your Admin API key on your frontend, nor share it with anyone. In your frontend, only use the search-only API key or any other key that has search-only rights.
Push data
Without any prior configuration, you can start indexing 500 contacts in the contacts
index using the following code:
1
2
3
index = client.init_index('contacts')
batch = JSON.parse(File.read('contacts.json'))
index.save_objects(batch)
Configure
You can customize settings to fine-tune the search behavior. For example, you can add a custom ranking by number of followers to further enhance the built-in relevance:
1
index.set_settings(customRanking: ['desc(followers)'])
You can also configure the list of attributes you want to index by order of importance (most important first).
Algolia suggests results as you type, which means you’ll generally search by prefix. In this case, the order of attributes is crucial in deciding which hit is the best.
1
2
3
4
5
6
7
8
9
10
index.set_settings({
searchableAttributes: [
'lastname',
'firstname',
'company',
'email',
'city',
'address'
]}
)
Search
Once configured, you can search for contacts by attributes such as firstname
, lastname
, or company
(even with typos):
1
2
3
4
5
6
7
8
# Search for a first name
puts index.search('jimmie').to_json
# Search for a first name with typo
puts index.search('jimie').to_json
# Search for a company
puts index.search('california paint').to_json
# Search for a first name and a company
puts index.search('jimmie paint').to_json
Search UI
Use one of Algolia’s frontend libraries to build your search UI:
However, if you don’t want to use the libraries, you can build a custom UI:
- Design UI components with your preferred frontend system: a search box, results display, filters, and any other desired Algolia features
- Send search requests with the API client
- Parse the JSON response from the search request and display the results in your custom UI.