A classe Document

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

Document é definida no módulo google.appengine.api.search.

Constructor

O construtor da classe Document é definido da seguinte forma:

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

Crie uma instância da classe Document.

No exemplo a seguir, mostramos como criar um documento que consiste em um conjunto de campos, alguns em 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, um string ASCII legível que identifica o documento. Não pode conter caracteres de espaço em branco nem iniciar com um ponto de exclamação (!). Se omitido, um string identificador será dado pelo serviço de pesquisa.

Na maioria dos casos, você não precisa especificar o identificador do documento explicitamente. A especificação do próprio identificador é útil, no entanto, para implementar a pesquisa com outros mecanismos de armazenamento, como o Blobstore ou o Armazenamento do Google. No caso do Blobstore, por exemplo, configure o identificador ao BlobKey para associar o documento a um blob específico.

fields

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 na qual o documento será retornado nos resultados da pesquisa. Os documentos mais recentes são retornados primeiro. Se não for especificada, a classificação será definida para o número de segundos desde 1° de janeiro de 2011 às 00:00:00 UTC. Observe que, quando a classificação é usada em uma FieldExpression ou SortExpression, a referência a ela é _rank.

Valor do resultado

Uma nova instância da classe Document.

Exceções

TypeError

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

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, um string ASCII legível que identifica o documento.

fields

Uma lista dos campos do documento.

language

O 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 na qual o documento será retornado nos resultados da pesquisa. Observe que, quando a classificação é usada em uma FieldExpression ou SortExpression, a referência a ela é _rank. Além disso, se você criar uma SortExpression que inclua a classificação como uma das chaves de classificação, só será possível classificar na direção DECRESCENTE.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Ambiente padrão do App Engine para Python 2