Get trending facets

This method is only available in the JavaScript API client.

recommendClient .getTrendingFacets([ { indexName: "INDEX_NAME", threshold: 80, facetName: "movie_genre", }, ]) .then(({ results }) => { console.log(results); }) .catch((err) => { console.log(err); });

Parameters

requests

object[]

required

Show child attributes

facetName

string

required

The facet attribute to get recommendations for.

indexName

string

required

The name of the target index.

maxRecommendations

integer

The number of recommendations to retrieve. Depending on the available recommendations and the other request parameters, the actual number of hits may be lower than that. If maxRecommendations isn’t provided or set to 0, all matching recommendations are returned, and no fallback request is performed.

threshold

number

Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.

Response

results

object[]

List of #s in the order they were submitted, one per query.Example:

JSON

{
  "results": [
    {
      "hits": [
        {
          // ...,
          "_score": 32.72
        }
      ],
    },
  ]
}

Show child attributes

_score

number

The confidence score of the recommended facet value, the closer it’s to 100, the more relevant.

Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.

JSON

{
  "results": [
    {
      "exhaustiveNbHits": true,
      "exhaustiveTypo": true,
      "hits": [
        {
          "_score": 98,
          "facetName": "movie_genre",
          "facetValue": "adventure"
        },
        {
          "_score": 91.02,
          "facetName": "movie_genre",
          "facetValue": "action"
        },
        {
          "_score": 82,
          "facetName": "movie_genre",
          "facetValue": "thriller"
        }
      ],
      "hitsPerPage": 1000,
      "nbHits": 3,
      "nbPages": 1,
      "page": 0
    }
  ]
}

API clients (legacy)

Methods

Get trending facets

Examples

Parameters

Response

Response as JSON

​Examples

​Parameters

​Response

​Response as JSON

Examples

Parameters

Response

Response as JSON