Classe Document

La classe Document représente un document hébergeant du contenu pouvant faire l'objet d'une recherche.

La classe Document est définie dans le module google.appengine.api.search.

Constructeur

Le constructeur de la classe Document est défini comme suit :

class Document(doc_id=None, fields=None, language='en', rank=None)

Construire une instance de la classe Document.

L'exemple suivant illustre comment créer un document composé d'un ensemble de champs, certains en texte brut et un en HTML :

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')

Arguments

doc_id

Identifiant du document, qui est une chaîne ASCII identifiant le document et présentée dans un format lisible. Il ne doit contenir aucun caractère d'espacement, ni commencer par un point d'exclamation (!). Si cet argument est omis, le service de recherche fournira une chaîne d'identifiant.

Dans la plupart des cas, il n'est pas nécessaire de spécifier explicitement l'identifiant de document. Renseigner votre propre identifiant est toutefois utile lorsque vous souhaitez mettre en œuvre la recherche dans le cadre d'autres systèmes de stockage, tels que Blobstore ou Google Storage. Dans le cas de Blobstore, par exemple, vous pouvez définir l'identifiant de document sur la valeur BlobKey afin d'associer ce document à un blob spécifique.

fields

Collection itérable d'objets Field qui représentent le contenu du document.

language

Code ISO 693-1 à deux lettres indiquant la langue dans laquelle sont exprimées les valeurs des champs du document.

rank

Rang du document, qui est un entier spécifiant le classement du document dans les résultats de la recherche. Les documents les plus récents sont renvoyés en premier. Si cet argument n'est pas spécifié, le rang est défini comme étant le nombre de secondes écoulées depuis le 1er janvier 2011 00:00:00 UTC. Notez que lorsque le rang est utilisé dans des objets FieldExpression ou SortExpression, il est référencé sous la forme _rank.

Valeur du résultat

Nouvelle instance de la classe Document.

Exceptions

TypeError

L'un des paramètres possède un type non valide ou un attribut inconnu a été transmis.

ValueError

L'un des paramètres contient une valeur non valide.

Propriétés

Une instance de la classe Document possède les propriétés suivantes :

doc_id

Identifiant du document, qui est une chaîne ASCII identifiant le document et présentée dans un format lisible.

fields

Liste des champs du document.

language

Code ISO 693-1 à deux lettres indiquant la langue dans laquelle sont exprimées les valeurs des champs du document.

rank

Rang du document, qui est un entier spécifiant le classement du document dans les résultats de la recherche. Notez que lorsque le rang est utilisé dans des objets FieldExpression ou SortExpression, il est référencé sous la forme _rank. De même, si vous créez une SortExpression qui inclut le rang parmi les clés de tri, ce dernier ne peut être trié que dans l'ordre DESCENDING (décroissant).

Cette page vous a-t-elle été utile ? Évaluez-la :

Envoyer des commentaires concernant…

Environnement standard App Engine pour Python 2