A classe Document

A classe Document representa um documento que contém conteúdo pesquisável.

Document está definido no módulo google.appengine.api.search.

Construtor

O construtor da classe Document é definido da seguinte forma:

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

Construa uma instância da classe Document.

O exemplo seguinte mostra como criar um documento composto por um conjunto de campos, algum texto simples e um em 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

O identificador do documento,uma string ASCII legível que identifica o documento. Não pode conter carateres de espaço em branco e não pode começar com um ponto de exclamação (!). Se for omitido, o serviço de pesquisa fornece uma string de identificador.

Na maioria dos casos, não tem de especificar o identificador do documento explicitamente. No entanto, especificar o seu próprio identificador é útil para implementar a pesquisa com outros mecanismos de armazenamento, como o Blobstore ou o Google Storage. No caso do Blobstore, por exemplo, pode definir o identificador do documento como o BlobKey para associar esse documento a um blob específico.

campos

Uma coleção iterável de objetos Field que representam o conteúdo do documento.

language

Um código ISO 693-1 de duas letras para o idioma em que os valores dos campos do documento são expressos.

rank

A classificação do documento,um número inteiro que especifica a ordem em que vai ser devolvido nos resultados da pesquisa. Os documentos mais recentes são devolvidos primeiro. Se não for especificado, a classificação é definida como o número de segundos desde 1 de janeiro de 2011 às 00:00:00 UTC. Tenha em atenção que, quando a classificação é usada numa FieldExpression ou numa SortExpression, é referenciada como _rank.

Valor do resultado

Uma nova instância da classe Document.

Exceções

TypeError

Um parâmetro tem um tipo inválido ou foi transmitido um atributo desconhecido.

ValueError

Um parâmetro tem um valor inválido.

Propriedades

Uma instância da classe Document tem as seguintes propriedades:

doc_id

O identificador do documento, uma string ASCII legível que identifica o documento.

campos

Uma lista dos campos do documento.

language

O código ISO 693-1 de duas letras do idioma em que os valores dos campos do documento são expressos.

rank

A classificação do documento, um número inteiro que especifica a ordem pela qual é devolvido nos resultados da pesquisa. Tenha em atenção que, quando a classificação é usada numa FieldExpression ou numa SortExpression, é referenciada como _rank. Além disso, se criar uma SortExpression que inclua a classificação como uma das chaves de ordenação, a classificação só pode ser ordenada na direção DESCENDING.