Update docs.

Author: WaVEV

docs/source/index.rst

@@ -40,6 +40,7 @@ Models
 - :doc:`ref/models/querysets`
 - :doc:`ref/models/models`
 - :doc:`ref/models/indexes`
+- :doc:`ref/models/search`
 - :doc:`ref/database`
 - :doc:`ref/contrib/gis`
 

docs/source/ref/models/search.rst

@@ -52,7 +52,7 @@ The ``path`` argument can be either the name of a field (as a string), or a
 
 The ``value`` argument must be a string or a :class:`~django.db.models.Value`.
 
-An optional ``score`` :class:`SearchScoreOption` argument to tune the
+The optional ``score`` :class:`SearchScoreOption` argument to tune the
 relevance score.
 
 ``SearchAutocomplete``
@@ -92,7 +92,9 @@ Optional arguments:
 ``SearchExists``
 ----------------
 
-Atlas Search expression that matches documents where a field exists.
+.. class:: SearchExists(path, *, score=None)
+
+Matches documents where a field exists.
 
 This expression uses the :doc:`exists operator <atlas:atlas-search/exists>`
 to check whether the specified path is present in the document. It's useful
@@ -110,14 +112,15 @@ for filtering documents that include (or exclude) optional fields.
 The ``path`` argument specifies the document path to check and can be provided
 as a string or a :class:`~django.db.models.F`.
 
-An optional :class:`SearchScoreOption` ``score`` argument can be used to
+The optional :class:`SearchScoreOption` ``score`` argument can be used to
 modify the relevance score of the result.
 
 ``SearchIn``
 ------------
 
-Atlas Search expression that matches documents where a field's value is in a
-given list.
+.. class:: SearchIn(path, value, *, score=None)
+
+Matches documents where a field's value is in a given list.
 
 This expression uses the :doc:`in operator <atlas:atlas-search/in>` to match
 documents whose field contains a value from the provided array.
@@ -135,13 +138,15 @@ The ``path`` argument can be the name of a field (as a string) or a
 :class:`~django.db.models.F`. The ``value`` must be a list
 of values or a :class:`~django.db.models.Value`.
 
-An optional ``score`` :class:`SearchScoreOption` argument to tune the
+The optional ``score`` :class:`SearchScoreOption` argument to tune the
 relevance score.
 
 ``SearchPhrase``
 ----------------
 
-Atlas Search expression that matches a phrase in the specified field.
+.. class:: SearchPhrase(path, query, *, slop=None, synonyms=None, score=None)
+
+Matches a phrase in the specified field.
 
 This expression uses the :doc:`phrase operator <atlas:atlas-search/phrase>` to
 find exact or near-exact sequences of terms. It supports optional slop
@@ -171,7 +176,9 @@ Optional arguments:
 ``SearchQueryString``
 ---------------------
 
-Atlas Search expression that matches using a Lucene-style query string.
+.. class:: SearchQueryString(path, query, *, score=None)
+
+Matches using a Lucene-style query string.
 
 This expression uses the
 :doc:`queryString operator <atlas:atlas-search/queryString>` to parse and
@@ -193,14 +200,15 @@ The ``path`` argument can be a string or a
 :class:`~django.db.models.F` representing the field to query.
 The ``query`` argument is a Lucene-style query string.
 
-An optional ``score`` :class:`SearchScoreOption` argument to tune the
+The optional ``score`` :class:`SearchScoreOption` argument to tune the
 relevance score.
 
 ``SearchRange``
 ---------------
 
-Atlas Search expression that filters documents within a specified range of
-values.
+.. class:: SearchRange(path, *, lt=None, lte=None, gt=None, gte=None, score=None)
+
+Filters documents within a specified range of values.
 
 This expression uses the :doc:`range operator <atlas:atlas-search/range>` to
 match numeric, date, or other comparable fields based on upper and/or lower
@@ -229,7 +237,9 @@ Optional arguments:
 ``SearchRegex``
 ---------------
 
-Atlas Search expression that matches string fields using a regular expression.
+.. class:: SearchRegex(path, query, *, allow_analyzed_field=None, score=None)
+
+Matches string fields using a regular expression.
 
 This expression uses the :doc:`regex operator <atlas:atlas-search/regex>` to
 apply a regular expression pattern to the contents of a specified field.
@@ -256,8 +266,10 @@ Optional arguments:
 ``SearchText``
 --------------
 
