You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/extensions/SearchForHits.kt
-1
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,6 @@ public fun SearchForHits.Companion.from(
Copy file name to clipboardExpand all lines: specs/common/schemas/IndexSettings.yml
+38-29
Original file line number
Diff line number
Diff line change
@@ -283,6 +283,8 @@ baseIndexSettings:
283
283
This applies faceting _after_ deduplication, which will result in accurate facet counts.
284
284
example: url
285
285
type: string
286
+
maxFacetHits:
287
+
$ref: '#/maxFacetHits'
286
288
287
289
indexSettingsAsSearchParams:
288
290
type: object
@@ -570,33 +572,7 @@ indexSettingsAsSearchParams:
570
572
x-categories:
571
573
- Query strategy
572
574
optionalWords:
573
-
type: array
574
-
items:
575
-
type: string
576
-
example:
577
-
- blue
578
-
- iphone case
579
-
description: |
580
-
Words that should be considered optional when found in the query.
581
-
582
-
By default, records must match all words in the search query to be included in the search results.
583
-
Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words.
584
-
For example, if the search query is "action video" and "video" is an optional word,
585
-
the search engine runs two queries. One for "action video" and one for "action".
586
-
Records that match all words are ranked higher.
587
-
588
-
For a search query with 4 or more words **and** all its words are optional,
589
-
the number of matched words required for a record to be included in the search results increases for every 1,000 records:
590
-
591
-
- If `optionalWords` has less than 10 words, the required number of matched words increases by 1:
592
-
results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.
593
-
- If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).
594
-
For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.
595
-
596
-
For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
597
-
default: []
598
-
x-categories:
599
-
- Query strategy
575
+
$ref: '#/optionalWords'
600
576
disableExactOnAttributes:
601
577
type: array
602
578
items:
@@ -708,8 +684,6 @@ indexSettingsAsSearchParams:
708
684
default: ['*']
709
685
x-categories:
710
686
- Advanced
711
-
maxFacetHits:
712
-
$ref: '#/maxFacetHits'
713
687
maxValuesPerFacet:
714
688
type: integer
715
689
description: Maximum number of facet values to return for each facet.
@@ -1238,3 +1212,38 @@ booleanString:
1238
1212
enum:
1239
1213
- 'true'
1240
1214
- 'false'
1215
+
1216
+
optionalWords:
1217
+
oneOf:
1218
+
- type: string
1219
+
- type: 'null'
1220
+
- $ref: '#/optionalWordsArray'
1221
+
1222
+
optionalWordsArray:
1223
+
type: array
1224
+
items:
1225
+
type: string
1226
+
example:
1227
+
- blue
1228
+
- iphone case
1229
+
description: |
1230
+
Words that should be considered optional when found in the query.
1231
+
1232
+
By default, records must match all words in the search query to be included in the search results.
1233
+
Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words.
1234
+
For example, if the search query is "action video" and "video" is an optional word,
1235
+
the search engine runs two queries. One for "action video" and one for "action".
1236
+
Records that match all words are ranked higher.
1237
+
1238
+
For a search query with 4 or more words **and** all its words are optional,
1239
+
the number of matched words required for a record to be included in the search results increases for every 1,000 records:
1240
+
1241
+
- If `optionalWords` has less than 10 words, the required number of matched words increases by 1:
1242
+
results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.
1243
+
- If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).
1244
+
For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.
1245
+
1246
+
For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
Copy file name to clipboardExpand all lines: specs/composition/common/schemas/SearchParams.yml
+1-27
Original file line number
Diff line number
Diff line change
@@ -908,33 +908,7 @@ InsetsQueryParameters:
908
908
x-categories:
909
909
- Query strategy
910
910
optionalWords:
911
-
type: array
912
-
items:
913
-
type: string
914
-
example:
915
-
- blue
916
-
- iphone case
917
-
description: |
918
-
Words that should be considered optional when found in the query.
919
-
920
-
By default, records must match all words in the search query to be included in the search results.
921
-
Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words.
922
-
For example, if the search query is "action video" and "video" is an optional word,
923
-
the search engine runs two queries. One for "action video" and one for "action".
924
-
Records that match all words are ranked higher.
925
-
926
-
For a search query with 4 or more words **and** all its words are optional,
927
-
the number of matched words required for a record to be included in the search results increases for every 1,000 records:
928
-
929
-
- If `optionalWords` has less than 10 words, the required number of matched words increases by 1:
930
-
results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.
931
-
- If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).
932
-
For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.
933
-
934
-
For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
Copy file name to clipboardExpand all lines: templates/csharp/modelOneOf.mustache
+4-4
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@
30
30
/// Initializes a new instance of the {{classname}} class
31
31
/// with a {{#lambdaCref}}{{{dataType}}}{{/lambdaCref}}
32
32
/// </summary>
33
-
/// <paramname="actualInstance">An instance of {{dataType}}.</param>
33
+
/// <paramname="actualInstance">An instance of {{{dataType}}}.</param>
34
34
public {{classname}}({{{dataType}}} actualInstance)
35
35
{
36
36
ActualInstance = actualInstance{{^model.isNullable}}{{^isPrimitiveType}}{{^allowableValues}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/allowableValues}}{{/isPrimitiveType}}{{#isPrimitiveType}}{{#isArray}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isArray}}{{#isFreeFormObject}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isFreeFormObject}}{{#isString}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isString}}{{/isPrimitiveType}}{{/model.isNullable}};
@@ -44,7 +44,7 @@
44
44
/// Initializes a new instance of the {{classname}} class
45
45
/// with a {{#lambdaCref}}{{{dataType}}}{{/lambdaCref}}
46
46
/// </summary>
47
-
/// <paramname="actualInstance">An instance of {{dataType}}.</param>
47
+
/// <paramname="actualInstance">An instance of {{{dataType}}}.</param>
48
48
public {{classname}}(object actualInstance)
49
49
{
50
50
ActualInstance = actualInstance{{^model.isNullable}}{{^isPrimitiveType}}{{^allowableValues}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/allowableValues}}{{/isPrimitiveType}}{{#isPrimitiveType}}{{#isArray}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isArray}}{{#isFreeFormObject}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isFreeFormObject}}{{#isString}} ?? throw new ArgumentException("Invalid instance found. Must not be null."){{/isString}}{{/isPrimitiveType}}{{/model.isNullable}};
@@ -65,7 +65,7 @@
65
65
/// the InvalidClassException will be thrown{{/lambda.escape-generic}}
66
66
/// </summary>
67
67
/// <returns>An instance of {{#lambda.escape-generic}}{{dataType}}{{/lambda.escape-generic}}</returns>
68
-
public {{{dataType}}}{{#vendorExtensions.x-has-child-generic}}<T>{{/vendorExtensions.x-has-child-generic}} As{{#lambda.titlecase}}{{baseType}}{{/lambda.titlecase}}{{#lambda.titlecase}}{{{items.dataType}}}{{/lambda.titlecase}}()
68
+
public {{{dataType}}}{{#vendorExtensions.x-has-child-generic}}<T>{{/vendorExtensions.x-has-child-generic}} As{{#lambda.type-to-name}}{{{datatypeWithEnum}}}{{/lambda.type-to-name}}()
Copy file name to clipboardExpand all lines: templates/javascript/clients/algoliasearch/builds/models.mustache
+28-22
Original file line number
Diff line number
Diff line change
@@ -40,8 +40,8 @@ import type {
40
40
CustomGetProps,
41
41
CustomPostProps,
42
42
CustomPutProps,
43
-
DeleteSourceProps,
44
43
DeletedAtResponse,
44
+
DeleteSourceProps,
45
45
Distinct,
46
46
Edit,
47
47
EditType,
@@ -50,19 +50,21 @@ import type {
50
50
Exhaustive,
51
51
FacetFilters,
52
52
FacetOrdering,
53
-
FacetStats,
54
53
Facets,
54
+
FacetStats,
55
55
GetTaskProps,
56
56
HighlightResult,
57
57
HighlightResultOption,
58
58
IgnorePlurals,
59
59
IndexSettingsAsSearchParams,
60
+
InsideBoundingBox,
60
61
Languages,
61
-
MatchLevel,
62
62
MatchedGeoLocation,
63
+
MatchLevel,
63
64
Mode,
64
65
NumericFilters,
65
66
OptionalFilters,
67
+
OptionalWords,
66
68
Params,
67
69
Personalization,
68
70
Promote,
@@ -71,14 +73,14 @@ import type {
71
73
QueryType,
72
74
Range,
73
75
RankingInfo,
74
-
ReRankingApplyFilter,
75
76
Redirect,
76
77
RedirectRuleIndexData,
77
78
RedirectRuleIndexMetadata,
78
79
RedirectURL,
79
80
RemoveStopWords,
80
81
RemoveWordsIfNoResults,
81
82
RenderingContent,
83
+
ReRankingApplyFilter,
82
84
SearchPagination,
83
85
SearchParams,
84
86
SearchParamsObject,
@@ -105,14 +107,25 @@ import type {
105
107
EventType,
106
108
} from '@algolia/client-personalization';
107
109
108
-
type Region = {{#dependencies}} {{#dependencyHasRegionalHosts}}{{^-first}}|{{/-first}}{{#lambda.titlecase}}{{{dependencyName}}}Region{{/lambda.titlecase}} {{/dependencyHasRegionalHosts}}{{/dependencies}};
109
-
type RegionOptions = {{#dependencies}} {{#dependencyHasRegionalHosts}}{{^-first}}|{{/-first}}{{#lambda.titlecase}}{{{dependencyName}}}RegionOptions{{/lambda.titlecase}} {{/dependencyHasRegionalHosts}}{{/dependencies}};
110
-
111
110
{{#dependencies}}
112
111
export * from '{{{dependencyPackage}}}';
113
112
{{/dependencies}}
114
113
export * from '@algolia/client-search';
115
114
115
+
export type Region = {{#dependencies}} {{#dependencyHasRegionalHosts}}{{^-first}}|{{/-first}}{{#lambda.titlecase}}{{{dependencyName}}}Region{{/lambda.titlecase}} {{/dependencyHasRegionalHosts}}{{/dependencies}};
116
+
export type RegionOptions = {{#dependencies}} {{#dependencyHasRegionalHosts}}{{^-first}}|{{/-first}}{{#lambda.titlecase}}{{{dependencyName}}}RegionOptions{{/lambda.titlecase}} {{/dependencyHasRegionalHosts}}{{/dependencies}};
0 commit comments