Python 2.7 has reached end of support
and will be deprecated
on January 31, 2026. After deprecation, you won't be able to deploy Python 2.7
applications, even if your organization previously used an organization policy to
re-enable deployments of legacy runtimes. Your existing Python
2.7 applications will continue to run and receive traffic after their deprecation date
. We recommend that
you migrate to the latest supported version of Python
.
class MatchScorer
Stay organized with collections
Save and categorize content based on your preferences.
Class MatchScorer
allows you to sort documents based on the quality
of query match. The scorer assigns a score based on term frequency in a document.
To use a MatchScorer
, add it to the SortOptions
as in the following code:
sort_opts
=
search
.
SortOptions
(
match_scorer
=
search
.
MatchScorer
())
This sorts the documents in descending score order. The scores will be
positive.
If you want to sort in ascending order, then use the following code:
sort_opts
=
search
.
SortOptions
(
match_scorer
=
search
.
MatchScorer
(),
expressions
=
[
search
.
SortExpression
(
expression
=
'_score'
,
direction
=
search
.
SortExpression
.
ASCENDING
,
default_value
=
0.0
)])
The scores in this case will be negative.
MatchScorer
is defined in the google.appengine.api.search
module.
Constructor
The constructor for class MatchScorer
is defined as follows:
- class
MatchScorer
()
-
Assigns a document score to search results representing how well they match the query, base on frequency of terms in the document.
Result value
-
A new instance of class MatchScorer
.
Exceptions
- TypeError
-
If any of the parameters have an invalid type, or an unknown attribute is passed.
- ValueError
-
If any parameter has an invalid value.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eMatchScorer\u003c/code\u003e class allows sorting of documents based on the quality of their match to a query by assigning a score based on term frequency.\u003c/p\u003e\n"],["\u003cp\u003eAdding \u003ccode\u003eMatchScorer\u003c/code\u003e to \u003ccode\u003eSortOptions\u003c/code\u003e sorts documents in descending score order, resulting in positive scores.\u003c/p\u003e\n"],["\u003cp\u003eTo sort in ascending order, use \u003ccode\u003eMatchScorer\u003c/code\u003e within \u003ccode\u003eSortOptions\u003c/code\u003e with a \u003ccode\u003eSortExpression\u003c/code\u003e set to \u003ccode\u003eASCENDING\u003c/code\u003e, which results in negative scores.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eMatchScorer\u003c/code\u003e class is in the \u003ccode\u003egoogle.appengine.api.search\u003c/code\u003e module, and if an invalid type or value is passed as parameters, a \u003ccode\u003eTypeError\u003c/code\u003e or \u003ccode\u003eValueError\u003c/code\u003e will be raised.\u003c/p\u003e\n"]]],[],null,["# class MatchScorer\n\nClass `MatchScorer` allows you to sort documents based on the quality of query match. The scorer assigns a score based on term frequency in a document.\n\n\u003cbr /\u003e\n\n| This API is supported for first-generation runtimes and can be used when [upgrading to corresponding second-generation runtimes](/appengine/docs/standard/\n| python3\n|\n| /services/access). If you are updating to the App Engine Python 3 runtime, refer to the [migration guide](/appengine/migration-center/standard/migrate-to-second-gen/python-differences) to learn about your migration options for legacy bundled services.\n\nTo use a `MatchScorer`, add it to the `SortOptions` as in the following code: \n\n```python\n sort_opts = search.SortOptions(match_scorer=search.MatchScorer())\n```\n\nThis sorts the documents in descending score order. The scores will be\npositive.\n\nIf you want to sort in ascending order, then use the following code: \n\n```python\n sort_opts = search.SortOptions(match_scorer=search.MatchScorer(),\n expressions=[search.SortExpression(\n expression='_score', direction=search.SortExpression.ASCENDING,\n default_value=0.0)])\n```\n\nThe scores in this case will be negative.\n\n`MatchScorer` is defined in the `google.appengine.api.search` module.\n\nConstructor\n-----------\n\nThe constructor for class `MatchScorer` is defined as follows:\n\nclass MatchScorer()\n\n: Assigns a document score to search results representing how well they match the query, base on frequency of terms in the document.\n\n Result value\n\n : A new instance of class `MatchScorer`.\n\n Exceptions\n\n TypeError\n\n : If any of the parameters have an invalid type, or an unknown attribute is passed.\n\n ValueError\n\n : If any parameter has an invalid value.\n\n \u003cbr /\u003e"]]
