Die Klasse Document
stellt ein Dokument mit durchsuchbarem Inhalt dar.
Document
ist im Modul google.appengine.api.search
definiert.
Konstruktor
Der Konstruktor für die Klasse Document
ist so definiert:
- Klasse Document(doc_id=None, fields=None, language='en', rank=None)
Konstruieren Sie eine Instanz der Klasse
Document
.Im folgenden Beispiel wird ein Dokument erstellt, das aus einer Reihe von Feldern besteht, von denen einige im Nur-Text- und andere im HTML-Format vorliegen.
from google.appengine.api import search search.Document( doc_id='documentId', fields=[search.TextField(name='subject', value='going for dinner'), search.HtmlField(name='body', value='<html>I found a place.</html>'), search.TextField(name='signature', value='brzydka pogoda', language='pl')], language='en')
Argumente
- doc_id
Die Dokument-ID, eine von Menschen lesbare ASCII-Zeichenfolge, die das Dokument identifiziert. Er darf keine Leerzeichen enthalten und nicht mit einem Ausrufezeichen (
!
) beginnen. Ohne Angabe stellt der Suchdienst einen ID-String bereit.In den meisten Fällen müssen Sie die Dokument-ID nicht explizit angeben. Die Angabe einer eigenen ID ist jedoch für die Suche mit anderen Speichermechanismen wie Blobstore oder Google Storage hilfreich. Im Fall von Blobstore können Sie zum Beispiel die Dokument-ID auf den
BlobKey
setzen, um dieses Dokument einem bestimmten Blob zuzuordnen.- fields
Eine iterierbare Sammlung von
Field
-Objekten, die den Inhalt des Dokuments darstellen.- Sprache
Ein Code mit zwei Buchstaben nach ISO 693-1 für die Sprache, in der die Feldwerte des Dokuments ausgedrückt werden.
- rank
Der Rang des Dokuments als Ganzzahl. Diese gibt die Reihenfolge an, in der das Dokument in den Suchergebnissen zurückgegeben wird. Neuere Dokumente werden zuerst zurückgegeben. Ohne sonstige Angabe des Rangs wird dieser auf die Anzahl der Sekunden seit dem 1. Januar 2011 00:00:00 UTC festgelegt. Ein Rang wird als
_rank
referenziert, wenn er in einem Feldausdruck (FieldExpression) oder Sortierausdruck (SortExpression) verwendet wird.
Ergebniswert
Eine neue Instanz der Klasse
Document
.
Ausnahmen
- TypeError
Ein Parameter hat einen ungültigen Typ oder ein unbekanntes Attribut wurde übergeben.
- ValueError
Ein Parameter hat einen ungültigen Wert.
Eigenschaften
Eine Instanz der Klasse Document
hat die folgenden Attribute:
- doc_id
Die Dokument-ID, eine von Menschen lesbare ASCII-Zeichenfolge, die das Dokument identifiziert.
- fields
Eine Liste der Felder des Dokuments.
- Sprache
Ein Code mit zwei Buchstaben nach ISO 693-1 für die Sprache, in der die Feldwerte des Dokuments ausgedrückt werden.
- rank
Der Rang des Dokuments als Ganzzahl. Diese gibt die Reihenfolge an, in der das Dokument in den Suchergebnissen zurückgegeben wird. Ein Rang wird als
_rank
referenziert, wenn er in einem Feldausdruck (FieldExpression) oder Sortierausdruck (SortExpression) verwendet wird. Wenn Sie eine SortExpression mit dem Rang als einen der Sortierschlüssel erstellen, kann der Rang nur in ABSTEIGENDER Richtung sortiert werden.