SearchResults クラス

SearchResults クラスは、Index.search() を使用して検索リクエストを実行した結果を表します。

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

コンストラクタ

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

class SearchResults(number_found, results=None, cursor=None)

検索サービスに対してインデックスのクエリを要求し、該当のクエリについてパラメータを指定します。

引数

number_found

クエリについて見つかったドキュメントの数。

results

検索要求の実行により返された ScoredDocument オブジェクトのリスト。

cursor

現在の検索結果の最後から検索を続行できるようにする Cursor オブジェクト。

結果値

Index.search() を実行した結果を表す SearchRequest クラスの新しいインスタンス。

例外

TypeError

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

ValueError

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

プロパティ

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

results

クエリに一致する ScoredDocument オブジェクトのリストを返します。

number_found

クエリに一致するドキュメントの概数を返します。検索結果の後処理を定義する QueryOptions。たとえば、QueryOptions.number_found_accuracy パラメータを 100 に設定すると、number_found が 100 以下の場合には正確となります。

cursor
このフィールドに値を入力するには、検索の QueryOptions にカーソルを渡す必要があります。それ以外の場合は、None になります。最終結果から検索を続行する際に使用できる結果カーソルを返します。現在の結果の後に結果がない場合は、None を返します。