API Reference / API Parameters / attributesToTransliterate
Type: object
Engine default: *
Parameter syntax
'attributesToTransliterate' => array(
  'attribute',
  // ...
)

Can be used in these methods:

About this parameter

Specify on which attributes to apply transliteration.

Transliteration refers to the ability of finding results in a given alphabet with a query in another alphabet. For example, in Japanese, transliteration enables users to find results indexed in Kanji or Katakana with a query in Hiragana.

Usage notes:

  • The setting only supports Japanese transliteration for now.
  • indexLanguages has to be set to ja for the transliteration to apply.

Examples

Set attributes to transliterate

1
2
3
4
5
$index->set_settings(array(
  'attributesToTransliterate' => array(
    'attribute'
  )
));

Did you find this page helpful?