La classe ScoredDocument rappresenta un documento con punteggio restituito da una ricerca. Non devi creare questa classe esplicitamente; viene restituita come risultato di Index.search().
ScoredDocument è definito nel modulo google.appengine.api.search.
Costruttore
Il costruttore della classe MatchScorer è definito come segue:
- class ScoredDocument(doc_id=None, fields=None, language='it', sort_scores=None, expressions=None, cursor=None, rank=None)
Rappresenta un documento con punteggio restituito da una ricerca.
Argomenti
- doc_id
La stringa ASCII visibile e stampabile che identifica il documento. Non deve iniziare con "!". Gli spazi vuoti sono esclusi dagli ID. Se non viene fornito alcun ID, il servizio di ricerca ne fornirà uno.
- fields
Un iterable di istanze di Field che rappresentano i contenuti del documento.
- language
Il codice lingua ISO 639.2 di due lettere della lingua utilizzata nei valori di campo.
- sort_scores
L'elenco dei punteggi assegnati durante la valutazione dell'ordinamento. È inclusa ogni dimensione di ordinamento. I punteggi positivi vengono utilizzati per le selezioni in ordine crescente, mentre quelli negativi per quelle in ordine decrescente.
- espressioni
L'elenco dei campi calcolati che sono il risultato delle espressioni richieste.
- cursor
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 del risultato
Una nuova istanza della classe
ScoredDocument.
Eccezioni
- TypeError
Se uno dei parametri ha un tipo non valido o viene passato un attributo sconosciuto.
- ValueError
Se un parametro ha un valore non valido.
Proprietà
Un'istanza della classe ScoredDocument ha le seguenti proprietà:
- sort_scores
Restituisce l'elenco dei punteggi assegnati durante l'ordinamento dei risultati di una ricerca da parte dell'API. È inclusa ogni dimensione di ordinamento. I punteggi positivi vengono utilizzati per le selezioni in ordine crescente e quelli negativi per le selezioni in ordine decrescente.
- espressioni
L'elenco dei campi calcolati è il risultato della valutazione dell'espressione. Ad esempio, la seguente espressione di 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)')
ScoredDocument.expression:HtmlField(name='snippet', value='that was a good story to finish')
- cursor
Un cursore associato a un risultato utilizzato come punto di partenza da cui restituire l'insieme successivo di risultati di ricerca. Questa proprietà non viene restituita a meno che non imposti
Index.cursor_typesuIndex.RESULT_CURSOR; in caso contrario, la proprietà restituisceNone.