Skip to content

Commit 7091f04

Browse files
algolia-botmillotp
algolia-bot
and
millotp
committed
fix(specs): move customRanking and keepDiacriticsOnCharacters to indexSettings [skip-bc] (generated)
algolia/api-clients-automation#4324 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent 44a05a2 commit 7091f04

12 files changed

+250
-634
lines changed

‎lib/Model/Recommend/FallbackParams.php‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ class FallbackParams extends AbstractModel implements ModelInterface, \ArrayAcce
6767
'customNormalization' => 'array<string,array<string,string>>',
6868
'attributeForDistinct' => 'string',
6969
'maxFacetHits' => 'int',
70+
'keepDiacriticsOnCharacters' => 'string',
71+
'customRanking' => 'string[]',
7072
'attributesToRetrieve' => 'string[]',
7173
'ranking' => 'string[]',
7274
'relevancyStrictness' => 'int',
@@ -160,6 +162,8 @@ class FallbackParams extends AbstractModel implements ModelInterface, \ArrayAcce
160162
'customNormalization' => null,
161163
'attributeForDistinct' => null,
162164
'maxFacetHits' => null,
165+
'keepDiacriticsOnCharacters' => null,
166+
'customRanking' => null,
163167
'attributesToRetrieve' => null,
164168
'ranking' => null,
165169
'relevancyStrictness' => null,
@@ -254,6 +258,8 @@ class FallbackParams extends AbstractModel implements ModelInterface, \ArrayAcce
254258
'customNormalization' => 'customNormalization',
255259
'attributeForDistinct' => 'attributeForDistinct',
256260
'maxFacetHits' => 'maxFacetHits',
261+
'keepDiacriticsOnCharacters' => 'keepDiacriticsOnCharacters',
262+
'customRanking' => 'customRanking',
257263
'attributesToRetrieve' => 'attributesToRetrieve',
258264
'ranking' => 'ranking',
259265
'relevancyStrictness' => 'relevancyStrictness',
@@ -347,6 +353,8 @@ class FallbackParams extends AbstractModel implements ModelInterface, \ArrayAcce
347353
'customNormalization' => 'setCustomNormalization',
348354
'attributeForDistinct' => 'setAttributeForDistinct',
349355
'maxFacetHits' => 'setMaxFacetHits',
356+
'keepDiacriticsOnCharacters' => 'setKeepDiacriticsOnCharacters',
357+
'customRanking' => 'setCustomRanking',
350358
'attributesToRetrieve' => 'setAttributesToRetrieve',
351359
'ranking' => 'setRanking',
352360
'relevancyStrictness' => 'setRelevancyStrictness',
@@ -440,6 +448,8 @@ class FallbackParams extends AbstractModel implements ModelInterface, \ArrayAcce
440448
'customNormalization' => 'getCustomNormalization',
441449
'attributeForDistinct' => 'getAttributeForDistinct',
442450
'maxFacetHits' => 'getMaxFacetHits',
451+
'keepDiacriticsOnCharacters' => 'getKeepDiacriticsOnCharacters',
452+
'customRanking' => 'getCustomRanking',
443453
'attributesToRetrieve' => 'getAttributesToRetrieve',
444454
'ranking' => 'getRanking',
445455
'relevancyStrictness' => 'getRelevancyStrictness',
@@ -635,6 +645,12 @@ public function __construct(?array $data = null)
635645
if (isset($data['maxFacetHits'])) {
636646
$this->container['maxFacetHits'] = $data['maxFacetHits'];
637647
}
648+
if (isset($data['keepDiacriticsOnCharacters'])) {
649+
$this->container['keepDiacriticsOnCharacters'] = $data['keepDiacriticsOnCharacters'];
650+
}
651+
if (isset($data['customRanking'])) {
652+
$this->container['customRanking'] = $data['customRanking'];
653+
}
638654
if (isset($data['attributesToRetrieve'])) {
639655
$this->container['attributesToRetrieve'] = $data['attributesToRetrieve'];
640656
}
@@ -1951,6 +1967,54 @@ public function setMaxFacetHits($maxFacetHits)
19511967
return $this;
19521968
}
19531969

