Nota: Python 2.7 alcanzó el fin de la asistencia el 31 de enero de 2024. Tus aplicaciones existentes de Python 2.7 seguirán ejecutándose y recibiendo tráfico. Sin embargo, App Engine podría bloquear la reimplementación de aplicaciones que usan entornos de ejecución después de la fecha de finalización de la asistencia. Te recomendamos que migres a la última versión compatible de Python.

class ScoredDocument

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.