La classe ScoredDocument rappresenta un documento con punteggio restituito da una ricerca. Questa classe non viene creata esplicitamente, 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, expressions=None, cursor=None, rank=None)
Rappresenta un documento con punteggio restituito da una ricerca.
Argomenti
- doc_id
La stringa ASCII stampabile visibile che identifica il documento. Non deve iniziare con "!". Lo spazio vuoto è escluso dagli ID. Se non viene fornito alcun ID, il servizio di ricerca ne fornirà uno.
- campi
Un iterabile di istanze di campo che rappresentano i contenuti del documento.
- lingua
Il codice lingua ISO 639.2 a due lettere della lingua utilizzata nei valori dei campi.
- sort_scores
L'elenco dei punteggi assegnati durante la valutazione dell'ordinamento. È inclusa ogni dimensione di ordinamento. I punteggi positivi vengono utilizzati per gli ordinamenti crescenti, mentre i punteggi negativi per quelli discendenti.
- espressioni
L'elenco dei campi calcolati che sono il risultato delle espressioni richieste.
- cursore
Un cursore associato al documento.
- rank
La classificazione del documento viene utilizzata per specificare l'ordine di restituzione di questo documento nei risultati della ricerca, dove 0 <= ranking <= sys.maxint. Se non specificato, viene utilizzato il numero di secondi a partire dal 1° gennaio 2011. I documenti vengono restituiti in ordine decrescente in base all'ID ordine.
Valore del risultato
Una nuova istanza della classe
ScoredDocument.
Eccezioni
- TypeError
Se uno dei parametri presenta un tipo non valido o se viene trasmesso 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. È inclusa ogni dimensione di ordinamento. I punteggi positivi vengono utilizzati per gli ordinamenti ascendenti e i punteggi negativi per quelli discendenti.
- espressioni
L'elenco dei campi calcolati del risultato della valutazione delle espressioni. 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)')Data questa query, l'API restituisce il seguenteScoredDocument.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 la serie successiva di risultati di ricerca. Questa proprietà non verrà restituita, a meno che non imposti
Index.cursor_typesuIndex.RESULT_CURSOR; in caso contrario, la proprietà restituisceNone.