Algolia Search API Client for Ruby
Algolia Search is a hosted full-text, numerical, and faceted search engine capable of delivering realtime results from the first keystroke.
The Algolia Search API Client for Ruby lets you easily use the Algolia Search REST API from your Ruby code.
If you are a Ruby on Rails user, you are probably looking for the algoliasearch-rails gem.
API Documentation
You can find the full reference on Algolia's website.
Getting Started
Install
Install AlgoliaSearch using:
gem install algoliasearch
Ruby on Rails
If you're a Ruby on Rails user; you're probably looking for the algoliasearch-rails gem.
Quick Start
In 30 seconds, this quick start tutorial will show you how to index and search objects.
Initialize the client
To begin, you will need to initialize the client. In order to do this you will need your Application ID and API Key. You can find both on your Algolia account.
require 'rubygems'
require 'algoliasearch'
Algolia.init(application_id: 'YourApplicationID',
api_key: 'YourAPIKey')
index = Algolia::Index.new('your_index_name')
Push data
Without any prior configuration, you can start indexing 500 contacts in the contacts
index using the following code:
index = Algolia::Index.new('contacts')
batch = JSON.parse(File.read('contacts.json'))
index.add_objects(batch)
Configure
Settings can be customized to fine tune the search behavior. For example, you can add a custom sort by number of followers to further enhance the built-in relevance:
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).
Note: The Algolia engine is designed to suggest results as you type, which means you'll generally search by prefix. In this case, the order of attributes is very important to decide which hit is the best:
index.set_settings searchableAttributes: %w(
lastname
firstname
company
email
city
address
)
Search
You can now search for contacts using firstname
, lastname
, company
, etc. (even with typos):
# search by firstname
puts index.search('jimmie').to_json
# search a firstname with typo
puts index.search('jimie').to_json
# search for a company
puts index.search('california paint').to_json
# search for a firstname & company
puts index.search('jimmie paint').to_json
Search UI
Warning: If you are building a web application, you may be more interested in using one of our frontend search UI libraries
The following example shows how to build a front-end search quickly using InstantSearch.js
index.html
<!doctype html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.js@2.3/dist/instantsearch.min.css">
<!-- Always use `2.x` versions in production rather than `2` to mitigate any side effects on your website,
Find the latest version on InstantSearch.js website: https://community.algolia.com/instantsearch.js/v2/guides/usage.html -->
</head>
<body>
<header>
<div>
<input id="search-input" placeholder="Search for products">
<!-- We use a specific placeholder in the input to guides users in their search. -->
</header>
<main>
</main>
<script type="text/html" id="hit-template">
<p class="hit-name">{{{_highlightResult.firstname.value}}} {{{_highlightResult.lastname.value}}}</p>
</script>
<script src="https://cdn.jsdelivr.net/npm/instantsearch.js@2.3/dist/instantsearch.min.js"></script>
<script src="app.js"></script>
</body>
app.js
var search = instantsearch({
// Replace with your own values
appId: 'YourApplicationID',
apiKey: 'YourSearchOnlyAPIKey', // search only API key, no ADMIN key
indexName: 'contacts',
routing: true,
searchParameters: {
hitsPerPage: 10
}
});
search.addWidget(
instantsearch.widgets.searchBox({
container: '#search-input'
})
);
search.addWidget(
instantsearch.widgets.hits({
container: '#hits',
templates: {
item: document.getElementById('hit-template').innerHTML,
empty: "We didn't find any results for the search <em>\"{{query}}\"</em>"
}
})
);
search.start();
List of available methods
Search
Indexing
Settings
Manage indices
API Keys
- Create secured API Key
- Add API Key
- Update API Key
- Delete API Key
- Get API Key permissions
- List API Keys
Synonyms
- Save synonym
- Batch synonyms
- Delete synonym
- Clear all synonyms
- Get synonym
- Search synonyms
- Export Synonyms
Query rules
A/B Test
MultiClusters
- Assign or Move userID
- Get top userID
- Get userID
- List clusters
- List userIDs
- Remove userID
- Search userID
Advanced
Getting Help
- Need help? Ask a question to the Algolia Community or on Stack Overflow.
- Found a bug? You can open a GitHub issue.