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-03-05 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-03-05 UTC."],[[["The `MatchScorer` class allows sorting of documents based on the quality of their match to a query by assigning a score based on term frequency."],["Adding `MatchScorer` to `SortOptions` sorts documents in descending score order, resulting in positive scores."],["To sort in ascending order, use `MatchScorer` within `SortOptions` with a `SortExpression` set to `ASCENDING`, which results in negative scores."],["The `MatchScorer` class is in the `google.appengine.api.search` module, and if an invalid type or value is passed as parameters, a `TypeError` or `ValueError` will be raised."]]],[]]
