API Reference / API Parameters / personalizationImpact

Jan. 14, 2021

personalizationImpact

Type: integer

Engine default: 100

Parameter syntax

personalizationImpact => personalization_impact

personalizationImpact: personalization_impact

personalizationImpact: personalization_impact

personalizationImpact: personalization_impact

personalizationImpact = personalization_impact

personalizationImpact: Int = personalization_impact

# Not available yet
# Please use requestOptions to set the personalizationImpact

.PersonalizationImpact = personalization_impact

.setPersonalizationImpact(personalization_impact)

opt.PersonalizationImpact(personalization_impact)

personalizationImpact = Some(personalization_impact)

Can be used in these methods:
search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey searchAsync, browseAsync, searchForFacetValues Search, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Define the impact of the Personalization feature.

The personalizationImpact parameter sets the percentage of the impact that personalization has on ranking records.

This is set at query time and therefore overrides any impact value you had set on your index. The higher the personalizationImpact, the more the results are personalized for the user, and the less the custom ranking is taken into account in ranking records.

Usage notes:

The value must be between 0 and 100 (inclusive).
This parameter isn’t taken into account if enablePersonalization is false.
Setting personalizationImpact to 0 disables the Personalization feature, as if enablePersonalization were false.

Examples

Enable personalization for the current search

For Android and Swift, you may use the requestOptions parameter during a search to pass the personalizationImpact.

Copy

1
$index->search('query', ['personalizationImpact' => 20])

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.personalizationImpact, to: 20)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

personalizationImpact

About this parameter

Usage notes:

Examples

Enable personalization for the current search

Did you find this page helpful?

On this page