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 ScoredDocument
Stay organized with collections
Save and categorize content based on your preferences.
Class ScoredDocument represents a scored document returned from a search. You do not build this class explicitly; rather, it is returned as a result of Index.search().
ScoredDocument is defined in the google.appengine.api.search module.
Constructor
The constructor for class MatchScorer is defined as follows:
-
class ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)
Represents a scored document returned from a search.
Arguments
- doc_id
The visible, printable ASCII string identifying the document. Must not begin with '!'. Whitespace is excluded from ids. If no id is provided, the search service will provide one.
- fields
An iterable of Field instances representing the content of the document.
- language
The two-letter ISO 639.2 language code of the language used in the field values.
- sort_scores
The list of scores assigned during sort evaluation. Each sort dimension is included. Positive scores are used for ascending sorts; negative scores for descending.
- expressions
The list of computed fields which are the result of expressions requested.
- cursor
A cursor associated with the document.
- rank
The document rank is used to specify the order this document will be returned in search results, where 0 <= rank <= sys.maxint. If not specified, the number of seconds since 1st Jan 2011 is used. Documents are returned in descending order of the order ID.
Result value
A new instance of class ScoredDocument.
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.
Properties
An instance of class ScoredDocument has the following properties:
- sort_scores
Returns the list of scores assigned while the API is sorting the results of a search. Each sort dimension is included. Positive scores are used for ascending sorts and negative scores for descending.
- expressions
The list of computed fields the result of expression evaluation. For example, the following field expression seeks to compute a snippet field containing HTML snippets extracted from the matching of the query 'good story' in the content field:
FieldExpression(name='snippet', 'snippet("good story", content)')
Given this query, the API would return the following ScoredDocument.expression:
HtmlField(name='snippet', value='that was a good story to finish')
- cursor
A cursor associated with a result used as a starting point from which to return the next set of search results. This property will not return unless you set the Index.cursor_type to Index.RESULT_CURSOR; otherwise the property returns be None.
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\u003eScoredDocument\u003c/code\u003e class represents a scored document returned from a search operation and is not manually constructed but rather received as a result from \u003ccode\u003eIndex.search()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIt includes properties such as \u003ccode\u003edoc_id\u003c/code\u003e, \u003ccode\u003efields\u003c/code\u003e, \u003ccode\u003elanguage\u003c/code\u003e, \u003ccode\u003esort_scores\u003c/code\u003e, \u003ccode\u003eexpressions\u003c/code\u003e, \u003ccode\u003ecursor\u003c/code\u003e, and \u003ccode\u003erank\u003c/code\u003e which provide details about the document and its ranking.\u003c/p\u003e\n"],["\u003cp\u003eThe class allows the retrieval of scores generated during the sorting process (\u003ccode\u003esort_scores\u003c/code\u003e), computed fields from requested expressions (\u003ccode\u003eexpressions\u003c/code\u003e), and a cursor for paginated results (\u003ccode\u003ecursor\u003c/code\u003e) if configured.\u003c/p\u003e\n"],["\u003cp\u003eIf no \u003ccode\u003edoc_id\u003c/code\u003e is specified, one will be assigned by the search service.\u003c/p\u003e\n"],["\u003cp\u003eThe document's \u003ccode\u003erank\u003c/code\u003e property determines the order in which it appears in search results, with a higher \u003ccode\u003erank\u003c/code\u003e meaning the document is returned earlier in the results.\u003c/p\u003e\n"]]],[],null,["# class ScoredDocument\n\nClass `ScoredDocument` represents a scored document returned from a search. You do not build this class explicitly; rather, it is returned as a result of [Index.search()](/appengine/docs/legacy/standard/python/search/indexclass).\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\n`ScoredDocument` is defined in the `google.appengine.api.search` module.\n\nConstructor\n-----------\n\nThe constructor for class `MatchScorer` is defined as follows:\n\n\nclass ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)\n\n:\n\n Represents a scored document returned from a search.\n\n \u003cbr /\u003e\n\n:\n\n Arguments\n\n doc_id\n\n : The visible, printable ASCII string identifying the document. Must not begin with '!'. Whitespace is excluded from ids. If no id is provided, the search service will provide one.\n\n fields\n\n : An iterable of Field instances representing the content of the document.\n\n language\n\n : The two-letter [ISO 639.2 language code](http://www.loc.gov/standards/iso639-2/php/code_list.php) of the language used in the field values.\n\n sort_scores\n\n : The list of scores assigned during sort evaluation. Each sort dimension is included. Positive scores are used for ascending sorts; negative scores for descending.\n\n expressions\n\n : The list of computed fields which are the result of expressions requested.\n\n cursor\n\n : A cursor associated with the document.\n\n rank\n\n : The document rank is used to specify the order this document will be returned in search results, where 0 \\\u003c= rank \\\u003c= sys.maxint. If not specified, the number of seconds since 1st Jan 2011 is used. Documents are returned in descending order of the order ID.\n\n Result value\n\n : A new instance of class `ScoredDocument`.\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\n\nProperties\n----------\n\nAn instance of class `ScoredDocument` has the following properties:\n\nsort_scores\n\n: Returns the list of scores assigned while the API is sorting the results of a search. Each sort dimension is included. Positive scores are used for ascending sorts and negative scores for descending.\n\nexpressions\n\n: The list of computed fields the result of expression evaluation. For example, the following [field expression](/appengine/docs/legacy/standard/python/search/fieldexpressionclass) seeks to compute a snippet field containing HTML snippets extracted from the matching of the query `'good story'` in the `content` field:\n\n ```python\n FieldExpression(name='snippet', 'snippet(\"good story\", content)')\n ```\n Given this query, the API would return the following `ScoredDocument.expression`: \n\n ```python\n HtmlField(name='snippet', value='that was a good story to finish')\n ```\n\n \u003cbr /\u003e\n\ncursor\n\n: A cursor associated with a result used as a starting point from which to return the next set of search results. This property will not return unless you set the `Index.cursor_type` to `Index.RESULT_CURSOR`; otherwise the property returns be `None`."]]
