La classe ScoredDocument rappresenta un documento con punteggio restituito da una ricerca. Non crei questa classe in modo esplicito, ma 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='en', sort_scores=None, expressions=None, cursor=None, rank=None)
Rappresenta un documento con un punteggio restituito da una ricerca.
Argomenti
- doc_id
La stringa ASCII stampabile e visibile 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.
- campi
Un iterabile di istanze Field che rappresentano i contenuti del documento.
- lingua
Il codice lingua ISO 639.2 di due lettere della lingua utilizzata nei valori dei campi.
- sort_scores
L'elenco dei punteggi assegnati durante la valutazione dell'ordinamento. Ogni dimensione di ordinamento è inclusa. I punteggi positivi vengono utilizzati per gli ordinamenti crescenti, mentre quelli negativi per gli ordinamenti decrescenti.
- espressioni
L'elenco dei campi calcolati che sono il risultato delle espressioni richieste.
- cursore
Un cursore associato al documento.
- rank
Il rango del documento viene utilizzato per specificare l'ordine in cui questo documento verrà restituito nei risultati di ricerca, dove 0 <= rango <= sys.maxint. Se non specificato, viene utilizzato il numero di secondi dal 1° gennaio 2011. I documenti vengono restituiti in ordine decrescente di 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 mentre l'API ordina i risultati di una ricerca. Ogni dimensione di ordinamento è inclusa. I punteggi positivi vengono utilizzati per gli ordinamenti crescenti e quelli negativi per gli ordinamenti decrescenti.
- 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')
- cursore
Un cursore associato a un risultato utilizzato come punto di partenza da cui restituire il successivo insieme di risultati di ricerca. Questa proprietà non verrà restituita a meno che tu non imposti
Index.cursor_typesuIndex.RESULT_CURSOR; in caso contrario, la proprietà restituiràNone.