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.

Modulo google.appengine.api.search.search

Riepilogo

Un'API Python Search utilizzata dagli sviluppatori di app.

Contiene i metodi utilizzati per interagire con l'API Search. Contiene classi API che inoltrano ad apiproxy.

Contenuti

class google.appengine.api.search.search.AtomField(name, value=None, language=None)source

Basi: google.appengine.api.search.search.Field

Un campo con contenuti da trattare come un singolo token per l'indicizzazione.

L'esempio seguente mostra un campo atom denominato Collaboratore:: AtomField(name='collabora', value='foo@bar.com')

class google.appengine.api.search.search.AtomFacet(name, value=None)source

Basi: google.appengine.api.search.search.Facet

Un facet con contenuti che devono essere considerati un singolo token per l'indicizzazione.

L'esempio seguente mostra un facet atomico chiamato wine_type:: AtomFacet(name='wine_type', value='Red')

exception google.appengine.api.search.search.ConcurrentTransactionErrororigine

Basi: google.appengine.api.search.search.Error

Indica una chiamata all'API di ricerca non riuscita a causa di aggiornamenti simultanei.

class google.appengine.api.search.search.Cursor(web_safe_string=None, per_result=False)source

Basi: oggetto

Specifica come ricevere la pagina successiva dei risultati in una ricerca.

Un cursore restituito in un insieme precedente di risultati di ricerca da utilizzare come punto di partenza per recuperare l'insieme successivo di risultati. In questo modo potete migliorare le prestazioni e migliorare la coerenza dell'impaginazione tramite gli aggiornamenti dell'indice.

Di seguito viene mostrato come utilizzare il cursore per visualizzare la pagina di risultati successiva:

# restituisce il primo insieme di risultati; il primo cursore viene utilizzato per specificare # che devono essere restituiti nei risultati della Ricerca. results = index.search(Query(string_string='alcune cose'),

QueryOptions(cursor=Cursor()))

# ottieni il prossimo insieme di risultati risultati = index.search(Query(string_string='alcune cose',

QueryOptions(cursor=result.cursor))).

Se vuoi continuare la ricerca da uno dei ScoredDocs in SearchResults, puoi impostare Cursor.per_result su True.

QueryOptions(cursor=Cursor(per_result=True)))

# questo mostra come accedere ai cursori per_document restituiti da una ricerca per_document_cursor = Nessuno per Scored_document nei risultati:

per_document_cursor = punteggio_documento.cursor

# ottieni il prossimo insieme di risultati risultati = index.search(Query(string_string='alcune cose',

QueryOptions(cursor=per_document_cursor))).

per_result: Restituisce se restituire un cursore per ogni ScoredDocument nei risultati.

stringa_sicuro_web: Restituisce la stringa cursore generata dal servizio di ricerca.

class google.appengine.api.search.search.DateField(name, value=None)source

Basi: google.appengine.api.search.search.Field

Un campo con un valore di data o data e ora.

È possibile utilizzare solo valori di data o data e ora Python (non "aware").

L'esempio seguente mostra un campo data denominato create_date:: DateField(name='creation_date', value=timestamp.date(2011, 03, 11))

exception google.appengine.api.search.search.DeleteError(message, results)origine

Basi: google.appengine.api.search.search.Error

Indica un errore durante l'eliminazione di uno degli oggetti richiesti.

risultati: Restituisce l'elenco DeleteResult corrispondente ai documenti eliminati.

class google.appengine.api.search.search.DeleteResult(code, message=None, id=None)source

Basi: google.appengine.api.search.search.OperationResult

Il risultato dell'eliminazione di un singolo documento.

class google.appengine.api.search.search.Document(doc_id=None, field=None, languageproxy='en', ranking=None, facets=None)source

Basi: oggetto

Rappresenta un documento generato dall'utente.

L'esempio seguente mostra come creare un documento composto da un insieme di campi, alcuni in testo normale e altri in HTML.

Document(doc_id='document_id',

campi=[TestoCampo(nome='oggetto', valore='vai a cena'),

Campo HTML(nome='corpo',: value=’<html>Ho trovato un luogo.</html>’),
TextField(name=’signature’, value=’brzydka pogoda’,: language='pl')],

facets=[AtomFacet(name='tag', value='food'),

NumberFacet(nome='priorità', valore=5.0)],

language='en')

ID_documento: Restituisce l'identificatore del documento.

field(field_name) source

Restituisce il campo con il nome del campo fornito.

Parametri

field_name - Il nome del campo da restituire.

Restituisce

Un campo con il nome indicato.

