Skip to content

Commit 76aa67c

Browse files
authored
Merge branch 'main' into feat/javascript-algoliasearch-add-packages
2 parents a2498cf + 542b24e commit 76aa67c

File tree

99 files changed

+248
-235
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+248
-235
lines changed

.github/workflows/check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
runs-on: ubuntu-22.04
4242
timeout-minutes: 10
4343
env:
44-
CACHE_VERSION: 1 # bump this to run all clients on the CI.
44+
CACHE_VERSION: 1.01 # bump this to run all clients on the CI.
4545
steps:
4646
- name: debugging - dump GitHub context
4747
env:

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/FallbackParams.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,9 +267,9 @@ public FallbackParams()
267267
public List<string> UnretrievableAttributes { get; set; }
268268

269269
/// <summary>
270-
/// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
270+
/// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
271271
/// </summary>
272-
/// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
272+
/// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
273273
[JsonPropertyName("disableTypoToleranceOnWords")]
274274
public List<string> DisableTypoToleranceOnWords { get; set; }
275275

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendHit.cs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,9 @@ public RecommendHit()
2828
/// Initializes a new instance of the RecommendHit class.
2929
/// </summary>
3030
/// <param name="objectID">Unique record identifier. (required).</param>
31-
/// <param name="score">Recommendation score. (required).</param>
32-
public RecommendHit(string objectID, double score)
31+
public RecommendHit(string objectID)
3332
{
3433
ObjectID = objectID ?? throw new ArgumentNullException(nameof(objectID));
35-
Score = score;
3634
AdditionalProperties = new Dictionary<string, object>();
3735
}
3836

@@ -74,7 +72,7 @@ public RecommendHit(string objectID, double score)
7472
/// </summary>
7573
/// <value>Recommendation score.</value>
7674
[JsonPropertyName("_score")]
77-
public double Score { get; set; }
75+
public double? Score { get; set; }
7876

7977
/// <summary>
8078
/// Gets or Sets additional properties

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendSearchParams.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,9 +267,9 @@ public RecommendSearchParams()
267267
public List<string> UnretrievableAttributes { get; set; }
268268

269269
/// <summary>
270-
/// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
270+
/// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
271271
/// </summary>
272-
/// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
272+
/// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
273273
[JsonPropertyName("disableTypoToleranceOnWords")]
274274
public List<string> DisableTypoToleranceOnWords { get; set; }
275275

clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/TrendingFacetHit.cs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,10 @@ public TrendingFacetHit() { }
2424
/// <summary>
2525
/// Initializes a new instance of the TrendingFacetHit class.
2626
/// </summary>
27-
/// <param name="score">Recommendation score. (required).</param>
2827
/// <param name="facetName">Facet attribute. To be used in combination with &#x60;facetValue&#x60;. If specified, only recommendations matching the facet filter will be returned. (required).</param>
2928
/// <param name="facetValue">Facet value. To be used in combination with &#x60;facetName&#x60;. If specified, only recommendations matching the facet filter will be returned. (required).</param>
30-
public TrendingFacetHit(double score, string facetName, string facetValue)
29+
public TrendingFacetHit(string facetName, string facetValue)
3130
{
32-
Score = score;
3331
FacetName = facetName ?? throw new ArgumentNullException(nameof(facetName));
3432
FacetValue = facetValue ?? throw new ArgumentNullException(nameof(facetValue));
3533
}
@@ -39,7 +37,7 @@ public TrendingFacetHit(double score, string facetName, string facetValue)
3937
/// </summary>
4038
/// <value>Recommendation score.</value>
4139
[JsonPropertyName("_score")]
42-
public double Score { get; set; }
40+
public double? Score { get; set; }
4341

4442
/// <summary>
4543
/// Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.

clients/algoliasearch-client-csharp/algoliasearch/Models/Search/IndexSettings.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ public IndexSettings()
7676
public List<string> UnretrievableAttributes { get; set; }
7777

