SortOptions クラス

SortExpression クラスは、ドキュメントの多次元の並べ替えを表します。

次のコードは、ドキュメントを製品の評価の降順に並べ替えます。評価が同等の製品は、価格が低い順に並べ替えます。最大で 1,000 個のドキュメントを並べ替えます。

     SortOptions(expressions=[
         SortExpression(expression='rating',
             direction=SortExpression.DESCENDING, default_value=0),
         SortExpression(expression='price + tax',
             direction=SortExpression.ASCENDING, default_value=999999.99)],
         limit=1000)

SortOptions は、google.appengine.api.search モジュールで定義されます。

コンストラクタ

SortOptions クラスのコンストラクタは、次のように定義されます。

class SortOptions(expressions=None, match_scorer=None, limit=1000)

指定したオプションに従ってドキュメントを並べ替えます。

引数

expressions

ドキュメントの多次元の並べ替えを表す SortExpression の反復可能オブジェクト。

match_scorer

マッチ スコアラーの仕様。ドキュメントのスコアの計算で使用されるか、または SortExpression とその他の機能を組み合わせて使用されます。

limit

スコアを計算するドキュメント数の上限。インデックスが大量に存在する場合はこの制限を設定することをおすすめします。

結果値

SortOptions クラスの新しいインスタンス。

例外

TypeError

いずれかのパラメータが無効なタイプであるか、不明な属性が渡されました。

ValueError

いずれかのパラメータの値が無効です。

プロパティ

SortOptions クラスのインスタンスには次のプロパティがあります。

expressions

多次元の並べ替えを指定する SortExpression のリストを返します。

match_scorer

ドキュメントのスコアの計算に使用するマッチ スコアラーを返します。

limit

スコアを計算するドキュメント数の上限を返します。