La classe Document

La classe Document rappresenta un documento contenente contenuti che possono essere cercati.

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

Costruttore

Il costruttore della classe Document è definito come segue:

class Document(doc_id=None, fields=None, language='en', rank=None)

Costruisci un'istanza della classe Document.

L'esempio seguente mostra come creare un documento composto da un insieme di campi, del testo normale e di un campo in HTML:

from google.appengine.api import search

search.Document(
    doc_id='documentId',
    fields=[search.TextField(name='subject', value='going for dinner'),
            search.HtmlField(name='body', value='<html>I found a place.</html>'),
            search.TextField(name='signature', value='brzydka pogoda', language='pl')],
    language='en')

Argomenti

doc_id

L'identificatore del documento,una stringa ASCII leggibile che identifica il documento. Non deve contenere spazi e non deve iniziare con un punto esclamativo (!). Se omesso, il servizio di ricerca fornirà una stringa di identificatore.

Nella maggior parte dei casi, non è necessario specificare esplicitamente l'identificatore del documento. Tuttavia, la specifica del tuo identificatore è utile per implementare la ricerca con altri meccanismi di archiviazione, come Blobstore o Google Storage. Ad esempio, nel caso di Blobstore, puoi impostare l'identificatore del documento su BlobKey per associarlo a un blob specifico.

fields

Una raccolta iterabile di oggetti Field che rappresentano i contenuti del documento.

language

Un codice ISO 693-1 di due lettere per la lingua in cui sono espressi i valori dei campi del documento.

rank

Il ranking del documento,un numero intero che specifica l'ordine in cui verrà restituito nei risultati di ricerca. I documenti più recenti vengono restituiti per primi. Se non specificato, il ranking verrà impostato sul numero di secondi dal 1° gennaio 2011 00:00:00 UTC. Tieni presente che quando il ranking viene utilizzato in un'espressione di campo o di ordinamento, viene fatto riferimento a _rank.

Valore del risultato

Una nuova istanza della classe Document.

Eccezioni

TypeError

Un parametro ha un tipo non valido o è stato passato un attributo sconosciuto.

ValueError

Un parametro ha un valore non valido.

Proprietà

Un'istanza della classe Document ha le seguenti proprietà:

doc_id

L'identificatore del documento, una stringa ASCII leggibile che identifica il documento.

fields

Un elenco dei campi del documento.

language

Il codice ISO 693-1 di due lettere per la lingua in cui sono espressi i valori dei campi del documento.

rank

Il ranking del documento, un numero intero che specifica l'ordine in cui verrà restituito nei risultati di ricerca. Tieni presente che quando il ranking viene utilizzato in un'espressione di campo o di ordinamento, viene fatto riferimento a _rank. Inoltre, se crei un'espressione di ordinamento che include il ranking come una delle chiavi di ordinamento, il ranking può essere ordinato solo in direzione DESCENDENTE.