Aumenta

ValueError: non esiste un solo campo con il nome specificato.

fields: Restituisce un elenco di campi del documento.

lingua: Restituisce il codice della lingua in cui sono scritti i campi del documento.

ranking: Restituisce il ranking del documento.

exception google.appengine.api.search.search.Errorsource

Basi: eccezioni.Eccezione

Indica che la chiamata all'API di ricerca non è riuscita.

exception google.appengine.api.search.search.ExpressionErrorsource

Basi: google.appengine.api.search.search.Error

Si è verificato un errore durante l'analisi di una stringa di input dell'espressione.

class google.appengine.api.search.search.FacetOptions(*args, **kwds)source

Basi: oggetto

Opzioni per l'elaborazione dei risultati facet di una query.

profondità: Restituisce il numero di documenti da analizzare per il rilevamento facet.

rilevamento_limite: Restituisce il numero di facet da scoprire.

Discovery_value_limit: Restituisce il numero di valori da scoprire per ogni facet.

class google.appengine.api.search.search.FacetRange(*args, **kwds)source

Basi: oggetto

Un intervallo di facet con i valori di inizio e fine.

Un esempio di FacetRange per una buona valutazione è: FacetRange(start=3.0, end=3.5)

end: Restituisce la fine esclusiva dell'intervallo.

avvia: Restituisce l'inizio inclusivo dell'intervallo.

class google.appengine.api.search.search.FacetPerfezionament(*args, **kwds)source

Basi: oggetto

Un perfezionamento perfezionamento per facet per filtrare i risultati di ricerca in base al valore del facet.

NOTA: il modo consigliato per utilizzare il perfezionamento dei facet è utilizzare la stringa del token. Ogni facetResult avrà un token accettabile al posto di questa classe. Per fornire il perfezionamento dei facet manuale, un'istanza di questa classe può essere trasmessa a SearchOptions. NOTA: è necessario impostare un valore o un facet_range, ma non entrambi. Esempio: richiesta di perfezionamento di un intervallo per un facet numerico:

FacetPerfezionamento(name='rating', facet_range=FacetRange(start=1.0,end=2.5))

statica FromTokenString(token_string)origine

Converte una stringa token in un oggetto FacetPerfezionamento.

Non archiviare stringhe di token tra versioni diverse dell'API poiché la chiave potrebbe non essere compatibile.

Parametri

token_string – Una stringa token creata dal metodo ToTokenString o restituita
un risultato di ricerca. (di) –

Restituisce

Un oggetto FacetPerfezionamento.

Aumenta

ValueError: se il token_string non è valido.

Origine ToTokenString()

Converte questo perfezionamento in una stringa di token sicura per l'uso in HTML.

Il formato di questa stringa può cambiare.

Restituisce

Una stringa di token sicura per l'utilizzo in HTML per questo perfezionamento dei facet.

name: Restituisce il nome del perfezionamento facet.

valore: Restituisce il valore del perfezionamento facet.

class google.appengine.api.search.search.FacetRequest(*args, **kwds)source

Basi: oggetto

Un facet da includere nel risultato di ricerca.

Esempio di richiesta di facet solo con nome:: FacetRequest("ExpediteShipping")

(in tal caso, i risultati avranno sempre questo facet) oppure con un vincolo di valore:

FacetRequest("Size"), valori=["XL", "L", "M"]

(i risultati avranno questo facet solo con valori specificati) o intervalli:

FacetRequest("Rating"), intervalli=[: FacetRange(1.0, 2.0), FacetRange(2.0, 3.5), FacetRange(3.5, 4.0)]

(i risultati avranno questo facet con intervalli specificati)

name: Restituisce il nome del facet.

intervalli: Restituisce FacetRanges di valori da includere nel risultato.

valore_limite: Restituisce il numero di valori da includere nel risultato.

valori: Restituisce valori specifici da includere nel risultato.

class google.appengine.api.search.search.FacetResult(nome, valori=Nessuno)source

Basi: oggetto

Rappresenta un risultato facet restituito da una ricerca con ricerca facet.

name: Restituisce il nome di questo risultato facet.

valori: Restituisce i valori per questo risultato facet.

class google.appengine.api.search.search.FacetResultValue(etichetta, conteggio, perfezionamento)source

Basi: oggetto

Un valore facet come parte del risultato di ricerca.

conteggio: Restituisce il conteggio per questo valore facet.

etichetta: Restituisce l'etichetta per questo valore facet.

token_perfezionamento: Restituisce la stringa del token di perfezionamento per questo valore facet.

