Skip to content

Commit 9aa65f2

Browse files
committed
Fix score parameter text in docs
1 parent ee93d10 commit 9aa65f2

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

docs/source/ref/models/search.rst

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ The ``path`` argument can be either the name of a field (as a string), or a
5252

5353
The ``value`` argument must be a string or a :class:`~django.db.models.Value`.
5454

55+
An optional ``score`` :class:`SearchScoreOption` argument to tune the
56+
relevance score.
57+
5558
``SearchAutocomplete``
5659
----------------------
5760

@@ -107,8 +110,8 @@ for filtering documents that include (or exclude) optional fields.
107110
The ``path`` argument specifies the document path to check and can be provided
108111
as a string or a :class:`~django.db.models.F`.
109112

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.
112115

113116
``SearchIn``
114117
------------
@@ -132,7 +135,8 @@ The ``path`` argument can be the name of a field (as a string) or a
132135
:class:`~django.db.models.F`. The ``value`` must be a list
133136
of values or a :class:`~django.db.models.Value`.
134137

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.
136140

137141
``SearchPhrase``
138142
----------------
@@ -162,7 +166,7 @@ Optional arguments:
162166

163167
- ``slop``: The maximum number of terms allowed between phrase terms.
164168
- ``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.
166170

167171
``SearchQueryString``
168172
---------------------
@@ -189,7 +193,8 @@ The ``path`` argument can be a string or a
189193
:class:`~django.db.models.F` representing the field to query.
190194
The ``query`` argument is a Lucene-style query string.
191195

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.
193198

194199
``SearchRange``
195200
---------------
@@ -219,7 +224,7 @@ Optional arguments:
219224
- ``lte``: Inclusive upper bound (``<=``)
220225
- ``gt``: Exclusive lower bound (``>``)
221226
- ``gte``: Inclusive lower bound (``>=``)
222-
- ``score``: An optional score expression to influence relevance
227+
- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
223228

224229
``SearchRegex``
225230
---------------
@@ -246,7 +251,7 @@ Optional arguments:
246251

247252
- ``allow_analyzed_field``: Boolean indicating whether to allow matching
248253
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.
250255

251256
``SearchText``
252257
--------------
@@ -281,7 +286,7 @@ Optional arguments:
281286
- ``match_criteria``: Whether to match ``"all"`` or ``"any"`` terms (defaults
282287
to Atlas Search behavior).
283288
- ``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.
285290

286291
``SearchWildcard``
287292
------------------
@@ -312,7 +317,7 @@ Optional arguments:
312317

313318
- ``allow_analyzed_field``: Boolean that allows matching against analyzed
314319
fields (defaults to ``False``).
315-
- ``score``: An optional expression to adjust relevance.
320+
- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
316321

317322
``SearchGeoShape``
318323
------------------
@@ -346,9 +351,8 @@ Required arguments:
346351
``"within"``, ``"intersects"``, and ``"disjoint"``.
347352
- ``geometry``: A GeoJSON geometry object to compare against.
348353

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.
352356

353357
``SearchGeoWithin``
354358
-------------------
@@ -380,9 +384,8 @@ Required arguments:
380384
- ``kind``: The GeoJSON geometry type ``circle``, ``box``, or ``geometry``.
381385
- ``geo_object``: The GeoJSON geometry defining the spatial boundary.
382386

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.
386389

387390
``SearchMoreLikeThis``
388391
----------------------
@@ -410,10 +413,8 @@ documents that resemble one or more example documents.
410413
The ``documents`` argument must be a list of example documents or expressions
411414
that serve as references for similarity.
412415

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.
417418

418419
``CompoundExpression``
419420
======================
@@ -449,7 +450,7 @@ Arguments:
449450
relevance scoring.
450451
- ``minimum_should_match``: The minimum number of ``should`` clauses that
451452
must match.
452-
- ``score``: An optional expression to adjust the final score.
453+
- ``score``: A :class:`SearchScoreOption` to tune the relevance score.
453454

454455
``CompoundExpression`` is useful for building advanced and flexible query
455456
logic in Atlas Search.

0 commit comments

Comments
 (0)