Python 2 ya no es compatible con la comunidad. Recomendamos que migres las apps de Python 2 a Python 3.

La clase Document

La clase Document representa un documento con contenido que se puede buscar.

Document se define en el módulo google.appengine.api.search.

Constructor

El constructor para la clase Document se define de la manera siguiente:

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

Construye una instancia de la clase Document.

En el siguiente ejemplo, se muestra cómo crear un documento que consiste en un conjunto de campos, algunos de texto sin formato y uno en formato 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 de documento, una string ASCII en formato legible que identifica el documento. No debe contener caracteres de espacio en blanco y no debe comenzar con un signo de exclamación (!). Si se omite, el servicio de búsqueda proporcionará una string de identificador.

En la mayoría de los casos, no necesitas especificar el identificador de documento de manera explícita. No obstante, especificar tu propio identificador resulta útil para implementar la búsqueda con otros mecanismos de almacenamiento, como Blobstore o Google Storage. En el caso de Blobstore, por ejemplo, puedes establecer el identificador de documento en la BlobKey a fin de asociar ese documento con un BLOB específico.

fields

Una colección iterable de objetos Field que representa el contenido del documento.

language

Un código ISO 693-1 de dos letras para el lenguaje en el que se expresan los valores de campo del documento.

rank

La clasificación de un documento, un número entero que especifica el orden en el que se mostrará en los resultados de la búsqueda. Los documentos más nuevos se muestran primero. Si no se especifica, la clasificación se establecerá en el número de segundos desde el 1 de enero de 2011 a las 00:00:00 UTC. Ten en cuenta que, cuando se usa la clasificación en las clases FieldExpression o SortExpression, se hace referencia a ella como _rank.

Result value

Una instancia nueva de la clase Document.

Excepciones

TypeError

Un parámetro tiene un tipo no válido, o se pasó 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

El identificador de documento, una string ASCII en formato legible que identifica el documento.

fields

La lista de los campos del documento.

language

El código ISO 693-1 de dos letras para el lenguaje en el que se expresan los valores de campo del documento.

rank

La clasificación de un documento, un número entero que especifica el orden en el que se mostrará en los resultados de la búsqueda. Ten en cuenta que, cuando se usa la clasificación en las clases FieldExpression o SortExpression, se hace referencia a ella como _rank. Además, si creas una clase SortExpression que incluye la clasificación como una de las claves de orden, la clasificación solo se puede ordenar en dirección DESCENDENTE.