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] (generated)

algolia/api-clients-automation#4324

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
  • Loading branch information
@algolia-bot @millotp
algolia-bot and millotp committed Jan 9, 2025
1 parent 82e561c commit d688b2f
Show file tree
Hide file tree
Showing 13 changed files with 114 additions and 130 deletions.
18 changes: 17 additions & 1 deletion src/main/scala/algoliasearch/recommend/BaseIndexSettings.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
)
16 changes: 16 additions & 0 deletions src/main/scala/algoliasearch/recommend/FallbackParams.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down
16 changes: 16 additions & 0 deletions src/main/scala/algoliasearch/recommend/RecommendIndexSettings.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down
16 changes: 16 additions & 0 deletions src/main/scala/algoliasearch/recommend/RecommendSearchParams.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down
18 changes: 17 additions & 1 deletion src/main/scala/algoliasearch/search/BaseIndexSettings.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
)
16 changes: 0 additions & 16 deletions src/main/scala/algoliasearch/search/BrowseParamsObject.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand Down
16 changes: 0 additions & 16 deletions src/main/scala/algoliasearch/search/ConsequenceParams.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand Down
Loading

0 comments on commit d688b2f

Please sign in to comment.