La classe Document
rappresenta un documento che include contenuti disponibili per la ricerca.
Document
è definito nel modulo google.appengine.api.search
.
Costruttore
Il costruttore per la classe Document
è definito come segue:
- class Document(doc_id=None, fields=None, language='en', rank=None)
Crea un'istanza della classe
Document
.L'esempio seguente mostra come creare un documento costituito da un insieme di campi, alcuni in testo normale e uno 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 vuoti 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, specificare il tuo identificatore è utile per implementare la ricerca con altri meccanismi di archiviazione, come Blobstore o Google Storage. Nel caso di Blobstore, ad esempio, puoi impostare l'identificatore del documento su
BlobKey
per associare quel documento a un blob specifico.- campi
Una raccolta iterabile di oggetti
Field
che rappresentano i contenuti del documento.- lingua
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 rango verrà impostato sul numero di secondi a partire dal 1° gennaio 2011 alle ore 00:00:00 UTC. Tieni presente che quando il rango viene utilizzato in FieldExpression o SortExpression, viene indicato come
_rank
.
Valore del risultato
Una nuova istanza della classe
Document
.
Eccezioni
- TypeError
Il tipo di parametro non è valido oppure è stato trasmesso 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.
- campi
Un elenco dei campi del documento.
- lingua
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 della ricerca. Tieni presente che quando il rango viene utilizzato in FieldExpression o SortExpression, viene indicato come
_rank
. Inoltre, se crei un tipo di espressione che include il ranking come una delle chiavi di ordinamento, il rango può essere ordinato solo in verso il basso.