From d688b2fd821514ba24db5e5d31fdc8a615343d6e Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Thu, 9 Jan 2025 16:14:43 +0000 Subject: [PATCH] fix(specs): move customRanking and keepDiacriticsOnCharacters to indexSettings [skip-bc] (generated) https://github.com/algolia/api-clients-automation/pull/4324 Co-authored-by: algolia-bot Co-authored-by: Pierre Millot --- .../recommend/BaseIndexSettings.scala | 18 ++++++++++- .../recommend/FallbackParams.scala | 16 ++++++++++ .../recommend/RecommendIndexSettings.scala | 16 ++++++++++ .../recommend/RecommendSearchParams.scala | 16 ++++++++++ .../search/BaseIndexSettings.scala | 18 ++++++++++- .../search/BrowseParamsObject.scala | 16 ---------- .../search/ConsequenceParams.scala | 16 ---------- .../algoliasearch/search/IndexSettings.scala | 32 +++++++++---------- .../search/IndexSettingsAsSearchParams.scala | 16 ---------- .../search/SearchForFacets.scala | 16 ---------- .../algoliasearch/search/SearchForHits.scala | 16 ---------- .../search/SearchParamsObject.scala | 16 ---------- .../search/SettingsResponse.scala | 32 +++++++++---------- 13 files changed, 114 insertions(+), 130 deletions(-) diff --git a/src/main/scala/algoliasearch/recommend/BaseIndexSettings.scala b/src/main/scala/algoliasearch/recommend/BaseIndexSettings.scala index e89b07b4..412c7671 100644 --- a/src/main/scala/algoliasearch/recommend/BaseIndexSettings.scala +++ b/src/main/scala/algoliasearch/recommend/BaseIndexSettings.scala @@ -138,6 +138,20 @@ import algoliasearch.recommend.SupportedLanguage._ * @param maxFacetHits * Maximum number of facet values to return when [searching for facet * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @param keepDiacriticsOnCharacters + * 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. + * @param customRanking + * 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. */ case class BaseIndexSettings( attributesForFaceting: Option[Seq[String]] = scala.None, @@ -157,5 +171,7 @@ case class BaseIndexSettings( userData: Option[Any] = scala.None, customNormalization: Option[Map[String, Map[String, String]]] = scala.None, attributeForDistinct: Option[String] = scala.None, - maxFacetHits: Option[Int] = scala.None + maxFacetHits: Option[Int] = scala.None, + keepDiacriticsOnCharacters: Option[String] = scala.None, + customRanking: Option[Seq[String]] = scala.None ) diff --git a/src/main/scala/algoliasearch/recommend/FallbackParams.scala b/src/main/scala/algoliasearch/recommend/FallbackParams.scala index edf18bfe..889de0a6 100644 --- a/src/main/scala/algoliasearch/recommend/FallbackParams.scala +++ b/src/main/scala/algoliasearch/recommend/FallbackParams.scala @@ -228,6 +228,20 @@ import algoliasearch.recommend.SupportedLanguage._ * @param maxFacetHits * Maximum number of facet values to return when [searching for facet * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @param keepDiacriticsOnCharacters + * 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. + * @param customRanking + * 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. * @param attributesToRetrieve * 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 @@ -416,6 +430,8 @@ case class FallbackParams( customNormalization: Option[Map[String, Map[String, String]]] = scala.None, attributeForDistinct: Option[String] = scala.None, maxFacetHits: Option[Int] = scala.None, + keepDiacriticsOnCharacters: Option[String] = scala.None, + customRanking: Option[Seq[String]] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, diff --git a/src/main/scala/algoliasearch/recommend/RecommendIndexSettings.scala b/src/main/scala/algoliasearch/recommend/RecommendIndexSettings.scala index fc05c1c0..0a732ce8 100644 --- a/src/main/scala/algoliasearch/recommend/RecommendIndexSettings.scala +++ b/src/main/scala/algoliasearch/recommend/RecommendIndexSettings.scala @@ -143,6 +143,20 @@ import algoliasearch.recommend.SupportedLanguage._ * @param maxFacetHits * Maximum number of facet values to return when [searching for facet * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @param keepDiacriticsOnCharacters + * 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. + * @param customRanking + * 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. * @param attributesToRetrieve * 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 @@ -302,6 +316,8 @@ case class RecommendIndexSettings( customNormalization: Option[Map[String, Map[String, String]]] = scala.None, attributeForDistinct: Option[String] = scala.None, maxFacetHits: Option[Int] = scala.None, + keepDiacriticsOnCharacters: Option[String] = scala.None, + customRanking: Option[Seq[String]] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, diff --git a/src/main/scala/algoliasearch/recommend/RecommendSearchParams.scala b/src/main/scala/algoliasearch/recommend/RecommendSearchParams.scala index 98659acd..c05914b7 100644 --- a/src/main/scala/algoliasearch/recommend/RecommendSearchParams.scala +++ b/src/main/scala/algoliasearch/recommend/RecommendSearchParams.scala @@ -228,6 +228,20 @@ import algoliasearch.recommend.SupportedLanguage._ * @param maxFacetHits * Maximum number of facet values to return when [searching for facet * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @param keepDiacriticsOnCharacters + * 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. + * @param customRanking + * 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. * @param attributesToRetrieve * 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 @@ -416,6 +430,8 @@ case class RecommendSearchParams( customNormalization: Option[Map[String, Map[String, String]]] = scala.None, attributeForDistinct: Option[String] = scala.None, maxFacetHits: Option[Int] = scala.None, + keepDiacriticsOnCharacters: Option[String] = scala.None, + customRanking: Option[Seq[String]] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, diff --git a/src/main/scala/algoliasearch/search/BaseIndexSettings.scala b/src/main/scala/algoliasearch/search/BaseIndexSettings.scala index 9a34e777..95b28836 100644 --- a/src/main/scala/algoliasearch/search/BaseIndexSettings.scala +++ b/src/main/scala/algoliasearch/search/BaseIndexSettings.scala @@ -142,6 +142,20 @@ import algoliasearch.search.SupportedLanguage._ * @param maxFacetHits * Maximum number of facet values to return when [searching for facet * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @param keepDiacriticsOnCharacters + * 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. + * @param customRanking + * 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. */ case class BaseIndexSettings( attributesForFaceting: Option[Seq[String]] = scala.None, @@ -161,5 +175,7 @@ case class BaseIndexSettings( userData: Option[Any] = scala.None, customNormalization: Option[Map[String, Map[String, String]]] = scala.None, attributeForDistinct: Option[String] = scala.None, - maxFacetHits: Option[Int] = scala.None + maxFacetHits: Option[Int] = scala.None, + keepDiacriticsOnCharacters: Option[String] = scala.None, + customRanking: Option[Seq[String]] = scala.None ) diff --git a/src/main/scala/algoliasearch/search/BrowseParamsObject.scala b/src/main/scala/algoliasearch/search/BrowseParamsObject.scala index 88cf02d8..89d7f245 100644 --- a/src/main/scala/algoliasearch/search/BrowseParamsObject.scala +++ b/src/main/scala/algoliasearch/search/BrowseParamsObject.scala @@ -150,16 +150,6 @@ import algoliasearch.search.SupportedLanguage._ * values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, * in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by * [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking - * 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. * @param relevancyStrictness * Relevancy threshold below which less relevant results aren't included in the results. You can only set * `relevancyStrictness` on [virtual replica @@ -205,10 +195,6 @@ import algoliasearch.search.SupportedLanguage._ * \- Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of * text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms * if your attributes have intentional unusual spellings that might look like typos. - * @param keepDiacriticsOnCharacters - * 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. * @param queryLanguages * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection * dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` @@ -328,7 +314,6 @@ case class BrowseParamsObject( enableABTest: Option[Boolean] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, - customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, @@ -344,7 +329,6 @@ case class BrowseParamsObject( disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, - keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, diff --git a/src/main/scala/algoliasearch/search/ConsequenceParams.scala b/src/main/scala/algoliasearch/search/ConsequenceParams.scala index 5146e004..e39a2f79 100644 --- a/src/main/scala/algoliasearch/search/ConsequenceParams.scala +++ b/src/main/scala/algoliasearch/search/ConsequenceParams.scala @@ -148,16 +148,6 @@ import algoliasearch.search.SupportedLanguage._ * values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, * in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by * [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking - * 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. * @param relevancyStrictness * Relevancy threshold below which less relevant results aren't included in the results. You can only set * `relevancyStrictness` on [virtual replica @@ -203,10 +193,6 @@ import algoliasearch.search.SupportedLanguage._ * \- Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of * text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms * if your attributes have intentional unusual spellings that might look like typos. - * @param keepDiacriticsOnCharacters - * 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. * @param queryLanguages * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection * dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` @@ -322,7 +308,6 @@ case class ConsequenceParams( enableABTest: Option[Boolean] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, - customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, @@ -338,7 +323,6 @@ case class ConsequenceParams( disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, - keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, diff --git a/src/main/scala/algoliasearch/search/IndexSettings.scala b/src/main/scala/algoliasearch/search/IndexSettings.scala index ab880539..8c42dbaf 100644 --- a/src/main/scala/algoliasearch/search/IndexSettings.scala +++ b/src/main/scala/algoliasearch/search/IndexSettings.scala @@ -148,6 +148,20 @@ import algoliasearch.search.SupportedLanguage._ * @param maxFacetHits * Maximum number of facet values to return when [searching for facet * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @param keepDiacriticsOnCharacters + * 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. + * @param customRanking + * 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. * @param attributesToRetrieve * 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 @@ -164,16 +178,6 @@ import algoliasearch.search.SupportedLanguage._ * values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, * in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by * [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking - * 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. * @param relevancyStrictness * Relevancy threshold below which less relevant results aren't included in the results. You can only set * `relevancyStrictness` on [virtual replica @@ -219,10 +223,6 @@ import algoliasearch.search.SupportedLanguage._ * \- Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of * text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms * if your attributes have intentional unusual spellings that might look like typos. - * @param keepDiacriticsOnCharacters - * 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. * @param queryLanguages * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection * dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` @@ -323,9 +323,10 @@ case class IndexSettings( customNormalization: Option[Map[String, Map[String, String]]] = scala.None, attributeForDistinct: Option[String] = scala.None, maxFacetHits: Option[Int] = scala.None, + keepDiacriticsOnCharacters: Option[String] = scala.None, + customRanking: Option[Seq[String]] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, - customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, @@ -341,7 +342,6 @@ case class IndexSettings( disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, - keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, diff --git a/src/main/scala/algoliasearch/search/IndexSettingsAsSearchParams.scala b/src/main/scala/algoliasearch/search/IndexSettingsAsSearchParams.scala index 37e5dce5..3cd73e9b 100644 --- a/src/main/scala/algoliasearch/search/IndexSettingsAsSearchParams.scala +++ b/src/main/scala/algoliasearch/search/IndexSettingsAsSearchParams.scala @@ -59,16 +59,6 @@ import algoliasearch.search.SupportedLanguage._ * values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, * in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by * [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking - * 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. * @param relevancyStrictness * Relevancy threshold below which less relevant results aren't included in the results. You can only set * `relevancyStrictness` on [virtual replica @@ -114,10 +104,6 @@ import algoliasearch.search.SupportedLanguage._ * \- Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of * text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms * if your attributes have intentional unusual spellings that might look like typos. - * @param keepDiacriticsOnCharacters - * 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. * @param queryLanguages * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection * dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` @@ -202,7 +188,6 @@ import algoliasearch.search.SupportedLanguage._ case class IndexSettingsAsSearchParams( attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, - customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, @@ -218,7 +203,6 @@ case class IndexSettingsAsSearchParams( disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, - keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, diff --git a/src/main/scala/algoliasearch/search/SearchForFacets.scala b/src/main/scala/algoliasearch/search/SearchForFacets.scala index 027e4523..df50b179 100644 --- a/src/main/scala/algoliasearch/search/SearchForFacets.scala +++ b/src/main/scala/algoliasearch/search/SearchForFacets.scala @@ -153,16 +153,6 @@ import algoliasearch.search.SupportedLanguage._ * values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, * in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by * [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking - * 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. * @param relevancyStrictness * Relevancy threshold below which less relevant results aren't included in the results. You can only set * `relevancyStrictness` on [virtual replica @@ -208,10 +198,6 @@ import algoliasearch.search.SupportedLanguage._ * \- Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of * text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms * if your attributes have intentional unusual spellings that might look like typos. - * @param keepDiacriticsOnCharacters - * 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. * @param queryLanguages * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection * dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` @@ -338,7 +324,6 @@ case class SearchForFacets( enableABTest: Option[Boolean] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, - customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, @@ -354,7 +339,6 @@ case class SearchForFacets( disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, - keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, diff --git a/src/main/scala/algoliasearch/search/SearchForHits.scala b/src/main/scala/algoliasearch/search/SearchForHits.scala index d6ce3135..17b3cb51 100644 --- a/src/main/scala/algoliasearch/search/SearchForHits.scala +++ b/src/main/scala/algoliasearch/search/SearchForHits.scala @@ -153,16 +153,6 @@ import algoliasearch.search.SupportedLanguage._ * values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, * in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by * [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking - * 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. * @param relevancyStrictness * Relevancy threshold below which less relevant results aren't included in the results. You can only set * `relevancyStrictness` on [virtual replica @@ -208,10 +198,6 @@ import algoliasearch.search.SupportedLanguage._ * \- Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of * text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms * if your attributes have intentional unusual spellings that might look like typos. - * @param keepDiacriticsOnCharacters - * 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. * @param queryLanguages * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection * dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` @@ -331,7 +317,6 @@ case class SearchForHits( enableABTest: Option[Boolean] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, - customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, @@ -347,7 +332,6 @@ case class SearchForHits( disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, - keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, diff --git a/src/main/scala/algoliasearch/search/SearchParamsObject.scala b/src/main/scala/algoliasearch/search/SearchParamsObject.scala index 5b394573..6d9c9b29 100644 --- a/src/main/scala/algoliasearch/search/SearchParamsObject.scala +++ b/src/main/scala/algoliasearch/search/SearchParamsObject.scala @@ -150,16 +150,6 @@ import algoliasearch.search.SupportedLanguage._ * values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, * in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by * [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking - * 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. * @param relevancyStrictness * Relevancy threshold below which less relevant results aren't included in the results. You can only set * `relevancyStrictness` on [virtual replica @@ -205,10 +195,6 @@ import algoliasearch.search.SupportedLanguage._ * \- Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of * text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms * if your attributes have intentional unusual spellings that might look like typos. - * @param keepDiacriticsOnCharacters - * 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. * @param queryLanguages * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection * dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` @@ -325,7 +311,6 @@ case class SearchParamsObject( enableABTest: Option[Boolean] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, - customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, @@ -341,7 +326,6 @@ case class SearchParamsObject( disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, - keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None, diff --git a/src/main/scala/algoliasearch/search/SettingsResponse.scala b/src/main/scala/algoliasearch/search/SettingsResponse.scala index 807e5773..54208804 100644 --- a/src/main/scala/algoliasearch/search/SettingsResponse.scala +++ b/src/main/scala/algoliasearch/search/SettingsResponse.scala @@ -148,6 +148,20 @@ import algoliasearch.search.SupportedLanguage._ * @param maxFacetHits * Maximum number of facet values to return when [searching for facet * values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @param keepDiacriticsOnCharacters + * 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. + * @param customRanking + * 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. * @param attributesToRetrieve * 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 @@ -164,16 +178,6 @@ import algoliasearch.search.SupportedLanguage._ * values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, * in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by * [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/). - * @param customRanking - * 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. * @param relevancyStrictness * Relevancy threshold below which less relevant results aren't included in the results. You can only set * `relevancyStrictness` on [virtual replica @@ -219,10 +223,6 @@ import algoliasearch.search.SupportedLanguage._ * \- Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of * text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms * if your attributes have intentional unusual spellings that might look like typos. - * @param keepDiacriticsOnCharacters - * 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. * @param queryLanguages * Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection * dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` @@ -325,9 +325,10 @@ case class SettingsResponse( customNormalization: Option[Map[String, Map[String, String]]] = scala.None, attributeForDistinct: Option[String] = scala.None, maxFacetHits: Option[Int] = scala.None, + keepDiacriticsOnCharacters: Option[String] = scala.None, + customRanking: Option[Seq[String]] = scala.None, attributesToRetrieve: Option[Seq[String]] = scala.None, ranking: Option[Seq[String]] = scala.None, - customRanking: Option[Seq[String]] = scala.None, relevancyStrictness: Option[Int] = scala.None, attributesToHighlight: Option[Seq[String]] = scala.None, attributesToSnippet: Option[Seq[String]] = scala.None, @@ -343,7 +344,6 @@ case class SettingsResponse( disableTypoToleranceOnAttributes: Option[Seq[String]] = scala.None, ignorePlurals: Option[IgnorePlurals] = scala.None, removeStopWords: Option[RemoveStopWords] = scala.None, - keepDiacriticsOnCharacters: Option[String] = scala.None, queryLanguages: Option[Seq[SupportedLanguage]] = scala.None, decompoundQuery: Option[Boolean] = scala.None, enableRules: Option[Boolean] = scala.None,