enablePersonalization

Whether to turn off personalization

The effect of setting enablePersonalization to true is to take into account user insights to personalize the ranking of records.

Example

Current API clients

C#

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

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

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

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

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

var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = SearchParamsObject(query = "query", enablePersonalization = true),
  )

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

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

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

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

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

Legacy API clients

C#

IndexSettings settings = new IndexSettings
{
  EnablePersonalization = true
};

index.SetSettings(setting);

// Asynchronous
await index.SetSettingsAsync(settings);

IndexSettings settings = new IndexSettings().setEnablePersonalization(true);
// Sync version
index.setSettings(settings);
// Async version
index.setSettingsAsync(settings);

  go: |

res, err := index.SetSettings(search.Settings{
  EnablePersonalization: opt.EnablePersonalization(true),
})

index.setSettings({ enablePersonalization: true });

val setting = Settings(enablePersonalization = true)
index.setSettings(settings)

$index->setSettings([
  'enablePersonalization' => true
]);

index.set_settings({"enablePersonalization": true})

index.set_settings({enablePersonalization: true})

client.execute {
  setSettings of "indexName" `with` IndexSettings(
    enablePersonalization = Some(true)
  )
}

let settings = Settings()
  .set(\.enablePersonalization, to: true)

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