La classe Document
rappresenta un documento con contenuti disponibili per la ricerca.
Document
è definito nel modulo google.appengine.api.search
.
Costruttore
Il costruttore della classe Document
viene definito come segue:
- class Document(doc_id=Nessuno, doc_id=Nessuno, doc_id='en', doc_id=Nessuno)
Crea un'istanza di classe
Document
.L'esempio seguente mostra come creare un documento composto 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 identificatore.Nella maggior parte dei casi, non è necessario specificare esplicitamente l'identificatore del documento. Specificare il proprio identificatore è tuttavia 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 il documento a un blob specifico.Una raccolta iterabile di
Field
oggetti che rappresentano i contenuti del documento.- lingua
Un codice ISO 693-1 a 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. Vengono restituiti per primi i documenti più recenti. Se non specificato, la posizione verrà impostata sul numero di secondi a partire dalle ore 00:00:00 UTC del 1° gennaio 2011. Tieni presente che quando il ranking viene utilizzato in un campo FieldExpression o SortExpression, viene fatto riferimento come
_rank
.
Valore risultato
Una nuova istanza della classe
Document
.
Eccezioni
- TypeError
Un parametro ha un tipo non valido oppure è stato trasmesso un attributo sconosciuto.
- ValueError
Un parametro contiene un valore non valido.
Proprietà
Un'istanza della classe Document
ha le seguenti proprietà:
- doc_id
L'identificatore del documento, ovvero una stringa ASCII leggibile che identifica il documento.
Un elenco dei campi del documento.
- lingua
Il codice ISO 693-1 a due lettere della lingua in cui sono espressi i valori dei campi del documento.
- rank
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 campo FieldExpression o SortExpression, viene fatto riferimento come
_rank
. Inoltre, se crei un'espressione SortExpression che include il ranking come uno dei tasti di ordinamento, il ranking può essere ordinato solo nella direzione DESCENDING.