class google.appengine.api.search.search.Field(name, value, language=None)source

Basi: oggetto

Una classe base astratta che rappresenta un campo di un documento.

L'istanza di questa classe non deve essere creata direttamente.

ATOM = 'ATOM'

DATA = 'DATA'

GEO_POINT = 'GEO_POINT'

HTML = 'HTML'

NUMERO = 'NUMBER'

TESTO = 'TESTO'

TOKENIZED_PREFIX = 'TOKENIZED_PREFIX'

UNTOKENIZED_PREFIX = 'UNTOKENIZED_PREFIX'

VECTOR = 'VECTOR'

lingua: Restituisce il codice della lingua in cui sono scritti i contenuti in valore.

name: Restituisce il nome del campo.

valore: Restituisce il valore del campo.

class google.appengine.api.search.search.FieldExpression(nome, espressione)source

Basi: oggetto

Rappresenta un'espressione che verrà calcolata per ogni risultato restituito.

Ad esempio,

FieldExpression(name='content_snippet',: espressioni='snippet("molto importante", contenuto)')

significa che per ogni risultato di ricerca verrà restituito un campo calcolato "content_snippet", che contiene snippet HTML del campo "content" che corrispondono alla query "molto importante".

MAXIMUM_expressION_LENGTH = 1000

MAXIMUM_OPERATOR_LENGTH = 100

espressione: Restituisce una stringa contenente un'espressione restituita nei risultati di ricerca.

name: Restituisce il nome dell'espressione da restituire nei risultati di ricerca.

class google.appengine.api.search.search.HTMLField(name, value=None, language=None)source

Basi: google.appengine.api.search.search.Field

Un campo con contenuti HTML.

L'esempio seguente mostra un campo HTML denominato content:: HtmlField(name='content', value='<html>herbata, kawa</html>', language='pl')

class google.appengine.api.search.search.GeoField(name, value=None)source

Basi: google.appengine.api.search.search.Field

Un campo con un valore GeoPoint.

L'esempio seguente mostra un campo geografico con il nome di un luogo:

GeoField(name=’place’, value=GeoPoint(latitudine=-33.84, longitudine=151.26))

classgoogle.appengine.api.search.search.GeoPoint(latitudine, longitudine)Fonte

Basi: oggetto

Rappresenta un punto sulla superficie terrestre, in latitudine e longitudine.

latitude: Restituisce l'angolo tra il piano equatoriale e la linea che attraversa il punto geografico.

longitude: Restituisce l'angolo da un meridiano di riferimento a un altro meridiano.

google.appengine.api.search.search.get_indexes(*args, **kwds)fonte

Restituisce un elenco di indici disponibili.

Parametri

Spazio dei nomi - Lo spazio dei nomi di indici da restituire. Se non viene impostato, viene utilizzato lo spazio dei nomi corrente.
offset: l'offset del primo indice restituito.
limite - Il numero di indici da restituire.
start_index_name - Il nome del primo indice da restituire.
include_start_index - Indica se restituire o meno l'indice iniziale.
index_name_prefix - Il prefisso utilizzato per selezionare gli indici restituiti.
fetch_schema - Indica se recuperare o meno lo schema per ciascun indice.

Kwarg:: scadenza: scadenza per la chiamata RPC in secondi; se nessuna utilizza il valore predefinito.

Restituisce

GetResponse contenente un elenco di indici disponibili.

Aumenta

InternalError: se la richiesta non va a buon fine sui server interni.
TypeError: se uno dei parametri ha tipi non validi o viene trasmesso un attributo sconosciuto.
ValueError: se uno qualsiasi dei parametri ha valori non validi (ad es. una scadenza negativa).

google.appengine.api.search.search.get_indexes_async(*args, **kwds)fonte

Restituisce in modo asincrono un elenco di indici disponibili.

Identico a get_indexes(), tranne per il fatto che restituisce un futuro. Richiama get_result() sul valore restituito per bloccare la chiamata e ottenere il risultato.

class google.appengine.api.search.search.GetResponse(results=None)source

Basi: oggetto

Rappresenta il risultato dell'esecuzione di una richiesta get.

Ad esempio, il seguente codice mostra come utilizzare una risposta per determinare quali documenti sono stati rimossi o meno.

risposta = index.get_range() per il documento in risposta:

stampa "documento", documento

risultati: Restituisce un elenco di risultati ordinati per ID dall'indice.

class google.appengine.api.search.search.Index(name, namespace=None, source='SEARCH')source

Basi: oggetto

