Gestione dei risultati di ricerca

Quando una chiamata di query viene completata normalmente, restituisce il risultato come oggetto SearchResults. L'oggetto risultati indica quanti documenti corrispondenti sono stati trovati nell'indice e quanti documenti corrispondenti sono stati restituiti. Include inoltre un elenco di ScoredDocuments corrispondenti. L'elenco di solito contiene una parte di tutti i documenti corrispondenti trovati, poiché la ricerca restituisce un numero limitato di documenti ogni volta che viene chiamata. Utilizzando un offset o un cursore, puoi recuperare tutti i documenti corrispondenti, un sottoinsieme alla volta.

Questa API è supportata per runtime di prima generazione e può essere utilizzata quando eseguire l'upgrade ai runtime di seconda generazione corrispondenti. Se esegui l'aggiornamento ad App Engine in Python 3, consulta la guida alla migrazione per scoprire di più sulle opzioni di migrazione per i servizi in bundle legacy.

Risultati

def query_results(index, query_string):
    result = index.search(query_string)
    total_matches = result.number_found
    list_of_docs = result.results
    number_of_docs_returned = len(list_of_docs)
    return total_matches, list_of_docs, number_of_docs_returned

A seconda del valore dell'opzione di query limit, il numero di documenti corrispondenti restituiti nel risultato potrebbe essere inferiore al numero trovato. Ricorda che il numero trovato sarà una stima se l'accuratezza del numero trovato è inferiore al numero trovato. Indipendentemente da come configuri le opzioni di ricerca, una chiamata a search() non troverà più di 10.000 documenti corrispondenti.

Se sono stati trovati più documenti che restituiti e vuoi recuperarli tutti, devi ripetere la ricerca utilizzando un offset o un cursore, come spiegato di seguito.

Nota: il codice chiamante deve essere preparato per gestire le eccezioni che potrebbero essere generate se la query non è valida o si sono verificati problemi durante l'elaborazione.

Documenti con punteggio

I risultati di ricerca includeranno un elenco di ScoredDocuments corrispondenti alla query. Puoi eseguire l'iterazione sull'elenco per elaborare ogni documento in sequenza:

for scored_document in results:
        print(scored_document)

Per impostazione predefinita, un documento con punteggio contiene tutti i campi del documento originale indicizzato. Se le opzioni di query hanno specificato returned_fields, nella proprietà fields del documento vengono visualizzati solo questi campi. Se hai creato campi calcolati specificando returned_expressions o snippeted_fields, questi verranno visualizzati distintamente nella proprietà expressions del documento.

Utilizzo degli offset

Se la ricerca trova più documenti di quelli che puoi restituire contemporaneamente, utilizza un offset per indicizzare nell'elenco dei documenti corrispondenti. Ad esempio, il limite di query predefinito è 20 documenti. Dopo aver eseguito la prima ricerca (con offset 0) e recuperato i primi 20 documenti, recupera i successivi 20 documenti impostando l'offset su 20 ed eseguendo di nuovo la stessa ricerca. Continua a ripetere la ricerca, incrementando ogni volta l'offset del numero di documenti restituiti:

def query_offset(index, query_string):
    offset = 0

    while True:
        # Build the query using the current offset.
        options = search.QueryOptions(offset=offset)
        query = search.Query(query_string=query_string, options=options)

        # Get the results
        results = index.search(query)

        number_retrieved = len(results.results)
        if number_retrieved == 0:
            break

        # Add the number of documents found to the offset, so that the next
        # iteration will grab the next page of documents.
        offset += number_retrieved

        # Process the matched documents
        for document in results:
            print(document)

Gli offset possono essere inefficienti quando si esegue l'iterazione su un set di risultati molto grande.

Uso dei cursori

Puoi anche utilizzare i cursori per recuperare un sottointervallo di risultati. I cursori sono utili quando intendi presentare i risultati di ricerca in pagine consecutive e vuoi assicurarti di non saltare alcun documento nel caso in cui un indice possa essere modificato tra una query e l'altra. I cursori sono inoltre più efficienti quando esegui l'iterazione in un set di risultati molto grande.

Per utilizzare i cursori, devi creare un cursore iniziale e includerlo nelle opzioni di query. Esistono due tipi di cursori: per query e per risultato. Un cursore per query fa sì che un cursore separato venga associato all'oggetto risultati restituito dalla chiamata di ricerca. Un cursore per risultato consente di associare un cursore a ogni documento con punteggio nei risultati.

Utilizzo di un cursore per query

Per impostazione predefinita, un cursore appena creato è un cursore di query. Questo cursore contiene la posizione dell'ultimo documento restituito nei risultati di ricerca. Viene aggiornato a ogni ricerca. Per enumerare tutti i documenti corrispondenti in un indice, esegui la stessa ricerca finché il risultato non restituisce un cursore nullo:

def query_cursor(index, query_string):
    cursor = search.Cursor()

    while cursor:
        # Build the query using the cursor.
        options = search.QueryOptions(cursor=cursor)
        query = search.Query(query_string=query_string, options=options)

        # Get the results and the next cursor
        results = index.search(query)
        cursor = results.cursor

        for document in results:
            print(document)

Utilizzo di un cursore per risultato

Per creare cursori per risultato, devi impostare la proprietà cursore per_result su true quando crei il cursore iniziale. Quando la ricerca restituisce risultati, a ogni documento viene associato un cursore. Puoi utilizzare il cursore per specificare una nuova ricerca con risultati che iniziano con un documento specifico. Tieni presente che quando passi un cursore per risultato alla ricerca, non ci sarà alcun cursore di query associato al risultato stesso. result.getCursor() restituirà un valore nullo, quindi non puoi utilizzarlo per verificare se hai recuperato tutte le corrispondenze.

def query_per_document_cursor(index, query_string):
    cursor = search.Cursor(per_result=True)

    # Build the query using the cursor.
    options = search.QueryOptions(cursor=cursor)
    query = search.Query(query_string=query_string, options=options)

    # Get the results.
    results = index.search(query)

    document_cursor = None
    for document in results:
        # discover some document of interest and grab its cursor, for this
        # sample we'll just use the first document.
        document_cursor = document.cursor
        break

    # Start the next search from the document of interest.
    if document_cursor is None:
        return

    options = search.QueryOptions(cursor=document_cursor)
    query = search.Query(query_string=query_string, options=options)
    results = index.search(query)

    for document in results:
        print(document)

Salvare e ripristinare i cursori

Un cursore può essere serializzato come stringa sicura per il web, salvato e poi ripristinato per un uso successivo:

def saving_and_restoring_cursor(cursor):
    # Convert the cursor to a web-safe string.
    cursor_string = cursor.web_safe_string
    # Restore the cursor from a web-safe string.
    cursor = search.Cursor(web_safe_string=cursor_string)