ScoredDocument クラスは、検索から返されるスコア ドキュメントを表します。このクラスは明示的には作成しません。Index.search() の結果として返されます。
ScoredDocument は、google.appengine.api.search モジュールで定義されます。
コンストラクタ
MatchScorer クラスのコンストラクタは、次のように定義されます。
- class ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)
検索から返されるスコア ドキュメントを表します。
引数
- doc_id
表示された印刷可能な ASCII 文字列で、ドキュメントを識別します。先頭に「！」を指定しないでください。ホワイトスペースは ID から除外されます。ID を指定しない場合、検索サービスにより提供されます。
- fields
ドキュメントのコンテンツを表す、反復可能な Field インスタンス。
- language
フィールドの値で使用される言語を表す、2 文字の ISO 639.2 言語コード。
- sort_scores
並べ替えの評価で割り当てられるスコアのリスト。並べ替えの各次元が含まれます。プラスのスコアは昇順の並べ替えに使用され、マイナスのスコアは降順の並べ替えに使用されます。
- expressions
要求された式の結果である計算済みフィールドのリスト。
- cursor
ドキュメントに関連付けられたカーソル。
- rank
ドキュメントのランクは、0 <= rank <= sys.maxint の場合に検索結果でドキュメントが返される順序を指定するのに使用します。指定しない場合、2011 年 1 月 1 日以降経過した秒数が使用されます。ドキュメントは 順序 ID の降順で返されます。
結果値
ScoredDocumentクラスの新しいインスタンス。
例外
- TypeError
いずれかのパラメータが無効なタイプであるか、不明な属性が渡されました。
- ValueError
いずれかのパラメータの値が無効です。
プロパティ
ScoredDocument クラスのインスタンスには次のプロパティがあります。
- sort_scores
API が検索の結果を並べ替える際に割り当てられるスコアのリストを返します。並べ替えの各次元が含まれます。プラスのスコアは昇順の並べ替えに使用され、マイナスのスコアは降順の並べ替えに使用されます。
- expressions
式の評価の結果である計算済みフィールドのリスト。たとえば、次のフィールド式は、
contentフィールドの'good story'というクエリに一致する結果から抽出された HTML スニペットを含むスニペット フィールドを計算します。FieldExpression(name='snippet', 'snippet("good story", content)')
ScoredDocument.expressionを返します。HtmlField(name='snippet', value='that was a good story to finish')
- cursor
次の検索結果セットを返す際の開始点として使用される結果に関連付けられたカーソル。このプロパティは、
Index.cursor_typeをIndex.RESULT_CURSORに設定しない限り値を返しません。それ以外の場合は、プロパティはNoneを返します。