Rappresenta un indice che consente l'indicizzazione, l'eliminazione e la ricerca di documenti.

Il seguente frammento di codice mostra come aggiungere documenti, quindi cerca nell'indice i documenti che corrispondono a una query.

# Recupera l'indice. indice = Indice(nome='nome-indice')

# Crea un documento. doc = Document(doc_id='document-id',

campi=[TextField(name=’subject’, value=’my first email’),

Campo HTML(nome='corpo',: value=’<html>alcuni contenuti qui</html>’)])

# Indicizza il documento. prova:

index.put(doc)

ad eccezione di ricerca.Errore, e:: # possibile nuovo tentativo di indicizzazione o errore del log

# Esegui una query sull'indice. prova:

results = index.search("subject:primo corpo:qui")

# Utilizza i risultati di ricerca per ripetere l'iterazione. per Scored_document nei risultati:

stampa punteggio_documento

ad eccezione di ricerca.Errore, e:: # eventualmente registra l'errore

Dopo aver creato un indice con una specifica specifica, questa specifica è immutabile.

I risultati di ricerca potrebbero contenere documenti obsoleti. Tuttavia, le due modifiche a qualsiasi documento archiviato in un indice vengono applicate nell'ordine corretto.

CLOUD_STORAGE = 'CLOUD_STORAGE'

DATASTORE = 'DATASTORE'

RESPONSE_CURSOR = 'RESPONSE_CURSOR'

RESULTS_CURSOR = 'RESULTS_CURSOR'

CERCA = 'CERCA'

delete(*args, **kwds)fonte

Elimina dall'indice i documenti con gli ID corrispondenti.

Se non esiste alcun documento per l'identificatore nell'elenco, tale identificatore viene ignorato.

Parametri

document_ids - Un singolo identificatore o elenco di identificatori di documenti da eliminare.

Kwarg:: scadenza: scadenza per la chiamata RPC in secondi; se nessuna utilizza il valore predefinito.

Risalto

DeleteError: se la rimozione di uno o più documenti non è riuscita o il numero rimosso non corrisponde a quello richiesto.
ValueError: se document_ids non è una stringa o iterabile di identificatori di documento validi o il numero di ID di documenti è maggiore di MAXIMUM_DOCUMENTS_PER_PUT_REQUEST o la scadenza è un numero negativo.

delete_async(*args, **kwds)origine

Elimina in modo asincrono i documenti con gli ID documento corrispondenti.

Identico a delete(), tranne per il fatto che restituisce un futuro. Richiama get_result() sul valore restituito per bloccare la chiamata e ottenere il risultato.

delete_schema() sorgente

Ritirato nella versione 1.7.4. Elimina lo schema dall'indice.

Stiamo ritirando questo metodo e sostituendolo con una gestione più generale di schemi e indici.

Un possibile utilizzo può essere la rimozione di campi digitati che non sono più utilizzati. Dopo aver eliminato lo schema, devi indicizzare uno o più documenti per ricrearlo. Fino a quando non avrai indicizzato nuovamente alcuni documenti, le ricerche potrebbero non riuscire, in particolare quelle che utilizzano limitazioni dei campi.

Aumenta

DeleteError: se non è stato possibile eliminare lo schema.

get(*args, **kwds)fonte

Recupera un documento in base all'ID.

Parametri

doc_id – L'ID del documento da recuperare.

Kwarg:: scadenza: scadenza per la chiamata RPC in secondi; se nessuna utilizza il valore predefinito.

Restituisce

Se l'ID documento esiste, restituisce il documento associato. In caso contrario, restituisce None.

Aumenta

TypeError: se uno dei parametri ha tipi non validi o viene trasmesso un attributo sconosciuto.
ValueError: se uno qualsiasi dei parametri ha valori non validi (ad es. una scadenza negativa).

get_async(*args, **kwds)origine

Recuperare in modo asincrono un documento in base all'ID.

Identico a get() eccetto che restituisce un futuro. Richiama get_result() sul valore restituito per bloccare la chiamata e ottenere il risultato.

get_range(*args, **kwds)origine

Visualizza un intervallo di documenti nell'indice, in ordine ID.

Parametri

start_id - Stringa contenente l'ID da cui elencare i documenti. Per impostazione predefinita, inizia dal primo ID.
include_start_object – Se true, includi il documento con l'ID specificato dal parametro start_id.
limite: il numero massimo di documenti da restituire.
ids_only: se true, i documenti restituiti contengono solo le loro chiavi.

Kwarg:: scadenza: scadenza per la chiamata RPC in secondi; se nessuna utilizza il valore predefinito.

