Troubleshooting Relevance

Troubleshooting Overview

Our docs are written to reach the widest audience. We do not try to address every situation that our customers will face. At some point, more individualized guidance is required.

For this, we offer several strategies to help you troubleshoot:

• Get ranking information with the getRankingInfo parameter. This parameter allows you to look at and analyze the criteria Algolia uses to rank results. For a given query it returns the value for each ranking criteria. By understanding those values you can understand why a result appears before or after another. See more below.
• Reproducing a problem on a small dataset and solving it by process of elimination. This strategy can be used alongside the getRankingInfo parameter. It helps you improve the results of specific queries. The idea is to create a very small index that mirrors your main index, and to test different configurations one-by-one until you’ve singled out the problem or inefficiency.
• Analytics and Insights. This allows you to follow your users’ behavior with Analytics. See more about this in our Analytics guide.

The Engine’s Ranking Decisions

You can find out why a record is ranked the way it is, and use this information to troubleshoot your data and relevance settings. You can do this in the Dashboard or via the API.

Troubleshooting in the dashboard

If you go to your dashboard and search, you have a “Ranking Info” section that details how Algolia ranked this record.

If you look at the second hit, you’ll have the difference between this object and the one above it.

Troubleshoot via the API

Ranking information can be retrieved via the API. For that, you need to use the parameter getRankingInfo and set it to true.

Initialize the client

1
2
3
4
5
6
7
8
9
10
11
12
// composer autoload
require __DIR__ . '/vendor/autoload.php';

// if you are not using composer
// require_once 'path/to/algoliasearch.php';

$client = \Algolia\AlgoliaSearch\SearchClient::create(
  'YourApplicationID',
  'YourAdminAPIKey'
);

$index = $client->initIndex('your_index_name');

1
2
3
4
5
6
require 'rubygems'
require 'algoliasearch'

Algolia.init(application_id: 'YourApplicationID',
             api_key:        'YourAdminAPIKey')
index = Algolia::Index.new('your_index_name')

1
2
3
4
5
6
7
8
9
10
11
// const algoliasearch = require('algoliasearch');
// const algoliasearch = require('algoliasearch/reactnative');
// const algoliasearch = require('algoliasearch/lite');
// import algoliasearch from 'algoliasearch';
//
// or just use algoliasearch if you are using a <script> tag
// if you are using AMD module loader, algoliasearch will not be defined in window,
// but in the AMD modules of the page

const client = algoliasearch('YourApplicationID', 'YourAdminAPIKey');
const index = client.initIndex('your_index_name');

1
2
3
4
from algoliasearch.search_client import SearchClient

client = SearchClient.create('YourApplicationID', 'YourAdminAPIKey')
index = client.init_index('your_index_name')

1
2
let client = Client(appID: "YourApplicationID", apiKey: "YourAdminAPIKey")
let index = client.index(withName: "your_index_name")

1
2
Client client = new Client("YourApplicationID", "YourAdminAPIKey");
Index index = client.getIndex("your_index_name");

1
2
SearchClient client = new SearchClient("YourApplicationID", "YourAdminAPIKey");
SearchIndex index = client.InitIndex("your_index_name");

1
2
3
4
SearchClient client = 
DefaultSearchClient.create("YourApplicationID", "YourAdminAPIKey");

SearchIndex index = client.InitIndex("your_index_name");

1
2
3
4
5
6
7
8
package main

import "github.com/algolia/algoliasearch-client-go/algolia/search"

func main() {
  client := search.NewClient("YourApplicationID", "YourAdminAPIKey")
  index := client.InitIndex("your_index_name")
}

1
2
// No initIndex
val client = new AlgoliaClient("YourApplicationID", "YourAdminAPIKey")

1
2
3
4
5
6
7
val client = ClientSearch(
    applicationID = ApplicationID("latency"),
    apiKey = APIKey("YourAdminAPIKey")
)
val indexName = IndexName("your_index_name")

client.initIndex(indexName)

Search with getRankingInfo

1
2
3
4
5
6
7
$results = $index->search('query', [
  'getRankingInfo' => true
]);

//foreach ($results['hits'] as $hit) {
//  var_dump($hit['_rankingInfo']);
//}

1
2
3
4
5
6
7
results = index.search('query', {
  getRankingInfo: true
})

# results['hits'].each do |hit|
#   puts hit['_rankingInfo']
# end

1
2
3
4
5
6
index.search({
  query: 'query',
  getRankingInfo: true
}).then(res => {
  // console.log(res.hits.map(hit => hit._rankingInfo));
});

1
2
3
4
5
6
results = index.search('query', {
    'getRankingInfo': True
})

# for hit in results['hits']:
#   print(hit['_rankingInfo'])

1
2
3
4
5
6
let query = Query(query: "query")
query.getRankingInfo = true

index.search(query, completionHandler: { (res, error) in
  print(res)
})

1
2
3
4
index.search(
  new Query("query")
    .setGetRankingInfo(true)
);

1
2
3
4
index.search(
  new Query("query")
    .GetRankingInfo(true)
);

1
2
3
4
index.search(
  new Query("query")
    .setGetRankingInfo(true)
);

1
2
3
4
res, err := index.Search(
  "query",
  opt.GetRankingInfo(true),
)

1
2
3
4
5
6
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    getRankingInfo = Some(true)
  )
}

1
2
3
4
5
val query = query("query") {
    getRankingInfo = true
}

index.search(query)

This gives you ranking info

Take a look at the following results in the _rankingInfo attribute:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  [...],
  "_rankingInfo": {
      "nbTypos": 0,
      "firstMatchedWord": 0,
      "proximityDistance": 0,
      "userScore": 7,
      "geoDistance": 1600,
      "geoPrecision": 1,
      "nbExactWords": 0,
      "words": 0,
      "filters": 0,
      "matchedGeoLocation": {
          "lat": 37.3688,
          "lng": -122.036,
          "distance": 1600
      }
  }
}