FacetOptions クラス

FacetOptions クラスは、クエリのファセット結果を処理するためのオプションを提供します。

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

ファセット情報を収集するために評価する、クエリ結果のドキュメント数。