Restituisce

GetResponse contenente un elenco di documenti, ordinati per ID.

Aumenta

Errore: viene generata una sottoclasse di errore se si è verificato un errore durante l'elaborazione della richiesta.
TypeError: se uno dei parametri ha tipi non validi o viene trasmesso un attributo sconosciuto.
ValueError: se uno qualsiasi dei parametri ha valori non validi (ad es. una scadenza negativa).

get_range_async(*args, **kwds)origine

Visualizza in modo asincrono un intervallo di documenti nell'indice, in ordine ID.

Identico a get_range(), ma che restituisce un futuro. Richiama get_result() sul valore restituito per bloccare la chiamata e ottenere il risultato.

name: Restituisce il nome dell'indice.

spazio dei nomi: Restituisce lo spazio dei nomi del nome dell'indice.

put(*args, **kwds)fonte

Indicizzare la raccolta di documenti.

Se uno dei documenti è già nell'indice, reindicizzali con il documento aggiornato corrispondente.

Parametri

documenti: un documento o iterabile di documenti da indicizzare.

Kwarg:: scadenza: scadenza per la chiamata RPC in secondi; se nessuna utilizza il valore predefinito.

Restituisce

Un elenco di PutResult, uno per documento di cui è stata richiesta l'indicizzazione.

Aumenta

PutError: se l'indicizzazione di uno o più documenti non è riuscita o il numero indicizzato non corrispondeva.
TypeError: se viene trasmesso un attributo sconosciuto.
ValueError: se il documento non è un documento o iterabile di Documento o il numero di documenti è maggiore di MAXIMUM_DOCUMENTS_PER_PUT_REQUEST o la scadenza è un numero negativo.

put_async(*args, **kwds)origine

indicizza in modo asincrono la raccolta di documenti.

Identico a Put(), tranne per il fatto che restituisce un futuro. Richiama get_result() sul valore restituito per bloccare la chiamata e ottenere il risultato.

schema

Restituisce i nomi dei campi della mappatura dello schema all'elenco dei tipi supportati.

Valido solo per gli indici restituiti dal metodo search.get_indexes.

search(*args, **kwds)fonte

Cerca nell'indice i documenti che corrispondono alla query.

Ad esempio, il seguente frammento di codice richiede una ricerca di documenti in cui il "primo" si trova nell'oggetto e un "buono" si verifica ovunque, restituendo al massimo 20 documenti, avviando la ricerca dal "token del tracker", restituendo un altro cursore per la risposta, ordinando per soggetto in ordine decrescente, restituendo i campi autore, oggetto e riepilogo e un contenuto del campo con snippet.

