attributeForDistinct

About this parameter# Found an issue? Edit this parameter A Edit this parameter

Name of the attribute to deduplicate or group records.

The attributeForDistinct attribute works in combination with distinct:

• attributeForDistinct establishes groups: all records with the same value of attributeForDistinct are treated as a group.
• distinct determines how many variants per group are included in the search results.

Usage notes#

• You can define only one attribute for distinct.
• You can only set attributeForDistinct at indexing time. You can’t set or override it at query time.
• The attributeForDistinct attribute expects strings or numbers as values:
  • Number values are rounded to the nearest integer and converted to their string representation, for example, 1 and 1.2 both turn into "1".
  • String values are used as they are.
  • Boolean or null values are ignored.
  • Array and object values aren’t supported and result in unspecified behavior.

Examples# Found an issue? Edit this parameter A Edit this parameter

Set the attribute to distinct#

The following example declares the url attribute as attributeForDistinct. To deduplicate or group records based on this attribute, you also have to set the distinct parameter.

1
2
3
$index->setSettings([
  'attributeForDistinct' => 'url'
]);

1
2
3
index.set_settings({
  attributeForDistinct: 'url'
})

1
2
3
4
5
index.setSettings({
  attributeForDistinct: 'url'
}).then(() => {
  // done
});

1
2
3
index.set_settings({
    'attributeForDistinct': 'url'
})

1
2
3
4
5
6
7
8
let settings = Settings()
  .set(\.attributeForDistinct, to: "url")

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

1
2
3
4
5
val settings = settings {
    attributeForDistinct = Attribute("url")
}

index.setSettings(settings)

1
2
3
4
IndexSettings settings = new IndexSettings();
settings.AttributeForDistinct = "url";

index.SetSettings(settings);

1
2
3
4
index.setSettings(
  new IndexSettings()
    .setAttributeForDistinct("url")
);

1
2
3
res, err := index.SetSettings(search.Settings{
  AttributeForDistinct: opt.AttributeForDistinct("url"),
})

1
2
3
4
5
client.execute {
  setSettings of "myIndex" `with` IndexSettings(
    attributeForDistinct = Some("url")
  )
}