Skip to content

Commit

Permalink
fix(specs): move customRanking and keepDiacriticsOnCharacters to inde…
Browse files Browse the repository at this point in the history
…xSettings [skip-bc] (#4324) (generated) [skip ci]

Co-authored-by: Pierre Millot <[email protected]>
  • Loading branch information
algolia-bot and millotp committed Jan 9, 2025
1 parent 1e847f4 commit f105b89
Show file tree
Hide file tree
Showing 167 changed files with 2,099 additions and 3,141 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,20 @@ public FallbackParams()
[JsonPropertyName("maxFacetHits")]
public int? MaxFacetHits { get; set; }

/// <summary>
/// Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
/// </summary>
/// <value>Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics. </value>
[JsonPropertyName("keepDiacriticsOnCharacters")]
public string KeepDiacriticsOnCharacters { get; set; }

/// <summary>
/// Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
/// </summary>
/// <value>Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied. </value>
[JsonPropertyName("customRanking")]
public List<string> CustomRanking { get; set; }

/// <summary>
/// Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
/// </summary>
Expand Down Expand Up @@ -656,6 +670,8 @@ public override string ToString()
sb.Append(" CustomNormalization: ").Append(CustomNormalization).Append("\n");
sb.Append(" AttributeForDistinct: ").Append(AttributeForDistinct).Append("\n");
sb.Append(" MaxFacetHits: ").Append(MaxFacetHits).Append("\n");
sb.Append(" KeepDiacriticsOnCharacters: ").Append(KeepDiacriticsOnCharacters).Append("\n");
sb.Append(" CustomRanking: ").Append(CustomRanking).Append("\n");
sb.Append(" AttributesToRetrieve: ").Append(AttributesToRetrieve).Append("\n");
sb.Append(" Ranking: ").Append(Ranking).Append("\n");
sb.Append(" RelevancyStrictness: ").Append(RelevancyStrictness).Append("\n");
Expand Down Expand Up @@ -767,6 +783,8 @@ public override bool Equals(object obj)
(CustomNormalization == input.CustomNormalization || CustomNormalization != null && input.CustomNormalization != null && CustomNormalization.SequenceEqual(input.CustomNormalization)) &&
(AttributeForDistinct == input.AttributeForDistinct || (AttributeForDistinct != null && AttributeForDistinct.Equals(input.AttributeForDistinct))) &&
(MaxFacetHits == input.MaxFacetHits || MaxFacetHits.Equals(input.MaxFacetHits)) &&
(KeepDiacriticsOnCharacters == input.KeepDiacriticsOnCharacters || (KeepDiacriticsOnCharacters != null && KeepDiacriticsOnCharacters.Equals(input.KeepDiacriticsOnCharacters))) &&
(CustomRanking == input.CustomRanking || CustomRanking != null && input.CustomRanking != null && CustomRanking.SequenceEqual(input.CustomRanking)) &&
(AttributesToRetrieve == input.AttributesToRetrieve || AttributesToRetrieve != null && input.AttributesToRetrieve != null && AttributesToRetrieve.SequenceEqual(input.AttributesToRetrieve)) &&
(Ranking == input.Ranking || Ranking != null && input.Ranking != null && Ranking.SequenceEqual(input.Ranking)) &&
(RelevancyStrictness == input.RelevancyStrictness || RelevancyStrictness.Equals(input.RelevancyStrictness)) &&
Expand Down Expand Up @@ -962,6 +980,14 @@ public override int GetHashCode()
hashCode = (hashCode * 59) + AttributeForDistinct.GetHashCode();
}
hashCode = (hashCode * 59) + MaxFacetHits.GetHashCode();
if (KeepDiacriticsOnCharacters != null)
{
hashCode = (hashCode * 59) + KeepDiacriticsOnCharacters.GetHashCode();
}
if (CustomRanking != null)
{
hashCode = (hashCode * 59) + CustomRanking.GetHashCode();
}
if (AttributesToRetrieve != null)
{
hashCode = (hashCode * 59) + AttributesToRetrieve.GetHashCode();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,20 @@ public RecommendSearchParams()
[JsonPropertyName("maxFacetHits")]
public int? MaxFacetHits { get; set; }

/// <summary>
/// Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
/// </summary>
/// <value>Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics. </value>
[JsonPropertyName("keepDiacriticsOnCharacters")]
public string KeepDiacriticsOnCharacters { get; set; }

/// <summary>
/// Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
/// </summary>
/// <value>Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied. </value>
[JsonPropertyName("customRanking")]
public List<string> CustomRanking { get; set; }

/// <summary>
/// Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
/// </summary>
Expand Down Expand Up @@ -656,6 +670,8 @@ public override string ToString()
sb.Append(" CustomNormalization: ").Append(CustomNormalization).Append("\n");
sb.Append(" AttributeForDistinct: ").Append(AttributeForDistinct).Append("\n");
sb.Append(" MaxFacetHits: ").Append(MaxFacetHits).Append("\n");
sb.Append(" KeepDiacriticsOnCharacters: ").Append(KeepDiacriticsOnCharacters).Append("\n");
sb.Append(" CustomRanking: ").Append(CustomRanking).Append("\n");
sb.Append(" AttributesToRetrieve: ").Append(AttributesToRetrieve).Append("\n");
sb.Append(" Ranking: ").Append(Ranking).Append("\n");
sb.Append(" RelevancyStrictness: ").Append(RelevancyStrictness).Append("\n");
Expand Down Expand Up @@ -767,6 +783,8 @@ public override bool Equals(object obj)
(CustomNormalization == input.CustomNormalization || CustomNormalization != null && input.CustomNormalization != null && CustomNormalization.SequenceEqual(input.CustomNormalization)) &&
(AttributeForDistinct == input.AttributeForDistinct || (AttributeForDistinct != null && AttributeForDistinct.Equals(input.AttributeForDistinct))) &&
(MaxFacetHits == input.MaxFacetHits || MaxFacetHits.Equals(input.MaxFacetHits)) &&
(KeepDiacriticsOnCharacters == input.KeepDiacriticsOnCharacters || (KeepDiacriticsOnCharacters != null && KeepDiacriticsOnCharacters.Equals(input.KeepDiacriticsOnCharacters))) &&
(CustomRanking == input.CustomRanking || CustomRanking != null && input.CustomRanking != null && CustomRanking.SequenceEqual(input.CustomRanking)) &&
(AttributesToRetrieve == input.AttributesToRetrieve || AttributesToRetrieve != null && input.AttributesToRetrieve != null && AttributesToRetrieve.SequenceEqual(input.AttributesToRetrieve)) &&
(Ranking == input.Ranking || Ranking != null && input.Ranking != null && Ranking.SequenceEqual(input.Ranking)) &&
(RelevancyStrictness == input.RelevancyStrictness || RelevancyStrictness.Equals(input.RelevancyStrictness)) &&
Expand Down Expand Up @@ -962,6 +980,14 @@ public override int GetHashCode()
hashCode = (hashCode * 59) + AttributeForDistinct.GetHashCode();
}
hashCode = (hashCode * 59) + MaxFacetHits.GetHashCode();
if (KeepDiacriticsOnCharacters != null)
{
hashCode = (hashCode * 59) + KeepDiacriticsOnCharacters.GetHashCode();
}
if (CustomRanking != null)
{
hashCode = (hashCode * 59) + CustomRanking.GetHashCode();
}
if (AttributesToRetrieve != null)
{
hashCode = (hashCode * 59) + AttributesToRetrieve.GetHashCode();
Expand Down
Loading

0 comments on commit f105b89

Please sign in to comment.