-Atlas Search expression that performs full-text search using the :doc:`text
-operator <atlas:atlas-search/text>`.
+.. class:: SearchText(path, query, *, fuzzy=None, match_criteria=None,
+    synonyms=None, score=None)
+
+Performs full-text search using the :doc:`text operator <atlas:atlas-search/text>`.
 
 This expression matches terms in the specified field and supports fuzzy
 matching, match criteria, and synonym mappings.
@@ -291,7 +303,9 @@ Optional arguments:
 ``SearchWildcard``
 ------------------
 
-Atlas Search expression that matches strings using wildcard patterns.
+.. class:: SearchWildcard(path, query, allow_analyzed_field=None, score=None)
+
+Matches strings using wildcard patterns.
 
 This expression uses the
 :doc:`wildcard operator <atlas:atlas-search/wildcard>` to search for terms
@@ -322,8 +336,9 @@ Optional arguments:
 ``SearchGeoShape``
 ------------------
 
-Atlas Search expression that filters documents based on spatial relationships
-with a geometry.
+.. class:: SearchGeoShape(path, relation, geometry, *, score=None)
+
+Filters documents based on spatial relationships with a geometry.
 
 This expression uses the
 :doc:`geoShape operator <atlas:atlas-search/geoShape>` to match documents
@@ -351,14 +366,15 @@ Required arguments:
   ``"within"``, ``"intersects"``, and ``"disjoint"``.
 - ``geometry``: A GeoJSON geometry object to compare against.
 
-An optional ``score`` :class:`SearchScoreOption` argument to tune the
+The optional ``score`` :class:`SearchScoreOption` argument to tune the
 relevance score.
 
 ``SearchGeoWithin``
 -------------------
 
-Atlas Search expression that filters documents with geo fields contained
-within a specified shape.
+.. class:: SearchGeoWithin(path, kind, geometry, *, score=None)
+
+Filters documents with geo fields contained within a specified shape.
 
 This expression uses the
 :doc:`geoWithin operator <atlas:atlas-search/geoWithin>` to match documents
@@ -384,17 +400,19 @@ Required arguments:
 - ``kind``: The GeoJSON geometry type ``circle``, ``box``, or ``geometry``.
 - ``geo_object``: The GeoJSON geometry defining the spatial boundary.
 
-An optional ``score`` :class:`SearchScoreOption` argument to tune the
+The optional ``score`` :class:`SearchScoreOption` argument to tune the
 relevance score.
 
 ``SearchMoreLikeThis``
 ----------------------
 
-Atlas Search expression that finds documents similar to the provided examples.
+.. class:: SearchMoreLikeThis(documents, *, score=None)
 
-This expression uses the
-:doc:`moreLikeThis operator <atlas:atlas-search/morelikethis>` to retrieve
-documents that resemble one or more example documents.
+Finds documents similar to the provided examples.
+
+This expression uses the :doc:`moreLikeThis operator
+<atlas:atlas-search/morelikethis>` to retrieve documents that resemble one
+or more example documents.
 
 .. code-block:: pycon
 
@@ -413,12 +431,15 @@ documents that resemble one or more example documents.
 The ``documents`` argument must be a list of example documents or expressions
 that serve as references for similarity.
 
-An optional ``score`` :class:`SearchScoreOption` argument to tune the
+The optional ``score`` :class:`SearchScoreOption` argument to tune the
 relevance score.
 
 ``CompoundExpression``
 ======================
 
+.. class:: CompoundExpression(*, must=None, must_not=None, should=None,
+    filter=None, score=None, minimum_should_match=None)
+
 Compound expression that combines multiple search clauses using boolean logic.
 
 This expression uses the :doc:`compound operator <atlas:atlas-search/compound>`
@@ -522,8 +543,11 @@ with other compound expressions.
 ``SearchVector``
 ================
 
-Atlas Search expression that performs vector similarity search using the
-:doc:`$vectorSearch stage <atlas:atlas-vector-search/vector-search-stage>`.
+.. class:: SearchVector(path, query_vector, limit, *, num_candidates=None,
+    exact=None, filter=None)
+
+Performs vector similarity search using the :doc:`$vectorSearch stage
+<atlas:atlas-vector-search/vector-search-stage>`.
 
 This expression retrieves documents whose vector field is most similar to a
 given query vector, using either approximate or exact nearest-neighbor search.
@@ -566,6 +590,8 @@ cannot be nested or composed.
 ``SearchScoreOption``
 =====================
 
+.. class:: SearchScoreOption(definitions=None)
+
 Expression used to control or mutate the relevance score in an Atlas Search
 expression.