Classe ScoredDocument
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/04 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 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`."]]
