FacetOptions 类

FacetOptions 类提供了用于处理查询的构面结果的选项。

注意:**我们不再建议采用这种解决方案。**使用此 API 的应用只能在 Python 2 运行时环境中运行,并且必须先升级到[建议的解决方案] (/appengine/docs/standard/python/migrate-to-python3/migrating-services#migration_paths_for_bundled_services),然后才能迁移到 Python 3 运行时。

FacetOptions 在模块 google.appengine.api.search 中定义。

简介

FacetOptions 类提供了用于处理查询的构面结果的选项。具体选项包括要发现的构面数、每个构面的值数量以及要纳入构面计算考虑范围的结果深度。

构造函数

FacetOptions 类的构造函数定义如下:

facet_option = FacetOptions(discovery_limit=5, discovery_value_limit=None, depth=None)

指定用于处理查询的构面结果的选项。

参数

discovery_limit
discovery_value_limit
depth

结果值

FacetOptions 类的新实例。

异常

TypeError

如果传递了未知属性。

ValueError

如果任何参数具有无效值(例如,负深度)。

属性

FacetOptions 类的实例具有以下属性:

discovery_limit

启用构面发现时要发现的构面数。如果为 None,则会停用构面发现。

discovery_value_limit

要为每个最常发现的构面发现的值数量。

depth

查询结果中要评估以收集构面信息的文档数。