Classe ScoredDocument

La classe ScoredDocument représente un document noté, renvoyé d'une recherche. Cette classe n'est pas construite explicitement, mais renvoyée en tant que résultat de l'appel à Index.search().

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

Constructeur

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

class ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)

Représente un document noté, renvoyé d'une recherche.

Arguments

doc_id

Chaîne ASCII visible et imprimable identifiant le document. Ne doit pas commencer par "!". Les espaces blancs sont exclus des identifiants. Si aucun identifiant n'est fourni, le service de recherche en fournit un.

fields

Valeur itérable d'instances de champ représentant le contenu du document.

language

Code de langue ISO 639.2 à deux lettres de la langue utilisée dans les valeurs de champ.

sort_scores

Liste des scores attribués lors de l'évaluation du tri. Chaque dimension de tri est incluse. Les scores positifs sont appliqués aux tris croissants et les scores négatifs aux tris décroissants.

expressions

Liste des champs calculés constituant le résultat des expressions demandées.

cursor

Curseur associé au document.

rank

Le rang du document permet de spécifier le classement du document dans les résultats de la recherche, où "0 <= rank <= sys.maxint". Si non spécifié, le nombre de secondes écoulées depuis le 1er janvier 2011 est utilisé. Les documents sont renvoyés par ID de classement par ordre décroissant.

Result value

Nouvelle instance de la classe ScoredDocument.

Exceptions

TypeError

Si l'un des paramètres contient un type non valide ou si un attribut inconnu est transmis.

ValueError

Si un paramètre contient une valeur non valide.

Propriétés

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

sort_scores

Renvoie la liste des scores attribués lors du tri des résultats d'une recherche par l'API. Chaque dimension de tri est incluse. Les scores positifs sont appliqués aux tris croissants et les scores négatifs aux tris décroissants.

expressions

Liste des champs calculés constituant le résultat de l'évaluation d'une expression. Par exemple, l'expression de champ suivante cherche à calculer un champ d'extrait de code contenant des extraits de code HTML issus de la correspondance de la requête 'good story' dans le champ content : 

FieldExpression(name='snippet', 'snippet("good story", content)')
Pour cette requête, l'API affiche l'élément ScoredDocument.expression suivant :
HtmlField(name='snippet', value='that was a good story to finish')

cursor

Curseur associé à un résultat utilisé comme point de départ pour le renvoi du prochain ensemble de résultats de recherche. Cette propriété ne sera renvoyée que si vous définissez le paramètre Index.cursor_type sur Index.RESULT_CURSOR. Sinon, la propriété renvoyée sera None.