class ScoredDocument

A classe ScoredDocument representa um documento com pontuação devolvido de uma pesquisa. Não cria esta classe explicitamente. Em vez disso, é devolvida como resultado de Index.search().

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

Construtor

O construtor da classe MatchScorer é definido da seguinte forma:

class ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)

Representa um documento com pontuação devolvido de uma pesquisa.

Argumentos

doc_id

A string ASCII visível e imprimível que identifica o documento. Não pode começar com "!". Os espaços em branco são excluídos dos IDs. Se não for fornecido nenhum ID, o serviço de pesquisa fornece um.

campos

Um iterável de instâncias de Field que representam o conteúdo do documento.

language

O código de idioma ISO 639.2 de duas letras do idioma usado nos valores dos campos.

sort_scores

A lista de classificações atribuídas durante a avaliação da ordenação. Cada dimensão de ordenação está incluída. As pontuações positivas são usadas para ordenações ascendentes e as pontuações negativas para ordenações descendentes.

expressões

A lista de campos calculados que são o resultado das expressões pedidas.

cursor

Um cursor associado ao documento.

rank

A classificação do documento é usada para especificar a ordem em que este documento é devolvido nos resultados da pesquisa, onde 0 <= classificação <= sys.maxint. Se não for especificado, é usado o número de segundos desde 1 de janeiro de 2011. Os documentos são devolvidos por ordem descendente do ID da encomenda.

Valor do resultado

Uma nova instância da classe ScoredDocument.

Exceções

TypeError

Se algum dos parâmetros tiver um tipo inválido ou for transmitido um atributo desconhecido.

ValueError

Se algum parâmetro tiver um valor inválido.

Propriedades

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

sort_scores

Devolve a lista de classificações atribuídas enquanto a API ordena os resultados de uma pesquisa. Cada dimensão de ordenação está incluída. As pontuações positivas são usadas para ordenações ascendentes e as pontuações negativas para ordenações descendentes.

expressões

A lista de campos calculados é o resultado da avaliação da expressão. Por exemplo, a seguinte expressão de campo procura calcular um campo de fragmento que contenha fragmentos de HTML extraídos da correspondência da consulta 'good story' no campo content: 

FieldExpression(name='snippet', 'snippet("good story", content)')
 Tendo em conta esta consulta, a API devolveria o seguinte ScoredDocument.expression: 
HtmlField(name='snippet', value='that was a good story to finish')

cursor

Um cursor associado a um resultado usado como ponto de partida a partir do qual devolver o conjunto seguinte de resultados da pesquisa. Esta propriedade não é devolvida, a menos que defina Index.cursor_type como Index.RESULT_CURSOR. Caso contrário, a propriedade é devolvida como None.