> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# attributesToTransliterate

> Attributes whose content is transliterated to support searching Japanese text across writing systems (Kanji, Hiragana, and Katakana).

export const Setting = ({type, default: defaultValue, defaultNote, scope, min, max, formerly}) => {
  const renderedDefault = defaultValue === '' ? '""' : defaultValue;
  const renderedNote = defaultNote ? `(${defaultNote})` : '';
  return <ul>
      <li><strong>Type:</strong> <code>{type}</code></li>
      <li><strong>Default:</strong> <code>{renderedDefault}</code>{renderedNote}</li>
      {min && <li><strong>Min:</strong> <code>{min}</code></li>}
      {max && <li><strong>Max:</strong> <code>{max}</code></li>}
      <li><strong>Scope:</strong> <a href="/doc/api-reference/api-parameters"><code>{scope}</code></a></li>
      {formerly && <li>
          <strong>Deprecated name:</strong> <code>{formerly}</code>
        </li>}
    </ul>;
};

<Setting type="array" default="[&#x22;*&#x22;]" scope="settings" />

The `attributesToTransliterate` parameter specifies which attributes should be **transliterated** when using Japanese.
This allows users to search in one writing system, such as Hiragana and match records written in another, such as Kanji or Katakana.

## Usage

* Attribute names are case-sensitive.
* Only supported for **Japanese** content.
* You must set [`indexLanguages`](/doc/api-reference/api-parameters/indexLanguages) to `"ja"` for this setting to take effect.
* `"*"` applies transliteration to all searchable attributes.

## Example

<AccordionGroup>
  <Accordion title="Current API clients" defaultOpen="true">
    <CodeGroup>
      ```cs C# theme={"system"}
      var response = await client.SetSettingsAsync(
        "INDEX_NAME",
        new IndexSettings
        {
          IndexLanguages = new List<SupportedLanguage> { Enum.Parse<SupportedLanguage>("Ja") },
          AttributesToTransliterate = new List<string> { "name", "description" },
        }
      );
      ```

      ```dart Dart theme={"system"}
      final response = await client.setSettings(
        indexName: "INDEX_NAME",
        indexSettings: IndexSettings(
          indexLanguages: [
            SupportedLanguage.fromJson("ja"),
          ],
          attributesToTransliterate: [
            "name",
            "description",
          ],
        ),
      );
      ```

      ```go Go theme={"system"}
      response, err := client.SetSettings(client.NewApiSetSettingsRequest(
        "INDEX_NAME",
        search.NewEmptyIndexSettings().SetIndexLanguages(
          []search.SupportedLanguage{search.SupportedLanguage("ja")}).SetAttributesToTransliterate(
          []string{"name", "description"})))
      if err != nil {
        // handle the eventual error
        panic(err)
      }
      ```

      ```java Java theme={"system"}
      UpdatedAtResponse response = client.setSettings(
        "INDEX_NAME",
        new IndexSettings()
          .setIndexLanguages(Arrays.asList(SupportedLanguage.JA))
          .setAttributesToTransliterate(Arrays.asList("name", "description"))
      );
      ```

      ```js JavaScript theme={"system"}
      const response = await client.setSettings({
        indexName: 'theIndexName',
        indexSettings: { indexLanguages: ['ja'], attributesToTransliterate: ['name', 'description'] },
      });
      ```

      ```kotlin Kotlin theme={"system"}
      var response =
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings =
            IndexSettings(
              indexLanguages = listOf(SupportedLanguage.entries.first { it.value == "ja" }),
              attributesToTransliterate = listOf("name", "description"),
            ),
        )
      ```

      ```php PHP theme={"system"}
      $response = $client->setSettings(
          'INDEX_NAME',
          ['indexLanguages' => [
              'ja',
          ],
              'attributesToTransliterate' => [
                  'name',

                  'description',
              ],
          ],
      );
      ```

      ```python Python theme={"system"}
      response = client.set_settings(
          index_name="INDEX_NAME",
          index_settings={
              "indexLanguages": [
                  "ja",
              ],
              "attributesToTransliterate": [
                  "name",
                  "description",
              ],
          },
      )
      ```

      ```ruby Ruby theme={"system"}
      response = client.set_settings(
        "INDEX_NAME",
        Algolia::Search::IndexSettings.new(index_languages: ["ja"], attributes_to_transliterate: ["name", "description"])
      )
      ```

      ```scala Scala theme={"system"}
      val response = Await.result(
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings = IndexSettings(
            indexLanguages = Some(Seq(SupportedLanguage.withName("ja"))),
            attributesToTransliterate = Some(Seq("name", "description"))
          )
        ),
        Duration(100, "sec")
      )
      ```

      ```swift Swift theme={"system"}
      let response = try await client.setSettings(
          indexName: "INDEX_NAME",
          indexSettings: IndexSettings(
              attributesToTransliterate: ["name", "description"],
              indexLanguages: [SearchSupportedLanguage.ja]
          )
      )
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```cs C# theme={"system"}
      IndexSettings settings = new IndexSettings
      {
        IndexLanguages = new List { "ja" }
        AttributesToTransliterate = new List { "name", "description" }
      };

      // Synchronous
      index.SetSettings(settings);

      // Asynchronous
      await index.SetSettings(settings);
      ```

      ```go Go theme={"system"}
      res, err := index.SetSettings(search.Settings{
      	IndexLanguages: opt.IndexLanguages("ja"),
      	AttributesToTransliterate: opt.AttributesToTransliterate(
      		"name",
      		"description",
      	),
      })
      ```

      ```java Java theme={"system"}
      IndexSettings setting = new IndexSettings().setIndexLanguages(
        Arrays.asList("ja")
      ).setAttributesToTransliterate(
        Arrays.asList("name", "description")
      );

      // Synchronous
      index.setSettings(setting);
      // Asynchronous
      index.setSettingsAsync(setting);
      ```

      ```js JavaScript theme={"system"}
      index.setSettings({
        indexLanguages: ["ja"],
        attributesToTransliterate: ["name", "description"],
      });
      ```

      ```kotlin Kotlin theme={"system"}
      val settings = settings {
          indexLanguages = listOf(Language.Japanese)
          attributesToTransliterate = listOf(Attribute("attribute"))
      }
      index.setSettings(settings)
      ```

      ```php PHP theme={"system"}
      $index->set_settings(array(
        'indexLanguages' => ['ja'],
        'attributesToTransliterate' => array(
          'name',
          'description'
        )
      ));
      ```

      ```python Python theme={"system"}
      index.set_settings(
          {"indexLanguages": ["ja"], "attributesToTransliterate": ["name", "description"]}
      )
      ```

      ```ruby Ruby theme={"system"}
      index.set_settings(
        {
          indexLanguages: ["ja"],
          attributesToTransliterate: [
            "name",
            "description"
          ]
        }
      )
      ```

      ```scala Scala theme={"system"}
      client.execute {
        setSettings of "myIndex" `with` IndexSettings(
          indexLanguages = Some(Seq("ja")),
          attributesToTransliterate = Some(Seq("Attribute", "*"))
        )
      }
      ```

      ```swift Swift theme={"system"}
      let settings = Settings()
        .set(\.indexLanguages, to: [.japanese])
        .set(\.attributesToTransliterate, to: ["name", "description"])

      index.setSettings(settings) { result in
        if case .success(let response) = result {
          print("Response: \(response)")
        }
      }
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>