La clase ScoredDocument representa un documento con puntuación devuelto de una búsqueda. Esta clase no se crea explícitamente, sino que se devuelve como resultado de Index.search().
ScoredDocument se define en el módulo google.appengine.api.search.
Constructor
El constructor de la clase MatchScorer se define de la siguiente manera:
- class ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)
Representa un documento puntuado devuelto de una búsqueda.
Argumentos
- doc_id
Cadena ASCII visible e imprimible que identifica el documento. No debe empezar por "!". Los espacios en blanco no se incluyen en los IDs. Si no se proporciona ningún ID, el servicio de búsqueda proporcionará uno.
- campos
Un objeto iterable de instancias de Field que representa el contenido del documento.
- language
El código de idioma ISO 639.2 de dos letras del idioma utilizado en los valores del campo.
- sort_scores
Lista de puntuaciones asignadas durante la evaluación de la ordenación. Se incluye cada dimensión de orden. Las puntuaciones positivas se usan para las ordenaciones ascendentes y las negativas para las descendentes.
- expresiones
Lista de campos calculados que son el resultado de las expresiones solicitadas.
- cursor
Un cursor asociado al documento.
- rank
El rango del documento se usa para especificar el orden en el que se devolverá este documento en los resultados de búsqueda, donde 0 <= rango <= sys.maxint. Si no se especifica, se usa el número de segundos transcurridos desde el 1 de enero del 2011. Los documentos se devuelven en orden descendente del ID de pedido.
Valor de resultado
Una nueva instancia de la clase
ScoredDocument.
Excepciones
- TypeError
Si alguno de los parámetros tiene un tipo no válido o se ha enviado 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
Devuelve 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 usan para las ordenaciones ascendentes y las negativas para las descendentes.
- expresiones
Lista de campos calculados que son el resultado de la evaluación de la expresión. Por ejemplo, la siguiente expresión de campo busca calcular un campo de fragmento que contenga fragmentos HTML extraídos de la coincidencia de la consulta
'good story'en el campocontent:FieldExpression(name='snippet', 'snippet("good story", content)')
ScoredDocument.expression:HtmlField(name='snippet', value='that was a good story to finish')
- cursor
Cursor asociado a un resultado que se usa como punto de partida para devolver el siguiente conjunto de resultados de búsqueda. Esta propiedad no devolverá ningún valor a menos que asigne el valor
Index.RESULT_CURSORaIndex.cursor_type. De lo contrario, la propiedad devolverá el valorNone.