Klasse "ScoredDocument"
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Die Klasse ScoredDocument stellt ein bewertetes Dokument dar, das von einer Suche zurückgegeben wurde. Sie erstellen diese Klasse nicht explizit. Sie wird als Ergebnis von Index.search() zurückgegeben.
ScoredDocument ist im Modul google.appengine.api.search definiert.
Konstruktor
Der Konstruktor für die Klasse MatchScorer ist so definiert:
-
class ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)
Stellt ein bewertetes Dokument dar, das von einer Suche zurückgegeben wurde.
Argumente
- doc_id
Sichtbarer, druckbarer ASCII-String, der das Dokument identifiziert. Darf nicht mit "!" Beginnen. Leerzeichen dürfen nicht in IDs verwendet werden. Wenn keine ID angegeben wird, weist der Suchdienst eine zu.
- fields
Iterable von Feldinstanzen, das den Inhalt des Dokuments darstellt.
- Sprache
Der aus zwei Buchstaben bestehende ISO 639.2-Sprachcode der Sprache, die in den Feldwerten verwendet wird.
- sort_scores
Liste der Bewertungen, die während der Sortierauswertung zugewiesen wurden. Alle Sortierdimensionen sind enthalten. Für aufsteigende Sortierungen werden positive Bewertungen und für absteigende Sortierungen negative Bewertungen verwendet.
- expressions
Liste der berechneten Felder, die das Ergebnis der angeforderten Ausdrücke sind.
- cursor
Cursor, der dem Dokument zugeordnet ist.
- rank
Der Dokumentrang wird verwendet, um die Reihenfolge anzugeben, in der dieses Dokument in den Suchergebnissen zurückgegeben wird, wobei 0 <= rank <= sys.maxint ist. Wenn nicht angegeben, wird die Anzahl der Sekunden seit dem 1. Januar 2011 verwendet. Dokumente werden in absteigender Reihenfolge der Sortier-ID zurückgegeben.
Ergebniswert
Eine neue Instanz der Klasse ScoredDocument.
Ausnahmen
- TypeError
Wenn einer der Parameter einen ungültigen Typ hat oder ein unbekanntes Attribut übergeben wird.
- ValueError
Wenn einer der Parameter einen ungültigen Wert hat.
Eigenschaften
Eine Instanz der Klasse ScoredDocument hat die folgenden Attribute:
- sort_scores
Gibt die Liste der zugewiesenen Bewertungen zurück, während die API die Ergebnisse einer Suche sortiert. Alle Sortierdimensionen sind enthalten. Für aufsteigende Sortierungen werden positive Bewertungen und für absteigende Sortierungen negative Bewertungen verwendet.
- expressions
Die Liste der berechneten Felder ist das Ergebnis der Ausdrucksbewertung. Der folgende Feldausdruck dient beispielsweise dazu, ein Snippet-Feld mit HTML-Snippets zu verarbeiten, die aus dem Abgleich der Abfrage 'good story' im Feld content extrahiert wurden:
FieldExpression(name='snippet', 'snippet("good story", content)') Bei dieser Abfrage würde die API den folgenden ScoredDocument.expression zurückgeben:
HtmlField(name='snippet', value='that was a good story to finish')
- cursor
Cursor, der einem Ergebnis zugeordnet ist und als Ausgangspunkt für die nächste Suche verwendet wird. Diese Eigenschaft gibt nur Ergebnisse zurück, wenn Sie Index.cursor_type auf Index.RESULT_CURSOR setzen. Andernfalls gibt die Eigenschaft None zurück.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-09-04 (UTC).
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-09-04 (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`."]]
