Nota: Python 2.7 ha raggiunto la fine del supporto il 31 gennaio 2024. Le applicazioni Python 2.7 esistenti continueranno a essere eseguite e a ricevere traffico. Tuttavia, App Engine potrebbe bloccare il ri deployment di applicazioni che utilizzano runtime dopo la data di fine del supporto. Ti consigliamo di eseguire la migrazione all'ultima versione supportata di Python.

classe ScoredDocument

La classe ScoredDocument rappresenta un documento a cui è stato assegnato un punteggio restituito da una ricerca. Non viene creata esplicitamente questa classe, ma viene restituita come risultato di Index.search().

ScoredDocument è definito nel modulo google.appengine.api.search.

Costruttore

Il costruttore della classe MatchScorer viene 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 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.
: Un'istanza iterabile delle istanze Field che rappresentano il contenuto 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 l'ordinamento crescente, i punteggi negativi per l'ordinamento decrescente.
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 in cui verrà restituito il documento 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 in base all'ID ordine.

Valore risultato

Una nuova istanza della classe ScoredDocument.

Eccezioni

TypeError: Se uno o più parametri sono di tipo non valido o se viene trasmesso un attributo sconosciuto.
ValueError: Se uno o più parametri presentano 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 l'ordinamento crescente e i punteggi negativi per l'ordinamento decrescente.

espressioni

L'elenco di campi calcolati derivanti dalla 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 campo content:

FieldExpression(name='snippet', 'snippet("good story", content)')

Data questa query, l'API restituirebbe il seguente 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 non imposti Index.cursor_type su Index.RESULT_CURSOR. In caso contrario, la proprietà restituisce None.