La classe ScoredDocument
rappresenta un documento con punteggio restituito da una ricerca. Non crei esplicitamente questa classe, ma viene restituita come risultato di Index.search()
.
ScoredDocument
è definito nel modulo google.appengine.api.search
.
Costruttore
Il costruttore per la classe MatchScorer
è definito come segue:
- class ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expression=Nessuna, trigger=None, rank=Nessuna
Rappresenta un documento con punteggio restituito da una ricerca.
Argomenti
- id_doc
La stringa ASCII visibile e stampabile che identifica il documento. Non deve iniziare con '!'. Lo spazio vuoto è escluso dagli ID. Se non viene fornito un ID, il servizio di ricerca ne fornirà uno.
- campi
Un'iterabile di istanze di campo che rappresentano il contenuto del documento.
- language [lingua]
Il codice lingua ISO 639.2 di due lettere della lingua utilizzata nei valori dei campi.
- sort_scores
L'elenco di punteggi assegnati durante la valutazione ordinata. Ogni dimensione di ordinamento è inclusa. I punteggi positivi vengono utilizzati per ordinamenti ascendenti; i punteggi negativi per l'ordine decrescente.
- espressioni
L'elenco di campi calcolati che sono il risultato delle espressioni richieste.
- asterisco
Un cursore associato al documento.
- rank
Il ranking del documento viene utilizzato per specificare l'ordine in cui il documento verrà restituito nei risultati di ricerca, dove 0 <= ranking <= sys.maxint. Se non specificato, viene utilizzato il numero di secondi dal 1 gennaio 2011. I documenti vengono restituiti in ordine decrescente dell'ID ordine.
Valore risultato
Una nuova istanza di classe
ScoredDocument
.
Eccezioni
- Errore di tipo
Se un parametro ha un tipo non valido o viene trasmesso un attributo sconosciuto.
- ValoreErrore
Se un parametro contiene un valore non valido.
Proprietà
Un'istanza di classe ScoredDocument
ha le seguenti proprietà:
- sort_scores
Restituisce l'elenco di punteggi assegnati mentre l'API ordina i risultati di una ricerca. Ogni dimensione di ordinamento è inclusa. I punteggi positivi vengono utilizzati per ordinamenti ascendenti e quelli negativi per discendenti.
- espressioni
L'elenco dei campi calcolati risultato della valutazione delle espressioni. Ad esempio, la seguente espressione campo cerca di calcolare un campo snippet contenente snippet HTML estratti dalla corrispondenza della query
'good story'
nel campocontent
:FieldExpression(name='snippet', 'snippet("good story", content)')
Dato questa query, l'API restituisce il seguenteScoredDocument.expression
:HtmlField(name='snippet', value='that was a good story to finish')
- asterisco
Un cursore associato a un risultato utilizzato come punto iniziale da cui restituire il set successivo di risultati di ricerca. Questa proprietà non restituisce alcun valore, a meno che non imposti
Index.cursor_type
suIndex.RESULT_CURSOR
, altrimenti restituisce la proprietàNone
.