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 Go lets you easily use the Algolia Search REST API from your Go code.
Migration note from v1.x to v2.x
In June 2016, we released the v2 of our Go client. If you were using version 1.x of the client, read the migration guide to version 2.x. Version 1.x are no longer under active development. They are still supported for bug fixes, but will not receive new features.
You can find the full reference on Algolia's website.
This API client is compatible with Go 1.7 and above.
Download the Go client using:
go get github.com/algolia/algoliasearch-client-go/algoliasearchIn 30 seconds, this quick start tutorial will show you how to index and search objects.
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.
import "github.com/algolia/algoliasearch-client-go/algoliasearch"
client := algoliasearch.NewClient("YourApplicationID", "YourAPIKey")
index := client.InitIndex("your_index_name")Without any prior configuration, you can start indexing 500 contacts in the contacts index using the following code:
index := client.InitIndex("contacts")
content, _ := ioutil.ReadFile("contacts.json")
var objects []algoliasearch.Object
if err := json.Unmarshal(content, &objects); err != nil {
return
}
res, err := index.AddObjects(objects)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:
settings := algoliasearch.Map{
"customRanking": []string{"desc(followers)"},
}
res, err := index.SetSettings(settings)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:
settings := algoliasearch.Map{
"searchableAttributes": []string{
"firstname",
"lastname",
"company",
"email",
"city",
"address",
},
}
res, err := index.SetSettings(settings)You can now search for contacts using firstname, lastname, company, etc. (even with typos):
// Search for a first name
res, err := index.Search("jimmie", nil)
// Search for a first name with typo
res, err = index.Search("jimie", nil)
// Search for a company
res, err = index.Search("california paint", nil)
// Search for a first name and a company
res, err = index.Search("jimmie paint", nil)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
<!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>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();- Add objects
- Save objects
- Partial update objects
- Delete objects
- Replace all objects
- Delete by
- Clear objects
- Get objects
- Custom batch
- Create secured API Key
- Add API Key
- Update API Key
- Delete API Key
- Get API Key permissions
- List API Keys
- Save synonym
- Batch synonyms
- Delete synonym
- Clear all synonyms
- Get synonym
- Search synonyms
- Replace all synonyms
- Copy synonyms
- Export Synonyms
- Save rule
- Batch rules
- Get rule
- Delete rule
- Clear rules
- Search rules
- Replace all rules
- Copy rules
- Export rules
- Assign or Move userID
- Get top userID
- Get userID
- List clusters
- List userIDs
- Remove userID
- Search userID
- Need help? Ask a question to the Algolia Community or on Stack Overflow.
- Found a bug? You can open a GitHub issue.