Klasse "ScoredDocument"

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.