API Reference / API Parameters / decompoundedAttributes

Feb. 26, 2019

decompoundedAttributes

Type: object

Engine default: (no decompounded attribute)

Parameter syntax

'decompoundedAttributes' => [
  ['2-character country code' => ['attribute', 'attribute']],
  ['2-character country code' => ['attribute', 'attribute']],
  ...
]

decompoundedAttributes: {
  2-character country code: [
    'attribute',
    'attribute'
  ],
  2-character country code: [
    'attribute',
    'attribute'
  ],
  ...
}

decompoundedAttributes: {
  2-character country code: [
    'attribute',
    'attribute'
  ],
  2-character country code: [
    'attribute',
    'attribute'
  ],
  ...
}

'decompoundedAttributes': {
  '2-character country code': [
    'attribute',
    'attribute'
  ],
  '2-character country code': [
    'attribute',
    'attribute'
  ],
  ...
}

"decompoundedAttributes": [
  "2-character country code": [
    "attribute",
    "attribute"
  ],
  "2-character country code": [
    "attribute",
    "attribute"
  ],
  ...
]

decompoundedAttributes {
    +language { +"attribute" }
    +...
}

new JSONObject().put(
  "decompoundedAttributes",
  new JSONObject()
    .put(
      "2-character country code",
      new JSONArray()
        .put("attribute")
        .put("attribute")
    .put(
      "2-character country code",
      new JSONArray()
        .put("attribute")
        .put("attribute")
    )
    ...
)

IndexSettings settings = new IndexSettings();
settings.DecompoundedAttributes = new Dictionary<string, List<string>>
{
    {"2-character country code", new List<string> {"attribute", "attribute"}},
    {"2-character country code", new List<string> {"attribute", "attribute"}}
};

Map<String, List<String>> decompoundedAttributes = new HashMap<>();
decompoundedAttributes.put(
  "2-character country code",
  Arrays.AsList(
    "attribute",
    "attribute"
  )
);
decompoundedAttributes.put(
  "2-character country code",
  Arrays.AsList(
    "attribute",
    "attribute"
  )
);
...

new IndexSettings().setDecompoundedAttributes(decompoundedAttributes)

opt.DecompoundedAttributes(map[string][]string{
  "2-character country code": {"attribute", "attribute"},
  "2-character country code": {"attribute", "attribute"},
  ...
})

val decompoundedAttributes = Map(
  "2-character country code" -> List("attribute", "attribute")
  "2-character country code" -> List("attribute", "attribute")
  ...
)

Can be used in these methods:
setSettings set_settings setSettings set_settings setSettings setSettings setSettingsAsync SetSettings setSettings SetSettings setSettings

See code examples

About this parameter

Specify on which attributes in your index Algolia should apply word-splitting (“decompounding”).

A compound word refers to a word that is formed by combining smaller words without spacing. They are called noun phrases, or nominal groups, and they are particularly present in German. An example is Baumhaus, which is a contraction of Baum and Haus.

The goal of decompounding, regarding the previous example, is to index both Baum and Haus separately, instead of as a single word.

Usage notes:

You can specify different attributes for each language.
As of today, the setting supports only three languages: Dutch (nl), German (de) and Finnish (fi).
Note The attributes listed must have been defined by searchableAttributes.

Examples

Enable word decompounding for one language

In this example we consider an index having only one language (de) and where we want to decompound only the attribute name

Copy

$index->setSettings([
  'decompoundedAttributes' => [
    'de' => [
      'name'
    ]
  ]
]);

index.setSettings(
  new JSONObject()
    .put(
      "decompoundedAttributes",
      new JSONObject()
        .put(
          "de",
          new JSONArray()
            .put("name")
        )
    )
);

IndexSettings settings = new IndexSettings();
settings.DecompoundedAttributes = new Dictionary<string, List<string>>
{
    {"de", new List<string> {"name"}}
};

index.SetSettings(settings);

Map<String, List<String>> decompoundedAttributes = new HashMap<>();

decompoundedAttributes.put(
  "de",
  Arrays.asList("name")
);

index.setSettings(
  new IndexSettings()
    .setDecompoundedAttributes(decompoundedAttributes)
);

val decompoundedAttributes = Map("de" -> List("name"))
client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    customSettings = Some(
      Map(
        "decompoundedAttributes" -> decompoundedAttributes
      )
    )
  )
}

Enable word decompounding for several languages

In this example we consider an index containing two languages (de, fi) in different attributes and where we want to decompound name and description for both languages.

Copy

$index->setSettings([
  'decompoundedAttributes' => [
    'de' => [
      'name_de',
      'description_de'
    ],
    'fi' => [
      'name_fi',
      'description_fi'
    ]
  ]
]);

index.set_settings({
  decompoundedAttributes: {
    de: [
      'name_de',
      'description_de'
    ],
    fi: [
      'name_fi',
      'description_fi'
    ]
  }
})

index.setSettings({
  decompoundedAttributes: {
    de: [
      'name_de',
      'description_de'
    ],
    fi: [
      'name_fi',
      'description_fi'
    ]
  }
});

index.set_settings({
  'decompoundedAttributes': {
    'de': [
      'name_de',
      'description_de'
    ],
    'fi': [
      'name_fi',
      'description_fi'
    ]
  }
})

index.setSettings([
  "decompoundedAttributes": [
    "de": [
      "name_de",
      "description_de"
    ],
    "fi": [
      "name_fi",
      "description_fi"
    ]
  ]
])

index.setSettings(
  new JSONObject().put(
    "decompoundedAttributes",
    new JSONObject()
      .put(
        "de",
        new JSONArray()
          .put("name_de")
          .put("description_de")
      .put(
        "fi",
        new JSONArray()
          .put("name_fi")
          .put("description_fi")
      )
  )
);

IndexSettings settings = new IndexSettings();
settings.DecompoundedAttributes = new Dictionary<string, List<string>>
{
    {"de", new List<string> {"name_de", "description_de"}},
    {"fi", new List<string> {"name_fi", "description_fi"}}
};

index.SetSettings(settings);

Map<String, List<String>> decompoundedAttributes = new HashMap<>();
decompoundedAttributes.put(
        "de",
        Arrays.asList(
                "name_de",
                "description_de"
        )
);

decompoundedAttributes.put(
        "fi",
        Arrays.asList(
                "name_fi",
                "description_fi"
        )
);

index.setSettings(
        new IndexSettings().setDecompoundedAttributes(decompoundedAttributes)
);

res, err := index.SetSettings(search.Settings{
  DecompoundedAttributes: opt.DecompoundedAttributes(map[string][]string{
    "de": {"name_de", "description_de"},
    "fi": {"name_fi", "description_fi"},
  }),
})

val decompoundedAttributes = Map(
  "de" -> List("name_de", "description_de")
  "fi" -> List("name_fi", "description_fi")
)

client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    customSettings = Some(
      Map("decompoundedAttributes" -> decompoundedAttributes)
    )
  )
}

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

decompoundedAttributes

About this parameter

Usage notes:

Examples

Enable word decompounding for one language

Enable word decompounding for several languages

Did you find this page helpful?

On this page