@@ -52,6 +52,9 @@ The ``path`` argument can be either the name of a field (as a string), or a
52
52
53
53
The ``value `` argument must be a string or a :class: `~django.db.models.Value `.
54
54
55
+ An optional ``score `` :class: `SearchScoreOption ` argument to tune the
56
+ relevance score.
57
+
55
58
``SearchAutocomplete ``
56
59
----------------------
57
60
@@ -107,8 +110,8 @@ for filtering documents that include (or exclude) optional fields.
107
110
The ``path `` argument specifies the document path to check and can be provided
108
111
as a string or a :class: `~django.db.models.F `.
109
112
110
- An optional `` score `` argument can be used to modify the relevance score of
111
- the result.
113
+ An optional :class: ` SearchScoreOption ` `` score `` argument can be used to
114
+ modify the relevance score of the result.
112
115
113
116
``SearchIn ``
114
117
------------
@@ -132,7 +135,8 @@ The ``path`` argument can be the name of a field (as a string) or a
132
135
:class: `~django.db.models.F `. The ``value `` must be a list
133
136
of values or a :class: `~django.db.models.Value `.
134
137
135
- An optional ``score `` argument can be used to customize relevance scoring.
138
+ An optional ``score `` :class: `SearchScoreOption ` argument to tune the
139
+ relevance score.
136
140
137
141
``SearchPhrase ``
138
142
----------------
@@ -162,7 +166,7 @@ Optional arguments:
162
166
163
167
- ``slop ``: The maximum number of terms allowed between phrase terms.
164
168
- ``synonyms ``: The name of a synonym mapping defined in your Atlas index.
165
- - ``score ``: An optional score expression to adjust relevance.
169
+ - ``score ``: A :class: ` SearchScoreOption ` to tune the relevance score .
166
170
167
171
``SearchQueryString ``
168
172
---------------------
@@ -189,7 +193,8 @@ The ``path`` argument can be a string or a
189
193
:class: `~django.db.models.F ` representing the field to query.
190
194
The ``query `` argument is a Lucene-style query string.
191
195
192
- An optional ``score `` argument may be used to adjust relevance scoring.
196
+ An optional ``score `` :class: `SearchScoreOption ` argument to tune the
197
+ relevance score.
193
198
194
199
``SearchRange ``
195
200
---------------
@@ -219,7 +224,7 @@ Optional arguments:
219
224
- ``lte ``: Inclusive upper bound (``<= ``)
220
225
- ``gt ``: Exclusive lower bound (``> ``)
221
226
- ``gte ``: Inclusive lower bound (``>= ``)
222
- - ``score ``: An optional score expression to influence relevance
227
+ - ``score ``: A :class: ` SearchScoreOption ` to tune the relevance score.
223
228
224
229
``SearchRegex ``
225
230
---------------
@@ -246,7 +251,7 @@ Optional arguments:
246
251
247
252
- ``allow_analyzed_field ``: Boolean indicating whether to allow matching
248
253
against analyzed fields (defaults to ``False ``).
249
- - ``score ``: An optional score expression to adjust relevance.
254
+ - ``score ``: A :class: ` SearchScoreOption ` to tune the relevance score .
250
255
251
256
``SearchText ``
252
257
--------------
@@ -281,7 +286,7 @@ Optional arguments:
281
286
- ``match_criteria ``: Whether to match ``"all" `` or ``"any" `` terms (defaults
282
287
to Atlas Search behavior).
283
288
- ``synonyms ``: The name of a synonym mapping defined in your Atlas index.
284
- - ``score ``: An optional expression to influence relevance scoring .
289
+ - ``score ``: A :class: ` SearchScoreOption ` to tune the relevance score .
285
290
286
291
``SearchWildcard ``
287
292
------------------
@@ -312,7 +317,7 @@ Optional arguments:
312
317
313
318
- ``allow_analyzed_field ``: Boolean that allows matching against analyzed
314
319
fields (defaults to ``False ``).
315
- - ``score ``: An optional expression to adjust relevance.
320
+ - ``score ``: A :class: ` SearchScoreOption ` to tune the relevance score .
316
321
317
322
``SearchGeoShape ``
318
323
------------------
@@ -346,9 +351,8 @@ Required arguments:
346
351
``"within" ``, ``"intersects" ``, and ``"disjoint" ``.
347
352
- ``geometry ``: A GeoJSON geometry object to compare against.
348
353
349
- Optional:
350
-
351
- - ``score ``: An optional expression to modify the relevance score.
354
+ An optional ``score `` :class: `SearchScoreOption ` argument to tune the
355
+ relevance score.
352
356
353
357
``SearchGeoWithin ``
354
358
-------------------
@@ -380,9 +384,8 @@ Required arguments:
380
384
- ``kind ``: The GeoJSON geometry type ``circle ``, ``box ``, or ``geometry ``.
381
385
- ``geo_object ``: The GeoJSON geometry defining the spatial boundary.
382
386
383
- Optional:
384
-
385
- - ``score ``: An optional expression to adjust the relevance score.
387
+ An optional ``score `` :class: `SearchScoreOption ` argument to tune the
388
+ relevance score.
386
389
387
390
``SearchMoreLikeThis ``
388
391
----------------------
@@ -410,10 +413,8 @@ documents that resemble one or more example documents.
410
413
The ``documents `` argument must be a list of example documents or expressions
411
414
that serve as references for similarity.
412
415
413
- Optional:
414
-
415
- - ``score ``: An optional expression to adjust the relevance score of the
416
- results.
416
+ An optional ``score `` :class: `SearchScoreOption ` argument to tune the
417
+ relevance score.
417
418
418
419
``CompoundExpression ``
419
420
======================
@@ -449,7 +450,7 @@ Arguments:
449
450
relevance scoring.
450
451
- ``minimum_should_match ``: The minimum number of ``should `` clauses that
451
452
must match.
452
- - ``score ``: An optional expression to adjust the final score.
453
+ - ``score ``: A :class: ` SearchScoreOption ` to tune the relevance score.
453
454
454
455
``CompoundExpression `` is useful for building advanced and flexible query
455
456
logic in Atlas Search.
0 commit comments