class ScoredDocument
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
La clase ScoredDocument representa un documento puntuado que muestra una búsqueda. Esta clase no se compila de forma explícita, más bien, se muestra como resultado de Index.search().
ScoredDocument se define en el módulo google.appengine.api.search.
Constructor
El constructor para la clase MatchScorer se define de la manera siguiente:
-
class ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)
Representa un documento puntuado que muestra una búsqueda.
Argumentos
- doc_id
La string ASCII imprimible y visible que identifica el documento. No debe comenzar con “!”. Los espacios en blanco se excluyen de los ID. Si no se proporciona ninguna identificación, el servicio de búsqueda proporcionará una.
- fields
Un iterable de instancias de campo que representa el contenido del documento.
- language
El código de idioma ISO 639.2 de dos letras del idioma utilizado en los valores de campo.
- sort_scores
La lista de puntuaciones asignadas durante la evaluación de orden. Se incluye cada dimensión de orden. Las puntuaciones positivas se utilizan para los tipos ascendentes; las puntuaciones negativas para los descendentes.
- expressions
La lista de campos calculados que son el resultado de las expresiones solicitadas.
- cursor
Un cursor asociado al documento.
- rank
La clasificación del documento se usa para especificar el orden en que se mostrará este documento en los resultados de búsqueda, donde 0 <= rank <= sys.maxint. Si no se especifica, se utiliza el número de segundos desde el 1 de enero de 2011. Los documentos se muestran en orden descendente del ID del pedido.
Valor del resultado
Una instancia nueva de la clase ScoredDocument.
Excepciones
- TypeError
Si alguno de los parámetros tiene un tipo no válido o si se pasa un atributo desconocido.
- ValueError
Si algún parámetro tiene un valor no válido.
Propiedades
Una instancia de la clase ScoredDocument tiene las siguientes propiedades:
- sort_scores
Muestra la lista de puntuaciones asignadas mientras la API ordena los resultados de una búsqueda. Se incluye cada dimensión de orden. Las puntuaciones positivas se utilizan para los tipos ascendentes y las puntuaciones negativas para los descendentes.
- expressions
La lista de campos calculados es el resultado de la evaluación de la expresión. Por ejemplo, la siguiente expresión de campo busca calcular un campo de fragmento de código que contenga fragmentos de código HTML extraídos de la coincidencia de la consulta 'good story' en el campo content:
FieldExpression(name='snippet', 'snippet("good story", content)')
En el caso de esta consulta, la API mostraría el siguiente ScoredDocument.expression:
HtmlField(name='snippet', value='that was a good story to finish')
- cursor
Un cursor asociado con un resultado que se usa como punto de partida desde el que se muestra el siguiente conjunto de resultados de búsqueda. Esta propiedad no se mostrará a menos que configures el Index.cursor_type en Index.RESULT_CURSOR; de lo contrario, la propiedad muestra None.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-09-04 (UTC)
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 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`."]]
