FacetRefinement
类可根据构面值缩小搜索结果范围。
建议您使用构面优化的令牌字符串。每个 FacetResult 都对应一个替代此类的可接受的令牌。要提供手动 FacetRefinement,可将此类的实例传递给 SearchOptions。
FacetRefinement
在模块 google.appengine.api.search
中定义。
构造函数
FacetRefinement
类的构造函数定义如下:
class FacetRefinement(name, value=None, facet_range=None)
构造类
FacetRefinement
的实例。注意:应设置 value 或 facet_range,但不可同时设置两者。
参数
- name
设置 name 属性
- value
设置 value 属性
- facet_range
设置 facet_range 属性
结果值
FacetRefinement
类的新实例。
异常
- TypeError
任意参数的类型无效或者传递了未知属性时返回此错误。
- ValueError
任意参数的赋值无效时返回此错误。
属性
FacetRefinement
类的实例具有以下属性:
- name
构面优化的名称。
- value
构面优化的字符串值。
- range
构面优化的数值范围。
实例方法
FacetRefinement
类的实例具有以下方法:
- ToTokenString()
将优化转换为可安全用于 HTML 的令牌字符串。此字符串的格式可能会发生变化。
-
结果值
可以安全地在 HTML 中用于此分面优化的令牌字符串。
- FromTokenString()
此静态方法可以将令牌字符串转换为 FacetRefinement 对象。切勿在不同版本的 API 之间存储令牌字符串,因为密钥可能不兼容。
-
参数
- token_string
使用 ToTokenString 方法创建或通过搜索结果返回的令牌字符串。
结果值
FacetRefinement 对象。
异常
- ValueError
token_string 无效时返回此错误。