La clase Document representa un documento que contiene contenido que se puede buscar.
Document se define en el módulo google.appengine.api.search.
Constructor
El constructor de la clase Document se define de la siguiente manera:
- class Document(doc_id=None, fields=None, language='en', rank=None)
Crea una instancia de la clase
Document.En el siguiente ejemplo se muestra cómo crear un documento que consta de un conjunto de campos, texto sin formato y texto en 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')
Argumentos
- doc_id
El identificador del documento,una cadena ASCII legible que identifica el documento. No debe contener caracteres de espacio y no debe empezar por un signo de exclamación (
!). Si se omite, el servicio de búsqueda proporcionará una cadena de identificador.En la mayoría de los casos, no es necesario que especifique el identificador del documento de forma explícita. Sin embargo, especificar tu propio identificador es útil para implementar la búsqueda con otros mecanismos de almacenamiento, como Blobstore o Google Storage. En el caso de Blobstore, por ejemplo, puedes asignar el identificador de documento a
BlobKeypara asociar ese documento a un blob específico.- campos
Una colección iterable de objetos
Fieldque representa el contenido del documento.- language
Código ISO 693-1 de dos letras del idioma en el que se expresan los valores de los campos del documento.
- rank
El rango del documento,un número entero que especifica el orden en el que se devolverá en los resultados de búsqueda. Los documentos más recientes se devuelven primero. Si no se especifica, la clasificación se establecerá en el número de segundos transcurridos desde el 1 de enero del 2011 a las 00:00:00 UTC. Ten en cuenta que, cuando se usa el rango en un FieldExpression o un SortExpression, se hace referencia a él como
_rank.
Valor de resultado
Una nueva instancia de la clase
Document.
Excepciones
- TypeError
Un parámetro tiene un tipo no válido o se ha enviado un atributo desconocido.
- ValueError
Un parámetro tiene un valor no válido.
Propiedades
Una instancia de la clase Document tiene las siguientes propiedades:
- doc_id
Identificador del documento, una cadena ASCII legible que identifica el documento.
- campos
Lista de los campos del documento.
- language
Código de dos letras ISO 693-1 del idioma en el que se expresan los valores de los campos del documento.
- rank
La clasificación del documento, un número entero que especifica el orden en el que se devolverá en los resultados de búsqueda. Ten en cuenta que, cuando se usa el rango en un FieldExpression o un SortExpression, se hace referencia a él como
_rank. Además, si crea un SortExpression que incluya el rango como una de las claves de ordenación, el rango solo se puede ordenar de forma DESCENDENTE.