personalizationImpact

Influence of personalization on ranking for the current search

The personalizationImpact parameter defines how much personalization influences result ranking.

This is a percentage value from 0 to 100:

• At 0, personalization has no effect. This is equivalent to setting enablePersonalization to false.
• At 100, personalization has full effect.
• Intermediate values allow fine-tuning.

Usage

• This parameter has only an effect if enablePersonalization is true.

Example

Current API clients

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "INDEX_NAME",
  new SearchParams(new SearchParamsObject { Query = "query", PersonalizationImpact = 20 })
);

final response = await client.searchSingleIndex(
  indexName: "INDEX_NAME",
  searchParams: SearchParamsObject(
    query: "query",
    personalizationImpact: 20,
  ),
);

response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
  "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
  search.NewEmptySearchParamsObject().SetQuery("query").SetPersonalizationImpact(20))))
if err != nil {
  // handle the eventual error
  panic(err)
}

SearchResponse response = client.searchSingleIndex(
  "INDEX_NAME",
  new SearchParamsObject().setQuery("query").setPersonalizationImpact(20),
  Hit.class
);

const response = await client.searchSingleIndex({
  indexName: 'indexName',
  searchParams: { query: 'query', personalizationImpact: 20 },
});

var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = SearchParamsObject(query = "query", personalizationImpact = 20),
  )

$response = $client->searchSingleIndex(
    'INDEX_NAME',
    ['query' => 'query',
        'personalizationImpact' => 20,
    ],
);

response = client.search_single_index(
    index_name="INDEX_NAME",
    search_params={
        "query": "query",
        "personalizationImpact": 20,
    },
)

response = client.search_single_index(
  "INDEX_NAME",
  Algolia::Search::SearchParamsObject.new(query: "query", personalization_impact: 20)
)

val response = Await.result(
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = Some(
      SearchParamsObject(
        query = Some("query"),
        personalizationImpact = Some(20)
      )
    )
  ),
  Duration(100, "sec")
)

let response: SearchResponse<Hit> = try await client.searchSingleIndex(
    indexName: "INDEX_NAME",
    searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
        query: "query",
        personalizationImpact: 20
    ))
)

Legacy API clients

C#

Query query = new Query("query");
query.PersonalizationImpact = 20;

res, err := index.Search(
	"query",
	opt.PersonalizationImpact(20),
)

Query query = new Query("query").setPersonalizationImpact(20)

index
  .search("query", {
    personalizationImpact: 20,
  })
  .then(({ hits }) => {
    console.log(hits);
  });

val query = query("query") {
    personalizationImpact = 20
}

index.search(query)

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

index.search("query", {"personalizationImpact": 20})

index.search("query", {personalizationImpact: 20})

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    personalizationImpact = Some(20)
  )
}

let query = Query("query")
  .set(\.personalizationImpact, to: 20)

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