ScoredDocument
类表示从搜索返回的评分文档。此类并非由您明确构建,而是作为 Index.search()
的结果返回。
ScoredDocument
在模块 google.appengine.api.search
中定义。
构造函数
MatchScorer
类的构造函数定义如下:
- class ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)
表示从搜索返回的评分文档。
参数
- doc_id
可见、可打印的 ASCII 字符串,用于标识文档。不能以“!”开头。ID 中不能包含空格。如果未提供 ID,则搜索服务将提供一个。
- fields
可迭代的 Field 实例,表示文档的内容。
- language
字段值中使用的语言的双字母 ISO 639.2 语言代码。
- sort_scores
排序评估期间分配的评分列表。该列表还包含每个排序维度。其中,正分用于升序排序,负分用于降序排序。
- expressions
已计算字段列表,这些字段是请求的表达式的计算结果。
- cursor
与文档关联的游标。
- rank
文档的排名,用于指定此文档将在搜索结果中返回的顺序,其中 0 <= rank <= sys.maxint。如果未指定,则使用自 2011 年 1 月 1 日以来的秒数排名。即文档按订单 ID 的降序返回。
结果值
ScoredDocument
类的新实例。
异常
- TypeError
当任意参数具有无效类型,或者传递了未知属性时,返回该错误。
- ValueError
当任意参数具有无效值时,返回该错误。
属性
ScoredDocument
类的实例具有以下属性:
- sort_scores
API 在对搜索结果进行排序时,返回分配的评分列表。该列表还包含每个排序维度。其中,正分用于升序排序,负分用于降序排序。
- expressions
计算字段的列表,这些字段是表达式的计算结果。例如,以下字段表达式旨在计算一个片段字段,其中包含从
content
字段内'good story'
查询的匹配内容中提取的 HTML 片段: 执行此查询后,API 将返回以下FieldExpression(name='snippet', 'snippet("good story", content)')
ScoredDocument.expression
:HtmlField(name='snippet', value='that was a good story to finish')
- cursor
与结果相关联的游标,用作返回下一组搜索结果的起点。除非将
Index.cursor_type
设置为Index.RESULT_CURSOR
,否则不会返回此属性;或者属性会返回为None
。