1970+
/**
1971+
* Gets keepDiacriticsOnCharacters.
1972+
*
1973+
* @return null|string
1974+
*/
1975+
public function getKeepDiacriticsOnCharacters()
1976+
{
1977+
return $this->container['keepDiacriticsOnCharacters'] ?? null;
1978+
}
1979+
1980+
/**
1981+
* Sets keepDiacriticsOnCharacters.
1982+
*
1983+
* @param null|string $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.
1984+
*
1985+
* @return self
1986+
*/
1987+
public function setKeepDiacriticsOnCharacters($keepDiacriticsOnCharacters)
1988+
{
1989+
$this->container['keepDiacriticsOnCharacters'] = $keepDiacriticsOnCharacters;
1990+
1991+
return $this;
1992+
}
1993+
1994+
/**
1995+
* Gets customRanking.
1996+
*
1997+
* @return null|string[]
1998+
*/
1999+
public function getCustomRanking()
2000+
{
2001+
return $this->container['customRanking'] ?? null;
2002+
}
2003+
2004+
/**
2005+
* Sets customRanking.
2006+
*
2007+
* @param null|string[] $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.
2008+
*
2009+
* @return self
2010+
*/
2011+
public function setCustomRanking($customRanking)
2012+
{
2013+
$this->container['customRanking'] = $customRanking;
2014+
2015+
return $this;
2016+
}
2017+
19542018
/**
19552019
* Gets attributesToRetrieve.
19562020
*

‎lib/Model/Recommend/RecommendSearchParams.php‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ class RecommendSearchParams extends AbstractModel implements ModelInterface, \Ar
6969
'customNormalization' => 'array<string,array<string,string>>',
7070
'attributeForDistinct' => 'string',
7171
'maxFacetHits' => 'int',
72+
'keepDiacriticsOnCharacters' => 'string',
73+
'customRanking' => 'string[]',
7274
'attributesToRetrieve' => 'string[]',
7375
'ranking' => 'string[]',
7476
'relevancyStrictness' => 'int',
@@ -162,6 +164,8 @@ class RecommendSearchParams extends AbstractModel implements ModelInterface, \Ar
162164
'customNormalization' => null,
163165
'attributeForDistinct' => null,
164166
'maxFacetHits' => null,
167+
'keepDiacriticsOnCharacters' => null,
168+
'customRanking' => null,
165169
'attributesToRetrieve' => null,
166170
'ranking' => null,
167171
'relevancyStrictness' => null,
@@ -256,6 +260,8 @@ class RecommendSearchParams extends AbstractModel implements ModelInterface, \Ar
256260
'customNormalization' => 'customNormalization',
257261
'attributeForDistinct' => 'attributeForDistinct',
258262
'maxFacetHits' => 'maxFacetHits',
263+
'keepDiacriticsOnCharacters' => 'keepDiacriticsOnCharacters',
264+
'customRanking' => 'customRanking',
259265
'attributesToRetrieve' => 'attributesToRetrieve',
260266
'ranking' => 'ranking',
261267
'relevancyStrictness' => 'relevancyStrictness',
@@ -349,6 +355,8 @@ class RecommendSearchParams extends AbstractModel implements ModelInterface, \Ar
349355
'customNormalization' => 'setCustomNormalization',
350356
'attributeForDistinct' => 'setAttributeForDistinct',
351357
'maxFacetHits' => 'setMaxFacetHits',
358+
'keepDiacriticsOnCharacters' => 'setKeepDiacriticsOnCharacters',
359+
'customRanking' => 'setCustomRanking',
352360
'attributesToRetrieve' => 'setAttributesToRetrieve',
353361
'ranking' => 'setRanking',
354362
'relevancyStrictness' => 'setRelevancyStrictness',
@@ -442,6 +450,8 @@ class RecommendSearchParams extends AbstractModel implements ModelInterface, \Ar
442450
'customNormalization' => 'getCustomNormalization',
443451
'attributeForDistinct' => 'getAttributeForDistinct',
444452
'maxFacetHits' => 'getMaxFacetHits',
453+
'keepDiacriticsOnCharacters' => 'getKeepDiacriticsOnCharacters',
454+
'customRanking' => 'getCustomRanking',
445455
'attributesToRetrieve' => 'getAttributesToRetrieve',
446456
'ranking' => 'getRanking',
447457
'relevancyStrictness' => 'getRelevancyStrictness',
@@ -637,6 +647,12 @@ public function __construct(?array $data = null)
637647
if (isset($data['maxFacetHits'])) {
638648
$this->container['maxFacetHits'] = $data['maxFacetHits'];
639649
}
650+
if (isset($data['keepDiacriticsOnCharacters'])) {
651+
$this->container['keepDiacriticsOnCharacters'] = $data['keepDiacriticsOnCharacters'];
652+
}
653+
if (isset($data['customRanking'])) {
654+
$this->container['customRanking'] = $data['customRanking'];
655+
}
640656
if (isset($data['attributesToRetrieve'])) {
641657
$this->container['attributesToRetrieve'] = $data['attributesToRetrieve'];
642658
}
@@ -1953,6 +1969,54 @@ public function setMaxFacetHits($maxFacetHits)
19531969
return $this;
19541970
}
19551971

1972+
/**
1973+
* Gets keepDiacriticsOnCharacters.
1974+
*
1975+
* @return null|string
1976+
*/
1977+
public function getKeepDiacriticsOnCharacters()
1978+
{
1979+
return $this->container['keepDiacriticsOnCharacters'] ?? null;
1980+
}
1981+
1982+
/**
1983+
* Sets keepDiacriticsOnCharacters.
1984+
*
1985+
* @param null|string $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.
1986+
*
1987+
* @return self
1988+
*/
1989+
public function setKeepDiacriticsOnCharacters($keepDiacriticsOnCharacters)
1990+
{
1991+
$this->container['keepDiacriticsOnCharacters'] = $keepDiacriticsOnCharacters;
1992+
1993+
return $this;
1994+
}
1995+
1996+
/**
1997+
* Gets customRanking.
1998+
*
1999+
* @return null|string[]
2000+
*/
2001+
public function getCustomRanking()
2002+
{
2003+
return $this->container['customRanking'] ?? null;
2004+
}
2005+
2006+
/**
2007+
* Sets customRanking.
2008+
*
2009+
* @param null|string[] $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.
2010+
*
2011+
* @return self
2012+
*/
2013+
public function setCustomRanking($customRanking)
2014+
{
2015+
$this->container['customRanking'] = $customRanking;
2016+
2017+
return $this;
2018+
}
2019+
19562020
/**
19572021
* Gets attributesToRetrieve.
19582022
*

‎lib/Model/Search/BrowseParams.php‎

Lines changed: 0 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
5555
'enableABTest' => 'bool',
5656
'attributesToRetrieve' => 'string[]',
5757
'ranking' => 'string[]',
58-
'customRanking' => 'string[]',
5958
'relevancyStrictness' => 'int',
6059
'attributesToHighlight' => 'string[]',
6160
'attributesToSnippet' => 'string[]',
@@ -71,7 +70,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
7170
'disableTypoToleranceOnAttributes' => 'string[]',
7271
'ignorePlurals' => '\Algolia\AlgoliaSearch\Model\Search\IgnorePlurals',
7372
'removeStopWords' => '\Algolia\AlgoliaSearch\Model\Search\RemoveStopWords',
74-
'keepDiacriticsOnCharacters' => 'string',
7573
'queryLanguages' => '\Algolia\AlgoliaSearch\Model\Search\SupportedLanguage[]',
7674
'decompoundQuery' => 'bool',
7775
'enableRules' => 'bool',
@@ -140,7 +138,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
140138
'enableABTest' => null,
141139
'attributesToRetrieve' => null,
142140
'ranking' => null,
143-
'customRanking' => null,
144141
'relevancyStrictness' => null,
145142
'attributesToHighlight' => null,
146143
'attributesToSnippet' => null,
@@ -156,7 +153,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
156153
'disableTypoToleranceOnAttributes' => null,
157154
'ignorePlurals' => null,
158155
'removeStopWords' => null,
159-
'keepDiacriticsOnCharacters' => null,
160156
'queryLanguages' => null,
161157
'decompoundQuery' => null,
162158
'enableRules' => null,
@@ -226,7 +222,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
226222
'enableABTest' => 'enableABTest',
227223
'attributesToRetrieve' => 'attributesToRetrieve',
228224
'ranking' => 'ranking',
229-
'customRanking' => 'customRanking',
230225
'relevancyStrictness' => 'relevancyStrictness',
231226
'attributesToHighlight' => 'attributesToHighlight',
232227
'attributesToSnippet' => 'attributesToSnippet',
@@ -242,7 +237,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
242237
'disableTypoToleranceOnAttributes' => 'disableTypoToleranceOnAttributes',
243238
'ignorePlurals' => 'ignorePlurals',
244239
'removeStopWords' => 'removeStopWords',
245-
'keepDiacriticsOnCharacters' => 'keepDiacriticsOnCharacters',
246240
'queryLanguages' => 'queryLanguages',
247241
'decompoundQuery' => 'decompoundQuery',
248242
'enableRules' => 'enableRules',
@@ -311,7 +305,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
311305
'enableABTest' => 'setEnableABTest',
312306
'attributesToRetrieve' => 'setAttributesToRetrieve',
313307
'ranking' => 'setRanking',
314-
'customRanking' => 'setCustomRanking',
315308
'relevancyStrictness' => 'setRelevancyStrictness',
316309
'attributesToHighlight' => 'setAttributesToHighlight',
317310
'attributesToSnippet' => 'setAttributesToSnippet',
@@ -327,7 +320,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
327320
'disableTypoToleranceOnAttributes' => 'setDisableTypoToleranceOnAttributes',
328321
'ignorePlurals' => 'setIgnorePlurals',
329322
'removeStopWords' => 'setRemoveStopWords',
330-
'keepDiacriticsOnCharacters' => 'setKeepDiacriticsOnCharacters',
331323
'queryLanguages' => 'setQueryLanguages',
332324
'decompoundQuery' => 'setDecompoundQuery',
333325
'enableRules' => 'setEnableRules',
@@ -396,7 +388,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
396388
'enableABTest' => 'getEnableABTest',
397389
'attributesToRetrieve' => 'getAttributesToRetrieve',
398390
'ranking' => 'getRanking',
399-
'customRanking' => 'getCustomRanking',
400391
'relevancyStrictness' => 'getRelevancyStrictness',
401392
'attributesToHighlight' => 'getAttributesToHighlight',
402393
'attributesToSnippet' => 'getAttributesToSnippet',
@@ -412,7 +403,6 @@ class BrowseParams extends AbstractModel implements ModelInterface, \ArrayAccess
412403
'disableTypoToleranceOnAttributes' => 'getDisableTypoToleranceOnAttributes',
413404
'ignorePlurals' => 'getIgnorePlurals',
414405
'removeStopWords' => 'getRemoveStopWords',
415-
'keepDiacriticsOnCharacters' => 'getKeepDiacriticsOnCharacters',
416406
'queryLanguages' => 'getQueryLanguages',
417407
'decompoundQuery' => 'getDecompoundQuery',
418408
'enableRules' => 'getEnableRules',
@@ -559,9 +549,6 @@ public function __construct(?array $data = null)
559549
if (isset($data['ranking'])) {
560550
$this->container['ranking'] = $data['ranking'];
561551
}
562-
if (isset($data['customRanking'])) {
563-
$this->container['customRanking'] = $data['customRanking'];
564-
}
565552
if (isset($data['relevancyStrictness'])) {
566553
$this->container['relevancyStrictness'] = $data['relevancyStrictness'];
567554
}
@@ -607,9 +594,6 @@ public function __construct(?array $data = null)
607594
if (isset($data['removeStopWords'])) {
608595
$this->container['removeStopWords'] = $data['removeStopWords'];
609596
}
610-
if (isset($data['keepDiacriticsOnCharacters'])) {
611-
$this->container['keepDiacriticsOnCharacters'] = $data['keepDiacriticsOnCharacters'];
612-
}
613597
if (isset($data['queryLanguages'])) {
614598
$this->container['queryLanguages'] = $data['queryLanguages'];
615599
}
@@ -1599,30 +1583,6 @@ public function setRanking($ranking)
15991583
return $this;
16001584
}
16011585

1602-
/**
1603-
* Gets customRanking.
1604-
*
1605-
* @return null|string[]
1606-
*/
1607-
public function getCustomRanking()
1608-
{
1609-
return $this->container['customRanking'] ?? null;
1610-
}
1611-
1612-
/**
1613-
* Sets customRanking.
1614-
*
1615-
* @param null|string[] $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.
1616-
*
1617-
* @return self
1618-
*/
1619-
public function setCustomRanking($customRanking)
1620-
{
1621-
$this->container['customRanking'] = $customRanking;
1622-
1623-
return $this;
1624-
}
1625-
16261586
/**
16271587
* Gets relevancyStrictness.
16281588
*
@@ -1983,30 +1943,6 @@ public function setRemoveStopWords($removeStopWords)
19831943
return $this;
19841944
}
19851945

1986-
/**
1987-
* Gets keepDiacriticsOnCharacters.
1988-
*
1989-
* @return null|string
1990-
*/
1991-
public function getKeepDiacriticsOnCharacters()
1992-
{
1993-
return $this->container['keepDiacriticsOnCharacters'] ?? null;
1994-
}
1995-
1996-
/**
1997-
* Sets keepDiacriticsOnCharacters.
1998-
*
1999-
* @param null|string $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.
2000-
*
2001-
* @return self
2002-
*/
2003-
public function setKeepDiacriticsOnCharacters($keepDiacriticsOnCharacters)
2004-
{
2005-
$this->container['keepDiacriticsOnCharacters'] = $keepDiacriticsOnCharacters;
2006-
2007-
return $this;
2008-
}
2009-
20101946
/**
20111947
* Gets queryLanguages.
20121948
*

0 commit comments

Comments
 (0)