Observação: o Python 2.7 chegou ao fim do suporte em 31 de janeiro de 2024. Os aplicativos Python 2.7 atuais continuarão a ser executados e a receber tráfego. No entanto, o App Engine pode bloquear a reimplantação de aplicativos que usam ambientes de execução após o término da data de suporte. Recomendamos que você migre para a versão compatível mais recente do Python.

Classe ScoredDocument

A classe ScoredDocument representa um documento classificado retornado de uma pesquisa. Você não cria essa classe explicitamente. Em vez disso, ela é retornada como resultado de Index.search().

ScoredDocument é definido no módulo google.appengine.api.search.

Construtor

O construtor da classe MatchScorer é definido da seguinte maneira:

class ScoredDocument(doc_id=None, doc_id=None, doc_id='en', doc_id=None, doc_id=None, doc_id=None, doc_id=None)

Representa um documento classificado retornado de uma pesquisa.

Argumentos

doc_id: A string ASCII visível e para impressão que identifica o documento. Não pode começar com "!". O espaço em branco é excluído dos IDs. Se nenhum código for fornecido, o serviço de pesquisa fornecerá um.
fields: Um iterável de instâncias de Field que representa o conteúdo do documento.
language: O código de idioma ISO 639.2 de duas letras do idioma usado nos valores de campo.
sort_scores: A lista de pontuações atribuídas durante a avaliação da classificação. Toda dimensão de classificação está incluída. As pontuações positivas são usadas em classificações crescentes e as pontuações negativas em decrescentes.
expressions: A lista de campos computados que são o resultado de expressões solicitadas.
cursor: Um cursor associado ao documento.
rank: A classificação do documento é usada para especificar a ordem em que este documento será retornado nos resultados da pesquisa, em que 0 <= rank <= sys.maxint. Se não for especificado, o número de segundos desde 1º de janeiro de 2011 será usado. Os documentos são retornados em ordem decrescente do código da ordem.

Valor do resultado

Uma nova instância da classe ScoredDocument.

Exceções

TypeError: Se algum dos parâmetros tiver um tipo inválido ou um atributo desconhecido for passado.
ValueError: Se algum parâmetro tiver um valor inválido.

Propriedades

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

sort_scores

Retorna a lista de pontuações atribuídas, e a API está classificando os resultados de uma pesquisa. Toda dimensão de classificação está incluída. As pontuações positivas são usadas em classificações crescentes e as pontuações negativas em decrescentes.

expressions

A lista de campos computados do resultado da avaliação de expressão. Por exemplo, a expressão de campo a seguir procura calcular um campo de snippet que contém snippets HTML extraídos da correspondência da consulta 'good story' no campo content:

FieldExpression(name='snippet', 'snippet("good story", content)')

Dada essa consulta, a API retornaria o seguinte ScoredDocument.expression:

HtmlField(name='snippet', value='that was a good story to finish')

cursor

Um cursor associado a um resultado usado como um ponto de partida em que o próximo conjunto de resultados da pesquisa precisa ser retornado. Esta propriedade não retornará, a menos que você defina Index.cursor_type como Index.RESULT_CURSOR. Caso contrário, a propriedade retornará None.