Quickstart with the Scala API Client
On this page
Supported platforms
The Algolia Scala API client requires Scala versions 2.11, 2.12, or 2.13.
Install
Install via Maven
With Maven, add the following dependency to your pom.xml file:
1
2
3
4
5
<dependency>
<groupId>com.algolia</groupId>
<artifactId>algoliasearch-scala_2.11</artifactId>
<version>[1,)</version>
</dependency>
For snapshots, add the sonatype repository:
1
2
3
4
5
6
7
8
9
10
<repositories>
<repository>
<id>oss-sonatype</id>
<name>oss-sonatype</name>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
Install with sbt
Add the following dependency to your build.sbt file:
1
libraryDependencies += "com.algolia" %% "algoliasearch-scala" % "[1,)"
For snapshots, add the sonatype repository:
1
resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"
DSL
The main goal of this client is to provide a human-accessible and readable DSL for using AlgoliaSearch.
The entry point of the DSL is the algolia.AlgoliaDSL object.
This DSL is used in the execute method of algolia.AlgoliaClient.
As we want to provide human-readable DSL, there’s more than one way to use this DSL. For example, to get an object by its objectID:
1
2
3
4
5
client.execute { from index "index" objectId "myId" }
// or
client.execute { get / "index" / "myId" }
Future
The execute method always returns a scala.concurrent.Future.
Depending on the operation, it’s parametrized by a case class. For example:
1
2
3
4
val future: Future[Search] =
client.execute {
search into "index" query "a"
}
JSON as case class
Putting or getting objects from the API is wrapped into case class automatically with json4s.
If you want to get objects, search for them and unwrap the result:
1
2
3
4
5
6
7
8
9
10
11
12
13
case class Contact(firstname: String,
lastname: String,
followers: Int,
company: String)
val future: Future[Seq[Contact]] =
client
.execute {
search into "index" query "a"
}
.map { search =>
search.as[Contact]
}
If you want to get the full results (with _highlightResult, etc.):
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
case class EnhanceContact(firstname: String,
lastname: String,
followers: Int,
company: String,
objectID: String,
_highlightResult: Option[Map[String, HighlightResult]
_snippetResult: Option[Map[String, SnippetResult]],
_rankingInfo: Option[RankingInfo]) extends Hit
val future: Future[Seq[EnhanceContact]] =
client
.execute {
search into "index" query "a"
}
.map { search =>
search.asHit[EnhanceContact]
}
For indexing documents, pass an instance of your case class to the DSL:
1
2
3
client.execute {
index into "contacts" `object` Contact("Jimmie", "Barninger", 93, "California Paint")
}
Quickstart
In the following sections, you can learn how to index and search objects in 30 seconds.
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
// The index doesn't need to be initialized
val client = new AlgoliaClient("YourApplicationID", "YourAdminAPIKey")
The API key displayed here is your Admin API key. To maintain security, never use your Admin API key on your front end, nor share it with anyone. In your front end, use the search-only API key or any other key that has search-only rights.
Push data
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// For the DSL
import algolia.AlgoliaDsl._
// For basic Future support, you might want to change this by your own ExecutionContext
import scala.concurrent.ExecutionContext.Implicits.global
// case class of your objects
case class Contact(firstname: String,
lastname: String,
followers: Int,
compagny: String)
val indexing1: Future[Indexing] = client.execute {
index into "contacts" `object` Contact("Jimmie", "Barninger", 93, "California Paint")
}
val indexing2: Future[Indexing] = client.execute {
index into "contacts" `object` Contact("Warren", "Speach", 42, "Norwalk Crmc")
}
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
2
3
4
5
client.execute {
changeSettings of "myIndex" `with` IndexSettings(
customRanking = Some(Seq(CustomRanking.desc("followers")))
)
}
You can also configure the list of attributes you want to index by order of importance (most important first).
Algolia is designed to suggest results as you type, which means you’ll generally search by prefix. In this case, the order of attributes is crucial to decide which hit is the best.
1
2
3
4
5
client.execute {
changeSettings of "myIndex" `with` IndexSettings(
searchableAttributes = Some(Seq("lastname", "firstname", "company"))
)
}
Search
You can now search for contacts by firstname, lastname, company, etc. (even with typos):
1
2
3
4
5
6
7
8
9
10
11
// Search for a first name
client.execute { search into "contacts" query Query(query = Some("jimmie")) }
// Search for a first name with typo
client.execute { search into "contacts" query Query(query = Some("jimie")) }
// Search for a company
client.execute { search into "contacts" query Query(query = Some("california paint")) }
// Search for a first name and a company
client.execute { search into "contacts" query Query(query = Some("jimmie paint")) }
Search UI
If you’re building a web application, you may be interested in using one of Algolias front-end search UI libraries.
The following example shows how to quickly build a front-end search using InstantSearch.js
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<!doctype html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.css@7.4.5/themes/satellite-min.css" integrity="sha256-TehzF/2QvNKhGQrrNpoOb2Ck4iGZ1J/DI4pkd2oUsBc=" crossorigin="anonymous">
</head>
<body>
<header>
<div id="search-box"></div>
</header>
<main>
<div id="hits"></div>
<div id="pagination"></div>
</main>
<script type="text/html" id="hit-template">
<div class="hit">
<p class="hit-name">
{{#helpers.highlight}}{ "attribute": "firstname" }{{/helpers.highlight}}
{{#helpers.highlight}}{ "attribute": "lastname" }{{/helpers.highlight}}
</p>
</div>
</script>
<script src="https://cdn.jsdelivr.net/npm/algoliasearch@4.5.1/dist/algoliasearch-lite.umd.js" integrity="sha256-EXPXz4W6pQgfYY3yTpnDa3OH8/EPn16ciVsPQ/ypsjk=" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/instantsearch.js@4.8.3/dist/instantsearch.production.min.js" integrity="sha256-LAGhRRdtVoD6RLo2qDQsU2mp+XVSciKRC8XPOBWmofM=" crossorigin="anonymous"></script>
<script src="app.js"></script>
</body>
app.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// Replace with your own values
const searchClient = algoliasearch(
'YourApplicationID',
'YourSearchOnlyAPIKey' // search only API key, not admin API key
);
const search = instantsearch({
indexName: 'contacts',
searchClient,
routing: true,
});
search.addWidgets([
instantsearch.widgets.configure({
hitsPerPage: 10,
})
]);
search.addWidgets([
instantsearch.widgets.searchBox({
container: '#search-box',
placeholder: 'Search for contacts',
})
]);
search.addWidgets([
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();
