Classe ScoredDocument
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=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.
- idioma:
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 contendo 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.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-31 UTC.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-31 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eScoredDocument\u003c/code\u003e class represents a scored document returned from a search operation and is not manually constructed but rather received as a result from \u003ccode\u003eIndex.search()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIt includes properties such as \u003ccode\u003edoc_id\u003c/code\u003e, \u003ccode\u003efields\u003c/code\u003e, \u003ccode\u003elanguage\u003c/code\u003e, \u003ccode\u003esort_scores\u003c/code\u003e, \u003ccode\u003eexpressions\u003c/code\u003e, \u003ccode\u003ecursor\u003c/code\u003e, and \u003ccode\u003erank\u003c/code\u003e which provide details about the document and its ranking.\u003c/p\u003e\n"],["\u003cp\u003eThe class allows the retrieval of scores generated during the sorting process (\u003ccode\u003esort_scores\u003c/code\u003e), computed fields from requested expressions (\u003ccode\u003eexpressions\u003c/code\u003e), and a cursor for paginated results (\u003ccode\u003ecursor\u003c/code\u003e) if configured.\u003c/p\u003e\n"],["\u003cp\u003eIf no \u003ccode\u003edoc_id\u003c/code\u003e is specified, one will be assigned by the search service.\u003c/p\u003e\n"],["\u003cp\u003eThe document's \u003ccode\u003erank\u003c/code\u003e property determines the order in which it appears in search results, with a higher \u003ccode\u003erank\u003c/code\u003e meaning the document is returned earlier in the results.\u003c/p\u003e\n"]]],[],null,["# class ScoredDocument\n\nClass `ScoredDocument` represents a scored document returned from a search. You do not build this class explicitly; rather, it is returned as a result of [Index.search()](/appengine/docs/legacy/standard/python/search/indexclass).\n| This API is supported for first-generation runtimes and can be used when [upgrading to corresponding second-generation runtimes](/appengine/docs/standard/\n| python3\n|\n| /services/access). If you are updating to the App Engine Python 3 runtime, refer to the [migration guide](/appengine/migration-center/standard/migrate-to-second-gen/python-differences) to learn about your migration options for legacy bundled services.\n\n`ScoredDocument` is defined in the `google.appengine.api.search` module.\n\nConstructor\n-----------\n\nThe constructor for class `MatchScorer` is defined as follows:\n\n\nclass ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)\n\n:\n\n Represents a scored document returned from a search.\n\n \u003cbr /\u003e\n\n:\n\n Arguments\n\n doc_id\n\n : The visible, printable ASCII string identifying the document. Must not begin with '!'. Whitespace is excluded from ids. If no id is provided, the search service will provide one.\n\n fields\n\n : An iterable of Field instances representing the content of the document.\n\n language\n\n : The two-letter [ISO 639.2 language code](http://www.loc.gov/standards/iso639-2/php/code_list.php) of the language used in the field values.\n\n sort_scores\n\n : The list of scores assigned during sort evaluation. Each sort dimension is included. Positive scores are used for ascending sorts; negative scores for descending.\n\n expressions\n\n : The list of computed fields which are the result of expressions requested.\n\n cursor\n\n : A cursor associated with the document.\n\n rank\n\n : The document rank is used to specify the order this document will be returned in search results, where 0 \\\u003c= rank \\\u003c= sys.maxint. If not specified, the number of seconds since 1st Jan 2011 is used. Documents are returned in descending order of the order ID.\n\n Result value\n\n : A new instance of class `ScoredDocument`.\n\n Exceptions\n\n TypeError\n\n : If any of the parameters have an invalid type, or an unknown attribute is passed.\n\n ValueError\n\n : If any parameter has an invalid value.\n\n \u003cbr /\u003e\n\nProperties\n----------\n\nAn instance of class `ScoredDocument` has the following properties:\n\nsort_scores\n\n: Returns the list of scores assigned while the API is sorting the results of a search. Each sort dimension is included. Positive scores are used for ascending sorts and negative scores for descending.\n\nexpressions\n\n: The list of computed fields the result of expression evaluation. For example, the following [field expression](/appengine/docs/legacy/standard/python/search/fieldexpressionclass) seeks to compute a snippet field containing HTML snippets extracted from the matching of the query `'good story'` in the `content` field:\n\n ```python\n FieldExpression(name='snippet', 'snippet(\"good story\", content)')\n ```\n Given this query, the API would return the following `ScoredDocument.expression`: \n\n ```python\n HtmlField(name='snippet', value='that was a good story to finish')\n ```\n\n \u003cbr /\u003e\n\ncursor\n\n: A cursor associated with a result used as a starting point from which to return the next set of search results. This property will not return unless you set the `Index.cursor_type` to `Index.RESULT_CURSOR`; otherwise the property returns be `None`."]]