7878
/// <summary>
79-
/// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
79+
/// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
8080
/// </summary>
81-
/// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
81+
/// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
8282
[JsonPropertyName("disableTypoToleranceOnWords")]
8383
public List<string> DisableTypoToleranceOnWords { get; set; }
8484

clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SettingsResponse.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ public SettingsResponse()
7676
public List<string> UnretrievableAttributes { get; set; }
7777

7878
/// <summary>
79-
/// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
79+
/// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
8080
/// </summary>
81-
/// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
81+
/// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
8282
[JsonPropertyName("disableTypoToleranceOnWords")]
8383
public List<string> DisableTypoToleranceOnWords { get; set; }
8484

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/base_index_settings.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ final class BaseIndexSettings {
4646
@JsonKey(name: r'unretrievableAttributes')
4747
final List<String>? unretrievableAttributes;
4848

49-
/// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
49+
/// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
5050
@JsonKey(name: r'disableTypoToleranceOnWords')
5151
final List<String>? disableTypoToleranceOnWords;
5252

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/fallback_params.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ final class FallbackParams {
255255
@JsonKey(name: r'unretrievableAttributes')
256256
final List<String>? unretrievableAttributes;
257257

258-
/// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
258+
/// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
259259
@JsonKey(name: r'disableTypoToleranceOnWords')
260260
final List<String>? disableTypoToleranceOnWords;
261261

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/index_settings.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ final class IndexSettings {
9898
@JsonKey(name: r'unretrievableAttributes')
9999
final List<String>? unretrievableAttributes;
100100

101-
/// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
101+
/// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
102102
@JsonKey(name: r'disableTypoToleranceOnWords')
103103
final List<String>? disableTypoToleranceOnWords;
104104

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/recommend_hit.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ final class RecommendHit extends DelegatingMap<String, dynamic> {
1616
this.snippetResult,
1717
this.rankingInfo,
1818
this.distinctSeqID,
19-
required this.score,
19+
this.score,
2020
Map<String, dynamic> additionalProperties = const {},
2121
}) : super(additionalProperties);
2222

@@ -42,7 +42,7 @@ final class RecommendHit extends DelegatingMap<String, dynamic> {
4242
// minimum: 0
4343
// maximum: 100
4444
@JsonKey(name: r'_score')
45-
final double score;
45+
final double? score;
4646

4747
@override
4848
bool operator ==(Object other) =>

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/recommend_hit.g.dart

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/recommend_index_settings.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ final class RecommendIndexSettings {
9191
@JsonKey(name: r'unretrievableAttributes')
9292
final List<String>? unretrievableAttributes;
9393

94-
/// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
94+
/// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
9595
@JsonKey(name: r'disableTypoToleranceOnWords')
9696
final List<String>? disableTypoToleranceOnWords;
9797

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/recommend_search_params.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ final class RecommendSearchParams {
255255
@JsonKey(name: r'unretrievableAttributes')
256256
final List<String>? unretrievableAttributes;
257257

258-
/// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
258+
/// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
259259
@JsonKey(name: r'disableTypoToleranceOnWords')
260260
final List<String>? disableTypoToleranceOnWords;
261261

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/settings_response.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ final class SettingsResponse {
9999
@JsonKey(name: r'unretrievableAttributes')
100100
final List<String>? unretrievableAttributes;
101101

102-
/// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
102+
/// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
103103
@JsonKey(name: r'disableTypoToleranceOnWords')
104104
final List<String>? disableTypoToleranceOnWords;
105105

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/trending_facet_hit.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ part 'trending_facet_hit.g.dart';
99
final class TrendingFacetHit {
1010
/// Returns a new [TrendingFacetHit] instance.
1111
const TrendingFacetHit({
12-
required this.score,
12+
this.score,
1313
required this.facetName,
1414
required this.facetValue,
1515
});
@@ -18,7 +18,7 @@ final class TrendingFacetHit {
1818
// minimum: 0
1919
// maximum: 100
2020
@JsonKey(name: r'_score')
21-
final double score;
21+
final double? score;
2222

2323
/// Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
2424
@JsonKey(name: r'facetName')

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/trending_facet_hit.g.dart

Lines changed: 15 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)