results = index.search(

query=Query('subject:first good',

options=QueryOptions(limit=20,

cursor=Cursor(), ordina_options=OrdinaOptions(

espressioni=[OrdinaExpression(expression=’subject’)], limit=1000),

return_fields=['author', 'subject', 'summary'], snippeted_fields=['content']))

Il seguente frammento di codice mostra come utilizzare un cursore dei risultati

cursor = results.cursor per i risultati dei risultati:

# risultato del processo

results = index.search(: Query("subject:first good', options=QueryOptions(cursor=cursor)))

Il seguente frammento di codice mostra come utilizzare un cursore per_result

results = index.search(

query=Query('subject:first good',

options=QueryOptions(limit=20,: cursor=Cursor(per_result=True), ...)))

cursore = Nessuno per risultati nei risultati:

cursore = risultante.cursor

results = index.search(: Query("subject:first good', options=QueryOptions(cursor=cursor)))

Per ulteriori informazioni sulla sintassi delle query, visita la pagina http://developers.google.com/appengine/docs/python/search/query_strings.

Parametri

query – La query da confrontare con i documenti nell'indice.

Kwarg:: scadenza: scadenza per la chiamata RPC in secondi; se nessuna utilizza il valore predefinito.

Restituisce

Risultati di ricerca contenenti un elenco di documenti corrispondenti, un numero restituito e un numero restituito dalla query.

Aumenta

TypeError: se uno dei parametri ha tipi non validi o viene trasmesso un attributo sconosciuto.
ValueError: se uno qualsiasi dei parametri ha valori non validi (ad es. una scadenza negativa).

search_async(*args, **kwds)origine

Cerca in modo asincrono nell'indice i documenti che corrispondono alla query.

Identico a search(), tranne per il fatto che restituisce un futuro. Richiama get_result() sul valore restituito per bloccare la chiamata e ottenere il risultato.

origine

Restituisce la sorgente dell'indice.

Ritirato: dalla versione 1.7.6, l'origine non è più disponibile.

spazio_di_archiviazione

Lo spazio di archiviazione massimo consentito per questo indice, in byte.

Restituisce Nessuno per gli indici non ottenuti da search.get_indexes.

spazio_di_archiviazione

Il numero approssimativo di byte utilizzati da questo indice.

Il numero potrebbe essere leggermente inattivo, in quanto potrebbe non riflettere i risultati delle modifiche recenti.

Restituisce Nessuno per gli indici non ottenuti da search.get_indexes.

exception google.appengine.api.search.search.InternalErrorsource

Basi: google.appengine.api.search.search.Error

Indica che una chiamata nell'API di ricerca non è riuscita nel backend interno.

exception google.appengine.api.search.search.InvalidRequestsource

Basi: google.appengine.api.search.search.Error

Indica che il client ha effettuato una richiesta non valida sull'API di ricerca.

classgoogle.appengine.api.search.search.MatchScorerfonte

Basi: oggetto

Assegna un punteggio del documento in base alla frequenza di termine.

Se aggiungi un MatchScorer a OrderOptions come nel seguente codice:

sort_opts = search.OrdinaOptions(match_scorer=search.MatchScorer())

in questo modo i documenti verranno ordinati in ordine di punteggio decrescente. I punteggi saranno positivi. Se vuoi ordinare in ordine crescente, utilizza il seguente codice:

sort_opts = search.OrdinaOptions(match_scorer=search.MatchScorer(),

espressioni=[search.OrdinaExpression(: Expression='_score',Direction=search.OrdinaExpression.ASCending, default_value=0.0)])

In questo caso, i punteggi saranno negativi.

class google.appengine.api.search.search.NumberField(name, value=None)source

Basi: google.appengine.api.search.search.Field

Un campo con un valore numerico.

L'esempio seguente mostra un campo numerico denominato size:: NumberField(name='size', value=10)

class google.appengine.api.search.search.NumberFacet(nome, valore=Nessuno)source

Basi: google.appengine.api.search.search.Facet

Un facet con valore numerico.

L'esempio seguente mostra un numero facet denominato wine_vintage:: NumberFacet(nome='vino_vintage', valore=2000)

class google.appengine.api.search.search.OperationResult(code, message=None, id=None)source

Basi: oggetto

Rappresenta il risultato di singole operazioni di un indice batch o di una rimozione.

Questa è una classe astratta.

CONCURRENT_TRANSACTION = 'CONCURRENT_TRANSACTION'

INTERNAL_ERROR = 'INTERNAL_ERROR'

INVALID_REQUEST = 'INVALID_REQUEST'

OK = 'OK'

TIMEOUT = 'TIMEOUT'

TRANSIENT_ERROR = 'TRANSIENT_ERROR'

programmazione: Restituisce il codice che indica lo stato dell'operazione.

id: Restituisce l'ID dell'oggetto su cui è stata eseguita l'operazione.

messaggio: Restituisce un messaggio di errore associato se l'operazione è stata eseguita per errore.

exception google.appengine.api.search.search.PutError(message, results)origine

Basi: google.appengine.api.search.search.Error

Indica un errore durante l'indicizzazione di uno degli oggetti richiesti.

risultati: Restituisce un elenco PutResult corrispondente agli oggetti indicizzati.

class google.appengine.api.search.search.PutResult(code, message=None, id=None)source

Basi: google.appengine.api.search.search.OperationResult

Il risultato dell'indicizzazione di un singolo oggetto.

class google.appengine.api.search.search.Query(*args, **kwds)source

Basi: oggetto

Rappresenta una richiesta sul servizio di ricerca per eseguire una query sull'indice.

abilitare_facet_discovery: Restituisce true se la disoccupazione facet è attiva.

opzioni: Restituisce QueryOptions che definisce la post-elaborazione sui risultati di ricerca.

stringa_query: Restituisce la stringa di query da applicare al servizio di ricerca.

restituzione_facet: Restituisce l'elenco di facet specifici da includere nel risultato.

exception google.appengine.api.search.search.QueryErrorsource

Basi: google.appengine.api.search.search.Error

Si è verificato un errore durante l'analisi di una stringa di input di query.

class google.appengine.api.search.search.QueryOptions(limit=20, number_found_accuracy=None, cursor=None, offset=None, ordina_options=None, return_fields=None, ids_only=False, snippeted_fields=Nessuno, return_expressions=Nessuno)source

Basi: oggetto

Opzioni per i risultati post-elaborazione di una query.

Le opzioni includono la possibilità di ordinare i risultati, controllare quali campi del documento restituire, produrre snippet di campi e calcolare ed ordinare i dati in base a espressioni di punteggio complesse.

Se vuoi accedere in modo casuale alle pagine dei risultati di ricerca, puoi utilizzare un offset:

# ottieni il primo insieme di risultati page_size = 10 risultati = index.search(Query(stringa_query='alcune cose'),

QueryOptions(limit=page_size))

Numero di pagine di calcolo pagine = results.find_count / page_size

# utente sceglie una pagina, quindi un offset nei risultati pagina_successiva = ith * page_size

# ottieni i risultati di ricerca per quella pagina = risultati indice.search(Query(stringa_query='alcune cose'),

QueryOptions(limit=page_size, offset=next_page))

cursore: Restituisce il cursore per la query.

solo_id: Indica se restituire solo ID documento nei risultati di ricerca.

limite: Restituisce un limite al numero di documenti da restituire nei risultati.

precisione_numero_trovata: Restituisce il requisito minimo di accuratezza per SearchResults.number_found.

offset: Restituisce il numero di documenti nei risultati di ricerca che vuoi saltare.

espressioni_restituite: Restituisce iterable di FieldExpression per restituire un risultato.

campi_restituiti: Restituisce un insieme di nomi di campi da restituire nei risultati di ricerca.

campi_snippet: Restituisce gli iterabili dei nomi dei campi nello snippet e restituisce i risultati.

ordina_opzioni: Restituisce una OrderOptions.

classgoogle.appengine.api.search.search.RescoringMatchScorersource

Basi: google.appengine.api.search.search.MatchScorer

Assegna un punteggio del documento in base alla frequenza del termine ponderata in base alle parti del documento.

Se aggiungi un RescoringMatchScorer a OrderOptions come nel seguente codice:

sort_opts = search.OrdinaOptions(match_scorer=search.RescoringMatchScorer())

in questo modo i documenti verranno ordinati in ordine di punteggio decrescente. I punteggi saranno positivi. Se vuoi ordinare in ordine crescente, utilizza il seguente codice:

sort_opts = search.OrdinaOptions(match_scorer=search.RescoringMatchScorer(),

espressioni=[search.OrdinaExpression(: Expression='_score',Direction=search.OrdinaExpression.ASCending, default_value=0.0)])

In questo caso, i punteggi saranno negativi.

class google.appengine.api.search.search.ScoredDocument(doc_id=None, Fields=None, language='en', ordina_scores=None, espressioni=Nessuno, cursore=Nessuno, ranking=Nessuno, facets=Nessuno)source

Basi: google.appengine.api.search.search.Document

Rappresenta un documento con punteggio che è stato restituito da una ricerca.

cursore

Un cursore associato a un risultato, un punto di partenza della ricerca continua.

Per visualizzare questo cursore, imposta Index.cursor_type su Index.Risultato_CURSOR, altrimenti sarà Nessuno.

Restituisce

Il cursore dei risultati.

espressioni

L'elenco dei campi calcolati il risultato della valutazione delle espressioni.

Ad esempio, se una richiesta ha: FieldExpression(name='snippet', 'snippet("good Story", content)')

il che significa calcolare un campo snippet contenente snippet HTML estratti dalla corrispondenza della query "buona storia" nel campo "contenuti". Ciò significa che nelle espressioni per il risultato di ricerca verrà restituito un campo come il seguente:

HtmlField(name='snippet', value='what a <b>good Story</b> to complete')

Restituisce

I campi calcolati.

ordina_punteggi

Ritirato: l'elenco dei punteggi assegnati durante la valutazione dell'ordinamento.

Il modo giusto per recuperare un punteggio è utilizzare "_score" in una FieldExpression.

Restituisce

L'elenco dei punteggi dell'ordinamento numerico.

class google.appengine.api.search.search.SearchResults(number_found, results=None, cursor=None, facets=None)source

Basi: oggetto

Rappresenta il risultato dell'esecuzione di una richiesta di ricerca.

cursore

Restituisce un cursore che può essere utilizzato per continuare la ricerca dall'ultimo risultato.

Corrisponde a utilizzare unCursore in QueryOptions, altrimenti sarà Nessuno.

Restituisce

Il cursore dei risultati.

numero_trovato

Restituisce il numero di documenti che sono stati trovati per la ricerca.

Tieni presente che questo valore è approssimativo e non è un conteggio esatto. Se, ad esempio, il parametro QueryOptions.number_found_accuracy è impostato su 100, il valore di numero_find_accuracy è uguale a 100.

Restituisce

Il numero di documenti trovati.

risultati: Restituisce l'elenco di ScoredDocs che corrispondono alla query.

class google.appengine.api.search.search.OrdinaExpression(espressione, orientamento='DESCFENDI', valore_predefinito=Nessuno)origine

Basi: oggetto

Ordina in base a un'espressione di punteggio specificata dall'utente.

Ad esempio, quanto segue ordina i documenti in un campo numerico denominato "length" in ordine crescente, assegnando un valore predefinito di sys.maxint per i documenti che non specificano un campo "length".

OrdinaExpression(expression='length',: Direzione=sort.OrdinaExpression.ASCending, default_value=sys.maxint)

L'esempio seguente ordina i documenti in un campo data denominato "published_date" in ordine decrescente, assegnando un valore predefinito di 1999-12-31 per i documenti che non specificano un campo "published_date".

OrdinaExpression(expression='published_date',: default_value=timestamp.date(year=1999, month=12, day=31)

Il seguente esempio ordina i documenti in un campo di testo denominato "subject" in ordine decrescente, assegnando un valore predefinito "" per i documenti che non specificano un campo "subject".

OrdinaExpression(expression='subject')

ASCending = 'ASCending'

DESCRIZIONE = 'DESCRIZIONE'

175

MIN_FIELD_VALUE = u''

valore_predefinito: Restituisce un valore predefinito per l'espressione, se non viene calcolato alcun valore.

direction: Restituisce la direzione per ordinare l'espressione: ASCending o DESCending.

espressione: Restituisce l'espressione in base alla quale ordinare.

class google.appengine.api.search.search.OrdinaOptions(expressions=None, match_scorer=None, limit=1000)source

Basi: oggetto

Rappresenta un tipo di documenti multidimensionale.

Il seguente codice mostra come ordinare i documenti in base alla valutazione del prodotto in ordine decrescente e quindi il prodotto più economico all'interno di prodotti con valutazioni simili, ordinando al massimo 1000 documenti:

OrdinaOptions(espressioni=[

OrdinaExpression(expression='rating',: Direzione=OrdinaExpression.DESCFlessibile, valore_predefinito=0),
OrdinaExpression(expression='price + tasse',: Direzione=OrdinaExpression.ASCBOUND, default_value=999999.99)],

limite=1000)

espressioni: Un elenco di OrderExpression che specifica un ordinamento multidimensionale.

limite: Restituisce il limite per il numero di documenti da valutare o ordinare.

match_scorer: Restituisce un matcher con cui assegnare un punteggio ai documenti.

class google.appengine.api.search.search.TextField(name, value=None, language=None)source

Basi: google.appengine.api.search.search.Field

Un campo con contenuti di testo.

L'esempio seguente mostra un campo di testo denominato firma con contenuti in polacco:: TextField(name=’signature’, value=’brzydka pogoda’, language=’pl’)

exception google.appengine.api.search.search.Timeoutsource

Basi: google.appengine.api.search.search.Error

Indica che una chiamata sull'API di ricerca non è stata completata prima della sua scadenza.

class google.appengine.api.search.search.TokenizedPrefixField(name, value=None, language=None)source

Basi: google.appengine.api.search.search.Field

Un campo che corrisponde alle ricerche sui prefissi dei suoi singoli termini.

L'esempio seguente mostra un campo prefisso prefisso denominato title:: TokenizedPrefixField(name='title', value='Goodwill Hunting')

exception google.appengine.api.search.search.TransientErrorsource

Basi: google.appengine.api.search.search.Error

Indica che la chiamata all'API di ricerca non è riuscita, ma il nuovo tentativo potrebbe non riuscire.

class google.appengine.api.search.search.UntokenizedPrefixField(name, value=None, language=None)source

Basi: google.appengine.api.search.search.Field

Un campo che corrisponde alle ricerche sui prefissi dell'intero campo.

L'esempio seguente mostra un campo prefisso senza token denominato title:: UntokenizedPrefixField(name=’title’, valore=’come nuotare freestyle’)

class google.appengine.api.search.search.VectorField(name, value=None)source

Basi: google.appengine.api.search.search.Field

Un campo vettoriale che può essere utilizzato in un'espressione di prodotto con punto.

L'esempio seguente mostra un campo vettoriale denominato punteggi:: VectorField(name='scores', valore=[1, 2, 3])
Per un'espressione di campo/ordinamento come la seguente:: punto(punteggi, vettore(3, 2, 1))